chrome.input.ime

الوصف

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

الأذونات

input

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

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

مدى التوفّر

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

أمثلة

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

var context_id = -1;

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

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

الأنواع

AssistiveWindowButton

الإصدار 85 من Chrome أو الإصدارات الأحدث

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

Enum

"تراجع"

"addToDictionary"

AssistiveWindowProperties

الإصدار 85 من Chrome أو الإصدارات الأحدث

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

أماكن إقامة

  • announceString

    سلسلة اختيارية

    سلاسل لـ ChromeVox للإعلان عنها.

  • كتابة

    "تراجع"

  • مرئي

    منطقي

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

AssistiveWindowType

الإصدار 85 من Chrome أو الإصدارات الأحدث

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

القيمة

"تراجع"

AutoCapitalizeType

الإصدار 69 من Chrome أو الإصدارات الأحدث

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

Enum

"الأحرف"

"الكلمات"

"الجُمل"

InputContext

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

أماكن إقامة

  • autoCapitalize
    الإصدار 69 من Chrome أو الإصدارات الأحدث

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

  • autoComplete

    منطقي

    ما إذا كان الحقل النصي يريد ميزة الإكمال التلقائي

  • autoCorrect

    منطقي

    ما إذا كان الحقل النصي يريد التصحيح التلقائي.

  • contextID

    الرقم

    يُستخدم هذا لتحديد أهداف عمليات الحقل النصي. يصبح رقم التعريف هذا غير صالح فور طلب onBur.

  • shouldDoLearning

    منطقي

    الإصدار 68 من Chrome أو الإصدارات الأحدث

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

  • spellCheck

    منطقي

    ما إذا كان الحقل النصي يريد إجراء تدقيق إملائي.

  • كتابة

    نوع القيمة التي يعدّلها الحقل النصي هذا (النص، الرقم، عنوان URL، إلخ)

InputContextType

الإصدار 44 من Chrome أو الإصدارات الأحدث

نوع القيمة التي يعدّلها الحقل النصي هذا (النص، الرقم، عنوان URL، إلخ)

Enum

"النص"

"بحث"

"الهاتف"

"عنوان URL"

"البريد الإلكتروني"

"الرقم"

"كلمة المرور"

"خالية"

KeyboardEvent

يمكنك الاطلاع على http://www.w3.org/TR/DOM-Level-3-الأحداث/#events-لوحة المفاتيحEvent

أماكن إقامة

  • altKey

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

    لتحديد ما إذا كان قد تم الضغط على مفتاح ALT أم لا

  • altgrKey

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

    الإصدار 79 من Chrome أو الإصدارات الأحدث

    لتحديد ما إذا كان قد تم الضغط على مفتاح ALTGR أم لا.

  • capsLock

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

    سواء تم تمكين CAPS_LOCK أم لا.

  • رمز

    سلسلة

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

  • ctrlKey

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

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

  • extensionId

    سلسلة اختيارية

    رقم تعريف الإضافة لمرسِل هذا الحدث الرئيسي.

  • مفتاح

    سلسلة

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

  • keyCode

    الرقم اختياري

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

  • requestId

    سلسلة اختيارية

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

  • shiftKey

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

    لتحديد ما إذا كان قد تم الضغط على مفتاح SHIFT أم لا.

  • كتابة

    أحد مفاتيح التحكّم أو مفتاح التبديل

KeyboardEventType

الإصدار 44 من Chrome أو الإصدارات الأحدث

Enum

"keyup"

"keydown"

MenuItem

عنصر قائمة يستخدمه أسلوب الإدخال للتفاعل مع المستخدم من قائمة اللغة.

أماكن إقامة

  • تم التحديد

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

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

  • مفعّلة

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

    يشير إلى تفعيل هذا العنصر.

  • id

    سلسلة

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

  • التصنيف

    سلسلة اختيارية

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

  • النمط

    MenuItemStyle اختيارية

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

  • مرئي

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

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

MenuItemStyle

الإصدار 44 من Chrome أو الإصدارات الأحدث

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

