browser.input.ime

الوصف

استخدِم واجهة برمجة التطبيقات chrome.input.ime لتنفيذ أداة IME مخصّصة لنظام التشغيل ChromeOS. يتيح ذلك لإضافتك معالجة ضغطات المفاتيح وضبط التركيب وإدارة نافذة المرشحين.

الأذونات

input

يجب الإفصاح عن إذن "الإدخال" في بيان الإضافة لاستخدام واجهة برمجة التطبيقات input.ime. على سبيل المثال:

{
  "name": "My extension",
  ...
  "permissions": [
    "input"
  ],
  ...
}

مدى التوفّر

نظام التشغيل ChromeOS فقط

أمثلة

ينشئ الرمز التالي أداة IME تحوّل الأحرف المكتوبة إلى أحرف كبيرة.

var context_id = -1;

browser.input.ime.onFocus.addListener(function(context) {
  context_id = context.contextID;
});

browser.input.ime.onKeyEvent.addListener(
  function(engineID, keyData) {
    if (keyData.type == "keydown" && keyData.key.match(/^[a-z]$/)) {
      browser.input.ime.commitText({"contextID": context_id,
                                    "text": keyData.key.toUpperCase()});
      return true;
    } else {
      return false;
    }
  }
);

الأنواع

AssistiveWindowButton

الإصدار 85 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

رقم تعريف الأزرار في نافذة المساعدة

Enum

"undo"

"addToDictionary"

AssistiveWindowProperties

الإصدار 85 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

خصائص نافذة المساعدة

الخصائص

  • announceString

    string اختياري

    سلاسل ليعلن عنها ChromeVox

  • النوع

    "undo"

  • مرئي

    قيمة منطقية

    يتم ضبط القيمة على "صحيح" لعرض AssistiveWindow، وعلى "خطأ" لإخفائها.

AssistiveWindowType

الإصدار 85 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

نوع النافذة المساعدة

القيمة

"undo"

AutoCapitalizeType

الإصدار 69 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

نوع الكتابة التلقائية بأحرف كبيرة في حقل النص

Enum

"characters"

"words"

"sentences"

InputContext

يصف سياق الإدخال

الخصائص

  • autoCapitalize
    الإصدار 69 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    نوع الكتابة التلقائية بأحرف كبيرة في حقل النص

  • autoComplete

    قيمة منطقية

    ما إذا كان حقل النص يتطلب الإكمال التلقائي

  • autoCorrect

    قيمة منطقية

    ما إذا كان حقل النص يتطلب التصحيح التلقائي

  • contextID

    الرقم

    يُستخدَم هذا الخيار لتحديد أهداف عمليات الحقول النصية. يصبح رقم التعريف هذا غير صالح فور استدعاء onBlur.

  • shouldDoLearning

    قيمة منطقية

    الإصدار 68 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    ما إذا كان يجب استخدام النص الذي تم إدخاله في حقل النص لتحسين اقتراحات الكتابة للمستخدم.

  • spellCheck

    قيمة منطقية

    ما إذا كان حقل النص يتطلب التدقيق الإملائي

  • النوع

    نوع القيمة التي يعدّلها حقل النص هذا (نص أو رقم أو عنوان URL أو غير ذلك)

InputContextType

الإصدار 44 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

نوع القيمة التي يعدّلها حقل النص هذا (نص أو رقم أو عنوان URL أو غير ذلك)

Enum

"text"

"search"

"tel"

"url"

"email"

"number"

"password"

"null"

KeyboardEvent

يُرجى الاطّلاع على http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent

الخصائص

  • altKey

    قيمة منطقية اختيارية

    ما إذا تم الضغط على مفتاح ALT أم لا

  • altgrKey

    قيمة منطقية اختيارية

    الإصدار 79 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    يشير إلى ما إذا تم الضغط على مفتاح ALTGR أم لا.

  • capsLock

    قيمة منطقية اختيارية

    ما إذا كان CAPS_LOCK مفعَّلاً أم لا

  • رمز

    سلسلة

    قيمة المفتاح الفعلي الذي يتم الضغط عليه لا تتأثر القيمة بتخطيط لوحة المفاتيح الحالي أو حالة مفتاح التعديل.

  • ctrlKey

    قيمة منطقية اختيارية

    ما إذا تم الضغط على مفتاح CTRL أم لا

  • extensionId

    string اختياري

    معرّف الإضافة الخاص بمُرسِل حدث المفتاح هذا

  • مفتاح

    سلسلة

    قيمة المفتاح الذي يتم الضغط عليه

  • keyCode

    number اختيارية

    رمز keyCode في HTML الذي تم إيقافه نهائيًا، وهو رمز رقمي يعتمد على النظام والتنفيذ ويشير إلى المعرّف غير المعدَّل المرتبط بالمفتاح الذي تم الضغط عليه.

  • requestId

    string اختياري

    (متوقف نهائيًا) معرّف الطلب استخدِم المَعلمة requestId من الحدث onKeyEvent بدلاً من ذلك.

  • shiftKey

    قيمة منطقية اختيارية

    ما إذا تم الضغط على مفتاح SHIFT أم لا

  • النوع

    إما keyup أو keydown

KeyboardEventType

الإصدار 44 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

Enum

"keyup"

"keydown"

MenuItem

عنصر قائمة تستخدمه طريقة الإدخال للتفاعل مع المستخدم من قائمة اللغة

الخصائص

  • تم وضع علامة في المربّع

    قيمة منطقية اختيارية

    يشير هذا إلى أنّه يجب رسم هذا العنصر بعلامة اختيار.

  • مفعّلة

    قيمة منطقية اختيارية

    يشير إلى أنّ هذا العنصر مفعَّل.

  • id

    سلسلة

    السلسلة التي سيتم تمريرها إلى عمليات الاستدعاء التي تشير إلى MenuItem هذا.

  • التصنيف

    string اختياري

    النص المعروض في القائمة لهذا العنصر

  • النمط

    MenuItemStyle اختياري

    نوع عنصر القائمة

  • مرئي

    قيمة منطقية اختيارية

    يشير هذا الرمز إلى أنّ هذا العنصر مرئي.

MenuItemStyle

الإصدار 44 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

نوع عنصر القائمة تُعتبر أزرار الاختيار بين الفواصل مجمّعة.

Enum

"check"

"radio"

"separator"

MenuParameters

الإصدار 88 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

الخصائص

  • engineID

    سلسلة

    رقم تعريف المحرّك المطلوب استخدامه

  • items

    عناصر القائمة المطلوب إضافتها أو تعديلها وستتم إضافتها بالترتيب الذي تظهر به في الصفيف.

MouseButton

الإصدار 44 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

زر الماوس الذي تم النقر عليه

Enum

"left"

"middle"

"right"

ScreenType

الإصدار 44 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

نوع الشاشة التي يتم تفعيل "محرِّر أسلوب الإدخال" (IME) ضمنها

Enum

"normal"

"login"

"lock"

"secondary-login"

UnderlineStyle

الإصدار 44 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

نوع الخط السفلي لتعديل هذا الجزء

Enum

"underline"

"doubleUnderline"

"noUnderline"

WindowPosition

الإصدار 44 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

مكان عرض نافذة المرشحين في حال ضبط السياسة على "المؤشر"، تتبع النافذة المؤشر. في حال ضبطها على "composition"، يتم قفل النافذة على بداية التركيب.

Enum

"cursor"

"composition"

الطُرق

clearComposition()

browser.input.ime.clearComposition(
  parameters: object,
)
: Promise<boolean>

محو المحتوى الحالي إذا لم تكن هذه الإضافة تملك محرِّر أسلوب الإدخال النشط، ستتعذّر هذه العملية.

المعلمات

  • المعلمات

    عنصر

    • contextID

      الرقم

      رقم تعريف السياق الذي سيتم فيه محو التركيب

المرتجعات

  • Promise<boolean>

    الإصدار 111 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    يتم حلّ المشكلة عند اكتمال العملية باستخدام قيمة منطقية تشير إلى ما إذا تم قبول النص أم لا. في حال تعذّر تنفيذ الوعد، سيتم رفضه.