Enum

"علامة"

"راديو"

"الفاصل"

MenuParameters

الإصدار 88 من Chrome أو الإصدارات الأحدث

أماكن إقامة

  • engineID

    سلسلة

    رقم تعريف المحرّك المُراد استخدامه.

  • items

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

MouseButton

الإصدار 44 من Chrome أو الإصدارات الأحدث

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

Enum

"اليسار"

"المنتصف"

يمين

ScreenType

الإصدار 44 من Chrome أو الإصدارات الأحدث

نوع الشاشة التي يتم من خلالها تفعيل أداة IME.

Enum

"عادي"

"تسجيل الدخول"

"قفل"

"تسجيل الدخول الثانوي"

UnderlineStyle

الإصدار 44 من Chrome أو الإصدارات الأحدث

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

Enum

"تسطير"

"تسطير مزدوج"

"nounderline"

WindowPosition

الإصدار 44 من Chrome أو الإصدارات الأحدث

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

Enum

"المؤشر"

"الإنشاء"

الطُرق

clearComposition()

وعود
chrome.input.ime.clearComposition(
  parameters: object,
  callback?: function,
)

محو المقطوعة الحالية لن تنجح هذه العملية إذا لم تكن هذه الإضافة تمتلك أداة IME النشطة.

المعلمات

  • المعلمات

    كائن

    • contextID

      الرقم

      رقم تعريف السياق الذي سيتم فيه محو المقطوعة الموسيقية

  • رد الاتصال

    الدالة اختيارية

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

    (success: boolean) => void

    • النجاح

      منطقي

المرتجعات

  • Promise<boolean>

    الإصدار 111 من Chrome أو الإصدارات الأحدث

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

commitText()

وعود
chrome.input.ime.commitText(
  parameters: object,
  callback?: function,
)

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

المعلمات

  • المعلمات

    كائن

    • contextID

      الرقم

      معرّف السياق الذي سيتمّ فيه الالتزام بالنص

    • text

      سلسلة

      النص المطلوب الالتزام به

  • رد الاتصال

    الدالة اختيارية

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

    (success: boolean) => void

    • النجاح

      منطقي

المرتجعات

  • Promise<boolean>

    الإصدار 111 من Chrome أو الإصدارات الأحدث

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

deleteSurroundingText()

وعود
chrome.input.ime.deleteSurroundingText(
  parameters: object,
  callback?: function,
)

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

المعلمات

  • المعلمات

    كائن

    • contextID

      الرقم

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

    • engineID

      سلسلة

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

    • length

      الرقم

      عدد الأحرف المراد حذفها

    • اقتطاع

      الرقم

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

  • رد الاتصال

    الدالة اختيارية

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

    () => void

المرتجعات

  • وعود <باطلة>

    الإصدار 111 من Chrome أو الإصدارات الأحدث

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

hideInputView()

chrome.input.ime.hideInputView()

إخفاء نافذة عرض الإدخال التي تنبثق تلقائيًا من خلال النظام إذا كانت نافذة عرض الإدخال مخفية مسبقًا، لن تفعل هذه الدالة أي شيء.

keyEventHandled()

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

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

المعلمات

  • requestId

    سلسلة

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

  • رد

    منطقي

    True إذا تمت معالجة ضغطة المفتاح، وfalse إذا لم يتم إجراء ذلك

sendKeyEvents()

وعود
chrome.input.ime.sendKeyEvents(
  parameters: object,
  callback?: function,
)

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

المعلمات

  • المعلمات

    كائن

    • contextID

      الرقم

      رقم تعريف السياق الذي سيتم إرسال الأحداث الرئيسية إليه أو صفر لإرسال الأحداث الرئيسية إلى حقل لا يتضمن إدخالاً

    • keyData

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

  • رد الاتصال

    الدالة اختيارية

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

    () => void

المرتجعات

  • وعود <باطلة>

    الإصدار 111 من Chrome أو الإصدارات الأحدث

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

setAssistiveWindowButtonHighlighted()

وعود الإصدار 86 من Chrome والإصدارات الأحدث
chrome.input.ime.setAssistiveWindowButtonHighlighted(
  parameters: object,
  callback?: function,
)

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

المعلمات

  • المعلمات

    كائن

    • announceString

      سلسلة اختيارية

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

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

    • contextID

      الرقم

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

    • بارزة

      منطقي

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

    • windowType

      "تراجع"

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

  • رد الاتصال

    الدالة اختيارية

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

    () => void

المرتجعات

  • وعود <باطلة>

    الإصدار 111 من Chrome أو الإصدارات الأحدث

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

setAssistiveWindowProperties()

وعود الإصدار 85 من Chrome والإصدارات الأحدث
chrome.input.ime.setAssistiveWindowProperties(
  parameters: object,
  callback?: function,
)

لإظهار/إخفاء نافذة مساعِدة بالخصائص المذكورة

المعلمات

  • المعلمات

    كائن

    • contextID

      الرقم

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

    • المواقع

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

  • رد الاتصال

    الدالة اختيارية

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

    (success: boolean) => void

    • النجاح

      منطقي

المرتجعات

  • Promise&lt;boolean&gt;

    الإصدار 111 من Chrome أو الإصدارات الأحدث

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

setCandidates()

وعود
chrome.input.ime.setCandidates(
  parameters: object,
  callback?: function,
)

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

المعلمات

  • المعلمات

    كائن

    • مرشحون

      object[]

      قائمة المرشحين للعرض في نافذة العناصر المرشحة

      • علامة توضيح

        سلسلة اختيارية

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

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

        سلسلة

        المرشح

      • id

        الرقم

        معرّف المرشح

      • التصنيف

        سلسلة اختيارية

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

      • parentId

        الرقم اختياري

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

      • الاستخدام

        الكائن اختياري

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

        • النص الأساسي

          سلسلة

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

        • title

          سلسلة

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

    • contextID

      الرقم

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

  • رد الاتصال

    الدالة اختيارية

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

    (success: boolean) => void

    • النجاح

      منطقي

المرتجعات

  • Promise&lt;boolean&gt;

    الإصدار 111 من Chrome أو الإصدارات الأحدث

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

setCandidateWindowProperties()

وعود
chrome.input.ime.setCandidateWindowProperties(
  parameters: object,
  callback?: function,
)

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

المعلمات

  • المعلمات

    كائن

    • engineID

      سلسلة

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

    • المواقع

      كائن

      • auxiliaryText

        سلسلة اختيارية

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

      • auxiliaryTextVisible

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

        صحيح لعرض النص المساعِد، وخطأ لإخفائها.

      • currentCandidateIndex

        الرقم اختياري

        الإصدار 84 من Chrome أو الإصدارات الأحدث

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

      • cursorVisible

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

        صحيح لإظهار المؤشر، وخطأ لإخفائها.

      • pageSize

        الرقم اختياري

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

      • totalCandidates

        الرقم اختياري

        الإصدار 84 من Chrome أو الإصدارات الأحدث

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

      • فئة

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

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

      • مرئي

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

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

      • windowPosition

        WindowPosition اختياري

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

  • رد الاتصال

    الدالة اختيارية

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

    (success: boolean) => void

    • النجاح

      منطقي

المرتجعات

  • Promise&lt;boolean&gt;

    الإصدار 111 من Chrome أو الإصدارات الأحدث

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

setComposition()

وعود
chrome.input.ime.setComposition(
  parameters: object,
  callback?: function,
)

ضبط المقطوعة الموسيقية الحالية لن تنجح هذه العملية إذا لم تكن هذه الإضافة تمتلك أداة IME النشطة.