commitText()

browser.input.ime.commitText(
  parameters: object,
)
: Promise<boolean>

يتم تنفيذ النص المقدَّم في الإدخال الحالي.

المعلمات

  • المعلمات

    عنصر

    • contextID

      الرقم

      رقم تعريف السياق الذي سيتم فيه إرسال النص

    • نصي

      سلسلة

      النص المطلوب إدخاله

المرتجعات

  • Promise<boolean>

    الإصدار 111 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    يتم حلّ المشكلة عند اكتمال العملية باستخدام قيمة منطقية تشير إلى ما إذا تم قبول النص أم لا. في حال تعذّر تنفيذ الوعد، سيتم رفضه.

deleteSurroundingText()

browser.input.ime.deleteSurroundingText(
  parameters: object,
)
: Promise<void>

لحذف النص حول علامة الإقحام

المعلمات

  • المعلمات

    عنصر

    • contextID

      الرقم

      رقم تعريف السياق الذي سيتم حذف النص المحيط به

    • engineID

      سلسلة

      رقم تعريف المحرّك الذي يتلقّى الحدث

    • length

      الرقم

      عدد الأحرف المطلوب حذفها

    • اقتطاع

      الرقم

      تمثّل هذه السمة الإزاحة من موضع علامة الإقحام حيث سيبدأ الحذف. يمكن أن تكون هذه القيمة سالبة.

المرتجعات

  • وعد<فراغ>

    الإصدار 111 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    يتم حلّ المشكلة عند اكتمال العملية.

hideInputView()

browser.input.ime.hideInputView(): void

يخفي نافذة عرض الإدخال التي تظهر تلقائيًا من خلال النظام. إذا كانت نافذة عرض الإدخال مخفية، لن تؤدي هذه الدالة إلى أي إجراء.

keyEventHandled()

browser.input.ime.keyEventHandled(
  requestId: string,
  response: boolean,
)
: void

يشير ذلك إلى أنّه تتم معالجة حدث المفتاح الذي تلقّته دالة onKeyEvent. يجب استدعاء هذه الدالة فقط إذا كان المستمع onKeyEvent غير متزامن.

المعلمات

  • requestId

    سلسلة

    رقم تعريف طلب الحدث الذي تم التعامل معه يجب أن يكون مصدر هذه القيمة هو keyEvent.requestId

  • رد

    قيمة منطقية

    "صحيح" إذا تم التعامل مع ضغطة المفتاح، و"خطأ" في الحالات الأخرى

sendKeyEvents()

browser.input.ime.sendKeyEvents(
  parameters: object,
)
: Promise<void>

يتم إرسال الأحداث الرئيسية. من المتوقّع أن تستخدم لوحات المفاتيح الافتراضية هذه الدالة. عندما يضغط المستخدم على مفاتيح في لوحة مفاتيح افتراضية، يتم استخدام هذه الدالة لنشر هذا الحدث إلى النظام.

المعلمات

  • المعلمات

    عنصر

    • contextID

      الرقم

      رقم تعريف السياق الذي سيتم إرسال الأحداث الرئيسية إليه، أو صفر لإرسال الأحداث الرئيسية إلى حقل غير مخصّص للإدخال

    • keyData

      بيانات عن الحدث الرئيسي

المرتجعات

  • وعد<فراغ>

    الإصدار 111 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    يتم حلّ المشكلة عند اكتمال العملية.

setAssistiveWindowButtonHighlighted()

الإصدار 86 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome
browser.input.ime.setAssistiveWindowButtonHighlighted(
  parameters: object,
)
: Promise<void>

لتمييز زر في نافذة مساعِدة أو إلغاء تمييزه

المعلمات

  • المعلمات

    عنصر

    • announceString

      string اختياري

      النص الذي سيعلنه قارئ الشاشة

    • رقم تعريف الزر

    • contextID

      الرقم

      رقم تعريف السياق الذي يملك النافذة المساعدة

    • بارزة

      قيمة منطقية

      لتحديد ما إذا كان يجب تمييز الزر أم لا

    • windowType

      "undo"

      نوع النافذة التي ينتمي إليها الزر

المرتجعات

  • وعد<فراغ>

    الإصدار 111 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    يتم حلّ المشكلة عند اكتمال العملية. في حال تعذّر تنفيذ الوعد، سيتم رفضه.

setAssistiveWindowProperties()

الإصدار 85 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome
browser.input.ime.setAssistiveWindowProperties(
  parameters: object,
)
: Promise<boolean>

لعرض/إخفاء نافذة مساعِدة بالخصائص المحدّدة

المعلمات

  • المعلمات

    عنصر

    • contextID

      الرقم

      رقم تعريف السياق الذي يملك النافذة المساعدة

    • أماكن الإقامة

      خصائص نافذة المساعدة

المرتجعات

  • Promise<boolean>

    الإصدار 111 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    يتم حلّ المشكلة عند اكتمال العملية.

setCandidates()

browser.input.ime.setCandidates(
  parameters: object,
)
: Promise<boolean>

يضبط قائمة المرشحين الحالية. يتعذّر تنفيذ هذا الإجراء إذا لم تكن هذه الإضافة تملك محرِّر أسلوب الإدخال النشط

المعلمات

  • المعلمات

    عنصر

    • العناصر المحفّزة لعرض الإعلانات

      object[]‎

      قائمة الخيارات التي ستظهر في نافذة الخيارات

      • علامة توضيح

        string اختياري

        نص إضافي يصف المرشّح

      • عنصر محفّز لعرض الإعلان

        سلسلة

        المرشّح

      • id

        الرقم

        رقم تعريف المرشّح

      • التصنيف

        string اختياري

        سلسلة قصيرة يتم عرضها بجانب المرشح، وغالبًا ما تكون مفتاح الاختصار أو الفهرس

      • parentId

        number اختيارية

        رقم التعريف لإضافة هؤلاء المرشحين ضمنه

      • الاستخدام

        object اختياري

        استخدام الكلمة أو وصفها التفصيلي

        • body

          سلسلة

          سلسلة نصية للوصف التفصيلي

        • title

          سلسلة

          سلسلة عنوان وصف التفاصيل

    • contextID

      الرقم

      رقم تعريف السياق الذي يملك نافذة المرشحين

المرتجعات

  • Promise<boolean>

    الإصدار 111 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    يتم حلّ المشكلة عند اكتمال العملية.

setCandidateWindowProperties()

browser.input.ime.setCandidateWindowProperties(
  parameters: object,
)
: Promise<boolean>

يتم ضبط خصائص نافذة المرشحين. يتعذّر تنفيذ هذا الإجراء إذا لم تكن الإضافة تملك محرِّر أسلوب الإدخال النشط

المعلمات

  • المعلمات

    عنصر

    • engineID

      سلسلة

      رقم تعريف المحرّك المطلوب ضبط المواقع عليه

    • أماكن الإقامة

      عنصر

      • auxiliaryText

        string اختياري

        النص الذي يظهر في أسفل نافذة المرشحين.

      • auxiliaryTextVisible

        قيمة منطقية اختيارية

        القيمة True لعرض النص المساعد، والقيمة False لإخفائه.

      • currentCandidateIndex

        number اختيارية

        الإصدار 84 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

        فهرس المرشّح الحالي الذي تم اختياره من بين إجمالي المرشّحين

      • cursorVisible

        قيمة منطقية اختيارية

        القيمة True لإظهار المؤشر، والقيمة False لإخفائه.

      • pageSize

        number اختيارية

        عدد المرشحين المطلوب عرضهم في كل صفحة.

      • totalCandidates

        number اختيارية

        الإصدار 84 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

        إجمالي عدد المرشحين لنافذة المرشحين.

      • عمودي

        قيمة منطقية اختيارية

        صحيح إذا كان يجب عرض نافذة المرشحين عموديًا، وخطأ لجعلها أفقية.

      • مرئي

        قيمة منطقية اختيارية

        صحيح لإظهار نافذة "المرشّح"، وخطأ لإخفائها.

      • windowPosition

        WindowPosition اختياري

        مكان عرض نافذة المرشحين