المعلمات

  • المعلمات

    كائن

    • contextID

      الرقم

      معرّف السياق الذي سيتمّ فيه ضبط نص المقطوعة الموسيقية

    • مؤشر

      الرقم

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

    • الشرائح

      object[] اختياري

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

      • إنهاء

        الرقم

        فهرس الحرف الذي سيتم إنهاء هذا الجزء بعده.

      • بدء

        الرقم

        فهرس الحرف المطلوب بدء هذا الجزء عنده

      • النمط

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

    • selectionEnd

      الرقم اختياري

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

    • selectionStart

      الرقم اختياري

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

    • text

      سلسلة

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

  • رد الاتصال

    الدالة اختيارية

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

    (success: boolean) => void

    • النجاح

      منطقي

المرتجعات

  • Promise&lt;boolean&gt;

    الإصدار 111 من Chrome أو الإصدارات الأحدث

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

setCursorPosition()

وعود
chrome.input.ime.setCursorPosition(
  parameters: object,
  callback?: function,
)

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

المعلمات

  • المعلمات

    كائن

    • candidateID

      الرقم

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

    • contextID

      الرقم

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

  • رد الاتصال

    الدالة اختيارية

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

    (success: boolean) => void

    • النجاح

      منطقي

المرتجعات

  • Promise&lt;boolean&gt;

    الإصدار 111 من Chrome أو الإصدارات الأحدث

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

setMenuItems()

وعود
chrome.input.ime.setMenuItems(
  parameters: MenuParameters,
  callback?: function,
)

تتم إضافة عناصر القائمة المتوفرة إلى قائمة اللغة عندما يكون أداة IME هذه نشطة.

المعلمات

  • المعلمات
  • رد الاتصال

    الدالة اختيارية

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

    () => void

المرتجعات

  • وعود <باطلة>

    الإصدار 111 من Chrome أو الإصدارات الأحدث

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

updateMenuItems()

وعود
chrome.input.ime.updateMenuItems(
  parameters: MenuParameters,
  callback?: function,
)

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

المعلمات

  • المعلمات
  • رد الاتصال

    الدالة اختيارية

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

    () => void

المرتجعات

  • وعود <باطلة>

    الإصدار 111 من Chrome أو الإصدارات الأحدث

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

فعاليات

onActivate

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

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

المعلمات

  • رد الاتصال

    دالة

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

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

onAssistiveWindowButtonClicked

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

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

المعلمات

  • رد الاتصال

    دالة

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

    (details: object) => void

onBlur

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

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

المعلمات

  • رد الاتصال

    دالة

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

    (contextID: number) => void

    • contextID

      الرقم

onCandidateClicked

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

يتم إرسال هذا الحدث إذا كانت هذه الإضافة تمتلك أداة IME النشطة.

المعلمات

  • رد الاتصال

    دالة

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

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

    • engineID

      سلسلة

    • candidateID

      الرقم

onDeactivated

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

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

المعلمات

  • رد الاتصال

    دالة

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

    (engineID: string) => void

    • engineID

      سلسلة

onFocus

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

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

المعلمات

  • رد الاتصال

    دالة

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

    (context: InputContext) => void

onInputContextUpdate

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

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

المعلمات

  • رد الاتصال

    دالة

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

    (context: InputContext) => void

onKeyEvent

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

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

المعلمات

  • رد الاتصال

    دالة

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

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

    • returns

      boolean | غير محدّدة

onMenuItemActivated

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

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

المعلمات

  • رد الاتصال

    دالة

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

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

    • engineID

      سلسلة

    • الاسم

      سلسلة

onReset

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

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

المعلمات

  • رد الاتصال

    دالة

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

    (engineID: string) => void

    • engineID

      سلسلة

onSurroundingTextChanged

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

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

المعلمات

  • رد الاتصال

    دالة

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

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

    • engineID

      سلسلة

    • surroundingInfo

      كائن

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

        الرقم

        موضع بداية التحديد. وتشير هذه القيمة إلى موضع علامة الإقحام إذا لم يكن هناك تحديد.

      • البؤرة

        الرقم

        موضع النهاية للتحديد. وتشير هذه القيمة إلى موضع علامة الإقحام إذا لم يكن هناك تحديد.

      • اقتطاع

        الرقم

        الإصدار 46 من Chrome أو الإصدارات الأحدث

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

      • text

        سلسلة

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