المرتجعات

  • Promise<boolean>

    الإصدار 111 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    يتم حلّ المشكلة عند اكتمال العملية.

setComposition()

browser.input.ime.setComposition(
  parameters: object,
)
: Promise<boolean>

ضبط التركيب الحالي إذا لم تكن هذه الإضافة تملك محرِّر أسلوب الإدخال النشط، ستتعذّر هذه العملية.

المعلمات

  • المعلمات

    عنصر

    • contextID

      الرقم

      رقم تعريف السياق الذي سيتم فيه ضبط نص الإنشاء

    • مؤشر

      الرقم

      موضع المؤشر في النص

    • الشرائح

      object[] اختياري

      قائمة بالشرائح وأنواعها المرتبطة بها

      • إنهاء

        الرقم

        فهرس الحرف الذي ينتهي بعده هذا المقطع.

      • بدء

        الرقم

        فهرس الحرف الذي تبدأ عنده هذه الشريحة

      • النمط

        نوع الخط السفلي لتعديل هذا الجزء

    • selectionEnd

      number اختيارية

      الموضع في النص الذي ينتهي عنده التحديد

    • selectionStart

      number اختيارية

      الموضع في النص الذي يبدأ منه التحديد

    • نصي

      سلسلة

      النص المطلوب ضبطه

المرتجعات

  • Promise<boolean>

    الإصدار 111 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    يتم حلّ المشكلة عند اكتمال العملية باستخدام قيمة منطقية تشير إلى ما إذا تم قبول النص أم لا. في حال تعذّر تنفيذ الوعد، سيتم رفضه.

setCursorPosition()

browser.input.ime.setCursorPosition(
  parameters: object,
)
: Promise<boolean>

اضبط موضع المؤشر في نافذة المرشحين. لا يتم تنفيذ أي إجراء إذا لم تكن هذه الإضافة تملك محرِّر أسلوب الإدخال النشط.

المعلمات

  • المعلمات

    عنصر

    • candidateID

      الرقم

      رقم تعريف المرشّح المطلوب اختياره

    • contextID

      الرقم

      رقم تعريف السياق الذي يملك نافذة المرشحين

المرتجعات

  • Promise<boolean>

    الإصدار 111 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    يتم حلّ المشكلة عند اكتمال العملية

setMenuItems()

browser.input.ime.setMenuItems(
  parameters: MenuParameters,
)
: Promise<void>

يضيف عناصر القائمة المقدَّمة إلى قائمة اللغة عندما يكون محرِّر أسلوب الإدخال هذا نشطًا.

المعلمات

المرتجعات

  • وعد<فراغ>

    الإصدار 111 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

updateMenuItems()

browser.input.ime.updateMenuItems(
  parameters: MenuParameters,
)
: Promise<void>

تعديل حالة عناصر القائمة المحدّدة

المعلمات

المرتجعات

  • وعد<فراغ>

    الإصدار 111 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    يتم حلّ المشكلة عند اكتمال العملية

الفعاليات

onActivate

browser.input.ime.onActivate.addListener(
  callback: function,
)

يتم إرسال هذا الحدث عند تفعيل محرِّر أسلوب الإدخال. ويشير ذلك إلى أنّ محرِّر أسلوب الإدخال سيتلقّى أحداث onKeyPress.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي:

    (engineID: string, screen: ScreenType) => void

onAssistiveWindowButtonClicked

الإصدار 85 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome
browser.input.ime.onAssistiveWindowButtonClicked.addListener(
  callback: function,
)

يتم إرسال هذا الحدث عند النقر على زر في نافذة مساعِدة.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي:

    (details: object) => void

onBlur

browser.input.ime.onBlur.addListener(
  callback: function,
)

يتم إرسال هذا الحدث عندما يغادر التركيز مربّع نص. ويتم إرسالها إلى جميع الإضافات التي تستمع إلى هذا الحدث، والتي فعّلها المستخدم.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي:

    (contextID: number) => void

    • contextID

      الرقم

onCandidateClicked

browser.input.ime.onCandidateClicked.addListener(
  callback: function,
)

يتم إرسال هذا الحدث إذا كانت هذه الإضافة تملك محرِّر أسلوب الإدخال النشط.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي:

    (engineID: string, candidateID: number, button: MouseButton) => void

    • engineID

      سلسلة

    • candidateID

      الرقم

onDeactivated

browser.input.ime.onDeactivated.addListener(
  callback: function,
)

يتم إرسال هذا الحدث عند إيقاف محرِّر أسلوب الإدخال. يشير ذلك إلى أنّ محرّر أسلوب الإدخال لن يتلقّى أحداث onKeyPress بعد الآن.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي:

    (engineID: string) => void

    • engineID

      سلسلة

onFocus

browser.input.ime.onFocus.addListener(
  callback: function,
)

يتم إرسال هذا الحدث عندما ينتقل التركيز إلى مربّع نص. ويتم إرسالها إلى جميع الإضافات التي تستمع إلى هذا الحدث، والتي فعّلها المستخدم.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي:

    (context: InputContext) => void

onInputContextUpdate

browser.input.ime.onInputContextUpdate.addListener(
  callback: function,
)

يتم إرسال هذا الحدث عند تغيير خصائص InputContext الحالي، مثل النوع. ويتم إرسالها إلى جميع الإضافات التي تستمع إلى هذا الحدث، والتي فعّلها المستخدم.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي:

    (context: InputContext) => void

onKeyEvent

browser.input.ime.onKeyEvent.addListener(
  callback: function,
)

يتم تنشيطه عند إرسال حدث رئيسي من نظام التشغيل. سيتم إرسال الحدث إلى الإضافة إذا كانت هذه الإضافة تملك محرِّر أسلوب الإدخال النشط. يجب أن تعرض دالة المستمع القيمة "صحيح" إذا تمت معالجة الحدث، والقيمة "خطأ" إذا لم تتم معالجته. إذا كان سيتم تقييم الحدث بشكل غير متزامن، يجب أن تعرض هذه الدالة قيمة غير محدّدة، ويجب أن يستدعي محرِّر أسلوب الإدخال لاحقًا الدالة keyEventHandled()‎ مع النتيجة.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي:

    (engineID: string, keyData: KeyboardEvent, requestId: string) => boolean | undefined

    • returns

      boolean | undefined

onMenuItemActivated

browser.input.ime.onMenuItemActivated.addListener(
  callback: function,
)

يتم استدعاؤها عندما يختار المستخدم عنصرًا من القائمة

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي:

    (engineID: string, name: string) => void

    • engineID

      سلسلة

    • الاسم

      سلسلة

onReset

browser.input.ime.onReset.addListener(
  callback: function,
)

يتم إرسال هذا الحدث عندما ينهي Chrome جلسة إدخال النص الجارية.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي:

    (engineID: string) => void

    • engineID

      سلسلة

onSurroundingTextChanged

browser.input.ime.onSurroundingTextChanged.addListener(
  callback: function,
)

يتم استدعاء هذه الدالة عند تغيير السلسلة القابلة للتعديل حول علامة الإقحام أو عند نقل موضع علامة الإقحام. يقتصر طول النص على 100 حرف لكل اتجاه ذهابًا وإيابًا.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي:

    (engineID: string, surroundingInfo: object) => void

    • engineID

      سلسلة

    • surroundingInfo

      عنصر

      • علامة ارتساء

        الرقم

        موضع بداية الجزء المحدَّد تشير هذه القيمة إلى موضع علامة الإقحام في حال عدم تحديد أي نص.

      • التركيز

        الرقم

        موضع نهاية الجزء المحدَّد تشير هذه القيمة إلى موضع علامة الإقحام في حال عدم تحديد أي نص.

      • اقتطاع

        الرقم

        الإصدار 46 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

        موضع الإزاحة لـ text. بما أنّ text يتضمّن فقط مجموعة فرعية من النص حول المؤشر، تشير الإزاحة إلى الموضع المطلق للحرف الأول من text.

      • نصي

        سلسلة

        النص المحيط بالمؤشر هذه ليست سوى مجموعة فرعية من كل النص في حقل الإدخال.