תיאור
השתמשו ב-API chrome.input.ime
כדי להטמיע IME בהתאמה אישית עבור Chrome OS. ההגדרה הזו מאפשרת לתוסף לטפל בהקשות, להגדיר את הקומפוזיציה ולנהל את החלון של המועמד.
הרשאות
input
כדי להשתמש ב-input.ime API, צריך להצהיר על ההרשאה 'קלט' במניפסט התוסף. לדוגמה:
{
"name": "My extension",
...
"permissions": [
"input"
],
...
}
זמינות
דוגמאות
הקוד הבא יוצר 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
המזהה של הלחצנים בחלון המסייע.
טיפוסים בני מנייה (enum)
AssistiveWindowProperties
המאפיינים של חלון הסיוע.
תכונות
-
announceString
מחרוזת אופציונלי
מחרוזות שצריך להכריז עליהן ב-ChromeVox.
-
סוג
-
גלוי
boolean
מגדיר את הערך True להצגת AssistiveWindow, ומגדיר false להסתרה.
AssistiveWindowType
סוג חלון סיוע.
ערך של Gpa education
AutoCapitalizeType
סוג האותיות הרישיות באופן אוטומטי בשדה הטקסט.
טיפוסים בני מנייה (enum)
InputContext
תיאור של הקשר קלט
תכונות
-
autoCapitalizeChrome מגרסה 69 ואילך
סוג האותיות הרישיות באופן אוטומטי בשדה הטקסט.
-
autoComplete
boolean
האם נדרשת השלמה אוטומטית בשדה הטקסט.
-
autoCorrect
boolean
האם צריך לתקן אוטומטית את שדה הטקסט.
-
contextID
number
משמש לציון יעדים של פעולות בשדה הטקסט. המזהה הזה לא יהיה תקף מיד לאחר ההפעלה של onBlur.
-
shouldDoLearning
boolean
Chrome מגרסה 68 ואילךהאם הטקסט שהוזן בשדה הטקסט ישמש כדי לשפר את הצעות ההקלדה עבור המשתמש.
-
spellCheck
boolean
האם ברצונך לבדוק איות בשדה הטקסט.
-
סוג
סוג הערך ששדה הטקסט נערך, (טקסט, מספר, כתובת URL וכו')
InputContextType
סוג הערך ששדה הטקסט נערך, (טקסט, מספר, כתובת URL וכו')
טיפוסים בני מנייה (enum)
"text"
"tel"
"url"
"null"
KeyboardEvent
פרטים נוספים זמינים בכתובת http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent.
תכונות
-
altKey
ערך בוליאני אופציונלי
האם הוא לחוץ על מקש ALT.
-
altgrKey
ערך בוליאני אופציונלי
Chrome מגרסה 79 ואילךהאם מקש ALTGR לחוץ או לא.
-
capsLock
ערך בוליאני אופציונלי
האם CAPS_LOCK מופעל או לא.
-
קוד
string
הערך של המפתח הפיזי שעליו לוחצים. הערך לא מושפע מפריסת המקלדת הנוכחית או ממצב הצירוף הנוכחי.
-
ctrlKey
ערך בוליאני אופציונלי
האם הוא לחוץ על מקש CTRL.
-
extensionId
מחרוזת אופציונלי
מזהה התוסף של השולח באירוע המרכזי הזה.
-
key
string
הערך של המפתח שעליו לוחצים
-
keyCode
מספר אופציונלי
קוד המפתח של HTML שהוצא משימוש, שהוא קוד מספרי תלוי מערכת והטמעה שמסמן את המזהה שלא השתנה שמשויך למפתח שנלחץ.
-
requestId
מחרוזת אופציונלי
(הוצא משימוש) מזהה הבקשה. במקום זאת, צריך להשתמש בפרמטר
requestId
מהאירועonKeyEvent
. -
shiftKey
ערך בוליאני אופציונלי
האם מקש SHIFT לחוץ או לא.
-
אחד ממקשי הקיצור או מקש הקיצור.
KeyboardEventType
טיפוסים בני מנייה (enum)
"keyup"
"keydown"
MenuItem
אפשרות בתפריט שמשמשת את שיטת הקלט לאינטראקציה עם המשתמש מתפריט השפה.
תכונות
-
בוצע סימון
ערך בוליאני אופציונלי
מעיד על כך שיש לצייר את הפריט הזה באמצעות סימון.
-
פעיל
ערך בוליאני אופציונלי
מציין שהפריט הזה מופעל.
-
id
string
מחרוזת שיועבר לשיחות חוזרות שקשורות לפריט הזה בתפריט.
-
label
מחרוזת אופציונלי
הטקסט שמוצג בתפריט של הפריט הזה.
-
style
MenuItemStyle אופציונלי
הסוג של האפשרות בתפריט.
-
גלוי
ערך בוליאני אופציונלי
מציין שהפריט גלוי.
MenuItemStyle
הסוג של האפשרות בתפריט. לחצני בחירה בין מפרידים נחשבים למקובצים.
טיפוסים בני מנייה (enum)
"check"
MenuParameters
תכונות
-
engineID
string
המזהה של המנוע שבו רוצים להשתמש.
-
פריטים
MenuItem[]
פריטים בתפריט להוספה או לעדכון. הם יתווספו לפי הסדר שבו הם קיימים במערך.
MouseButton
על אילו לחצני עכבר לחצו.
טיפוסים בני מנייה (enum)
ScreenType
סוג המסך שבו מופעל ה-IME.
טיפוסים בני מנייה (enum)
"secondary-login"
UnderlineStyle
סוג הקו התחתון שרוצים לשנות את הקטע הזה.
טיפוסים בני מנייה (enum)
WindowPosition
המיקום שבו יוצג חלון המועמד. אם המדיניות מוגדרת כ-cursor, החלון עוקב אחר הסמן. אם מוגדר הערך 'composition', החלון נעול לתחילת היצירה.
טיפוסים בני מנייה (enum)
שיטות
clearComposition()
chrome.input.ime.clearComposition(
parameters: object,
callback?: function,
)
מחיקת ההרכב הנוכחי. אם התוסף הזה לא הבעלים של ה-IME הפעיל, הפעולה תיכשל.
פרמטרים
-
פרמטרים
אובייקט
-
contextID
number
מזהה ההקשר שבו היצירה תוסר
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(success: boolean) => void
-
הצלחה
boolean
-
החזרות
-
Promise<boolean>
Chrome 111 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל יש גם קריאות חוזרות (callback) לצורך תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה ניתנת לפתרון באותו הסוג שמועבר לקריאה החוזרת.
commitText()
chrome.input.ime.commitText(
parameters: object,
callback?: function,
)
הפונקציה מוסיפה את הטקסט שצוין לקלט הנוכחי.
פרמטרים
-
פרמטרים
אובייקט
-
contextID
number
המזהה של ההקשר שבו הטקסט יישמר
-
טקסט
string
הטקסט לשמירה
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(success: boolean) => void
-
הצלחה
boolean
-
החזרות
-
Promise<boolean>
Chrome 111 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל יש גם קריאות חוזרות (callback) לצורך תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה ניתנת לפתרון באותו הסוג שמועבר לקריאה החוזרת.
deleteSurroundingText()
chrome.input.ime.deleteSurroundingText(
parameters: object,
callback?: function,
)
מחיקת הטקסט שמסביב לסמן.
פרמטרים
-
פרמטרים
אובייקט
-
contextID
number
מזהה של ההקשר שבו הטקסט שמסביב יימחק.
-
engineID
string
המזהה של המנוע שמקבל את האירוע.
-
length
number
מספר התווים שרוצים למחוק
-
לקזז
number
הסטייה מהמיקום של סמן הטקסט שבו מתחילה המחיקה. הערך הזה יכול להיות שלילי.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 111 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל יש גם קריאות חוזרות (callback) לצורך תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה ניתנת לפתרון באותו הסוג שמועבר לקריאה החוזרת.
hideInputView()
chrome.input.ime.hideInputView()
הסתרת החלון של תצוגת הקלט, שקופץ באופן אוטומטי על ידי המערכת. אם החלון של תצוגת הקלט כבר מוסתר, הפונקציה הזו לא תבצע שום פעולה.
keyEventHandled()
chrome.input.ime.keyEventHandled(
requestId: string,
response: boolean,
)
מציין שהאירוע המרכזי שהתקבל ב-onKeyEvent מטופל. יש להפעיל את הפעולה הזו רק אם אוזן onKeyEvent הוא אסינכרוני.
פרמטרים
-
requestId
string
מזהה הבקשה של האירוע שטופל. הוא אמור להגיע מ-keyEvent.requestId.
-
תשובה
boolean
הערך הוא True אם הקשה על מקש טופלה, ו-False אם לא
sendKeyEvents()
chrome.input.ime.sendKeyEvents(
parameters: object,
callback?: function,
)
האירועים המרכזיים נשלחים. הפונקציה הזו אמורה להיות בשימוש במקלדות וירטואליות. כשמשתמש לוחץ על מקשים במקלדת וירטואלית, הפונקציה הזו משמשת כדי להפיץ את האירוע במערכת.
פרמטרים
-
פרמטרים
אובייקט
-
contextID
number
מזהה של ההקשר שאליו יישלחו האירועים המרכזיים, או אפס כדי לשלוח אירועים מרכזיים לשדה שאינו קלט.
-
keyData
נתונים על האירוע המרכזי.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 111 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל יש גם קריאות חוזרות (callback) לצורך תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה ניתנת לפתרון באותו הסוג שמועבר לקריאה החוזרת.
setAssistiveWindowButtonHighlighted()
chrome.input.ime.setAssistiveWindowButtonHighlighted(
parameters: object,
callback?: function,
)
הדגשה/ביטול ההדגשה של לחצן בחלון מסייע.
פרמטרים
-
פרמטרים
אובייקט
-
announceString
מחרוזת אופציונלי
הטקסט להכרזת קורא המסך.
-
buttonID
המזהה של הלחצן
-
contextID
number
מזהה של ההקשר שבעל החלון המסייע.
-
מודגש
boolean
האם הלחצן צריך להיות מודגש.
-
windowType
סוג החלון שאליו שייך הלחצן.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 111 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל יש גם קריאות חוזרות (callback) לצורך תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה ניתנת לפתרון באותו הסוג שמועבר לקריאה החוזרת.
setAssistiveWindowProperties()
chrome.input.ime.setAssistiveWindowProperties(
parameters: object,
callback?: function,
)
הצגה/הסתרה של חלון מסייע עם המאפיינים הנתונים.
פרמטרים
-
פרמטרים
אובייקט
-
contextID
number
מזהה של ההקשר שבעל החלון המסייע.
-
המאפיינים של חלון הסיוע.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(success: boolean) => void
-
הצלחה
boolean
-
החזרות
-
Promise<boolean>
Chrome 111 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל יש גם קריאות חוזרות (callback) לצורך תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה ניתנת לפתרון באותו הסוג שמועבר לקריאה החוזרת.
setCandidates()
chrome.input.ime.setCandidates(
parameters: object,
callback?: function,
)
מגדיר את רשימת המועמדים הנוכחית. פעולה זו תיכשל אם התוסף הזה אינו הבעלים של ה-IME הפעיל
פרמטרים
-
פרמטרים
אובייקט
-
מועמדים
אובייקט[]
רשימת המועמדים שתוצג בחלון המועמד
-
אנוטציה
מחרוזת אופציונלי
טקסט נוסף שמתאר את המועמד
-
שילוב אפשרי למיקוד
string
המועמד
-
id
number
המזהה של המועמד
-
label
מחרוזת אופציונלי
מחרוזת קצרה מוצגת לצד המועמד, בדרך כלל מקש הקיצור או האינדקס
-
parentId
מספר אופציונלי
המזהה שבו רוצים להוסיף את המועמדים האלה
-
שימוש
אובייקט אופציונלי
השימוש או התיאור המפורט של המילה.
-
body
string
מחרוזת הגוף של תיאור הפרטים.
-
title
string
מחרוזת הכותרת של תיאור הפרטים.
-
-
-
contextID
number
מזהה של ההקשר שחלון המועמד נמצא בבעלותו.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(success: boolean) => void
-
הצלחה
boolean
-
החזרות
-
Promise<boolean>
Chrome 111 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל יש גם קריאות חוזרות (callback) לצורך תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה ניתנת לפתרון באותו הסוג שמועבר לקריאה החוזרת.
setCandidateWindowProperties()
chrome.input.ime.setCandidateWindowProperties(
parameters: object,
callback?: function,
)
מגדיר את המאפיינים של חלון המועמד. פעולה זו תיכשל אם התוסף אינו הבעלים של ה-IME הפעיל
פרמטרים
-
פרמטרים
אובייקט
-
engineID
string
המזהה של המנוע שבו רוצים להגדיר את המאפיינים.
-
נכסים
אובייקט
-
auxiliaryText
מחרוזת אופציונלי
טקסט שמוצג בתחתית החלון של המועמד.
-
auxiliaryTextVisible
ערך בוליאני אופציונלי
צריך להזין את הערך True כדי להציג את טקסט העזר, או false כדי להסתיר אותו.
-
currentCandidateIndex
מספר אופציונלי
Chrome מגרסה 84 ואילךהאינדקס של המועמד הנוכחי שנבחר מתוך סך כל המועמדים.
-
cursorVisible
ערך בוליאני אופציונלי
יש להזין True כדי להציג את הסמן, או false כדי להסתיר אותו.
-
pageSize
מספר אופציונלי
מספר המועמדים להצגה בכל דף.
-
totalCandidates
מספר אופציונלי
Chrome מגרסה 84 ואילךהמספר הכולל של המועמדים בחלון המועמדים.
-
לאורך
ערך בוליאני אופציונלי
הערך הוא True אם צריך לעבד את חלון המועמד כאנכי, או את הערך false כדי להפוך אותו למצב אופקי.
-
גלוי
ערך בוליאני אופציונלי
יש להגדיר את הערך True כדי להציג את החלון 'מועמד', או 'FALSE' כדי להסתיר אותו.
-
windowPosition
WindowPosition אופציונלי
המיקום שבו יוצג חלון המועמד.
-
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(success: boolean) => void
-
הצלחה
boolean
-
החזרות
-
Promise<boolean>
Chrome 111 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל יש גם קריאות חוזרות (callback) לצורך תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה ניתנת לפתרון באותו הסוג שמועבר לקריאה החוזרת.
setComposition()
chrome.input.ime.setComposition(
parameters: object,
callback?: function,
)
מגדירים את ההרכב הנוכחי. אם התוסף הזה לא הבעלים של ה-IME הפעיל, הפעולה תיכשל.
פרמטרים
-
פרמטרים
אובייקט
-
contextID
number
מזהה ההקשר שבו יוגדר הטקסט המוטבע
-
סמן
number
מיקום בטקסט של הסמן.
-
בפלחים דומים
אובייקט[] אופציונלי
רשימת פלחים והסוגים המשויכים אליהם.
-
סיום
number
האינדקס של התו שיסיים את הקטע הזה אחריו.
-
התחלה
number
האינדקס של התו שבו צריך להתחיל את הקטע
-
style
סוג הקו התחתון שרוצים לשנות את הקטע הזה.
-
-
selectionEnd
מספר אופציונלי
המיקום בטקסט שבו הבחירה מסתיימת.
-
selectionStart
מספר אופציונלי
המיקום בטקסט שבו הבחירה מתחילה.
-
טקסט
string
טקסט להגדרה
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(success: boolean) => void
-
הצלחה
boolean
-
החזרות
-
Promise<boolean>
Chrome 111 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל יש גם קריאות חוזרות (callback) לצורך תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה ניתנת לפתרון באותו הסוג שמועבר לקריאה החוזרת.
setCursorPosition()
chrome.input.ime.setCursorPosition(
parameters: object,
callback?: function,
)
הגדרת מיקום הסמן בחלון המועמד. זוהי פעולה פסולה אם התוסף הזה לא הבעלים של ה-IME הפעיל.
פרמטרים
-
פרמטרים
אובייקט
-
candidateID
number
המזהה של המועמד לבחירה.
-
contextID
number
מזהה של ההקשר שחלון המועמד נמצא בבעלותו.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(success: boolean) => void
-
הצלחה
boolean
-
החזרות
-
Promise<boolean>
Chrome 111 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל יש גם קריאות חוזרות (callback) לצורך תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה ניתנת לפתרון באותו הסוג שמועבר לקריאה החוזרת.
setMenuItems()
chrome.input.ime.setMenuItems(
parameters: MenuParameters,
callback?: function,
)
מוסיף את האפשרויות בתפריט שסופקו לתפריט השפה כאשר ה-IME הזה פעיל.
פרמטרים
-
פרמטרים
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 111 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל יש גם קריאות חוזרות (callback) לצורך תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה ניתנת לפתרון באותו הסוג שמועבר לקריאה החוזרת.
updateMenuItems()
chrome.input.ime.updateMenuItems(
parameters: MenuParameters,
callback?: function,
)
עדכון המצב של תפריט הפריטים שצוינו
פרמטרים
-
פרמטרים
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 111 ואילךהבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל יש גם קריאות חוזרות (callback) לצורך תאימות לאחור. לא ניתן להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה ניתנת לפתרון באותו הסוג שמועבר לקריאה החוזרת.
אירועים
onActivate
chrome.input.ime.onActivate.addListener(
callback: function,
)
אירוע זה נשלח כאשר מופעל IME. הוא מסמן שה-IME יקבל אירועי onKeyClick.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(engineID: string, screen: ScreenType) => void
-
engineID
string
-
סינון שיחות
-
onAssistiveWindowButtonClicked
chrome.input.ime.onAssistiveWindowButtonClicked.addListener(
callback: function,
)
האירוע הזה נשלח כשלוחצים על לחצן בחלון מסייע.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(details: object) => void
-
פרטים
אובייקט
-
buttonID
המזהה של הלחצן שעליו בוצעה לחיצה.
-
windowType
הסוג של חלון הסיוע.
-
-
onBlur
chrome.input.ime.onBlur.addListener(
callback: function,
)
האירוע הזה נשלח כשהמיקוד יוצא מתיבת טקסט. הוא נשלח לכל התוספים שמאזינים לאירוע הזה, והוא מופעל על ידי המשתמש.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(contextID: number) => void
-
contextID
number
-
onCandidateClicked
chrome.input.ime.onCandidateClicked.addListener(
callback: function,
)
האירוע הזה נשלח אם התוסף הזה הוא הבעלים של ה-IME הפעיל.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(engineID: string, candidateID: number, button: MouseButton) => void
-
engineID
string
-
candidateID
number
-
לחצן
-
onDeactivated
chrome.input.ime.onDeactivated.addListener(
callback: function,
)
האירוע הזה נשלח כאשר IME מושבת. הוא מסמן שה-IME לא יקבל יותר אירועי onKeyClick.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(engineID: string) => void
-
engineID
string
-
onFocus
chrome.input.ime.onFocus.addListener(
callback: function,
)
האירוע הזה נשלח כשהמיקוד מוסיף תיבת טקסט. הוא נשלח לכל התוספים שמאזינים לאירוע הזה, והוא מופעל על ידי המשתמש.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(context: InputContext) => void
-
context
-
onInputContextUpdate
chrome.input.ime.onInputContextUpdate.addListener(
callback: function,
)
האירוע הזה נשלח כשהמאפיינים של קלטContext הנוכחי משתנים, למשל הסוג. הוא נשלח לכל התוספים שמאזינים לאירוע הזה, והוא מופעל על ידי המשתמש.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(context: InputContext) => void
-
context
-
onKeyEvent
chrome.input.ime.onKeyEvent.addListener(
callback: function,
)
מופעל כשאירוע מרכזי נשלח ממערכת ההפעלה. האירוע יישלח לתוסף אם התוסף הזה הוא הבעלים של ה-IME הפעיל. פונקציית ההאזנה אמורה להחזיר את הערך True אם האירוע מטופל כ-False, אם לא. אם האירוע יעבור הערכה באופן אסינכרוני, הפונקציה הזו חייבת להחזיר לא מוגדרת וה-IME חייב לקרוא מאוחר יותר ל-keyEventHandated() עם התוצאה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(engineID: string, keyData: KeyboardEvent, requestId: string) => boolean | undefined
-
engineID
string
-
keyData
-
requestId
string
-
החזרות
בוליאני | לא מוגדר
-
onMenuItemActivated
chrome.input.ime.onMenuItemActivated.addListener(
callback: function,
)
מתבצעת שיחה כשהמשתמש בוחר אפשרות בתפריט
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(engineID: string, name: string) => void
-
engineID
string
-
שם
string
-
onReset
chrome.input.ime.onReset.addListener(
callback: function,
)
האירוע הזה נשלח כש-Chrome מסיים סשן מתמשך של קלט טקסט.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(engineID: string) => void
-
engineID
string
-
onSurroundingTextChanged
chrome.input.ime.onSurroundingTextChanged.addListener(
callback: function,
)
מופעלת כאשר המחרוזת שניתן לערוך סביב סמן הטקסט משתנה או כשמיקום סמן הטקסט מועבר. הטקסט מוגבל ל-100 תווים בכל כיוון.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(engineID: string, surroundingInfo: object) => void
-
engineID
string
-
surroundingInfo
אובייקט
-
עוגן
number
המיקום הראשון של הטקסט שנבחר. הערך הזה מציין את מיקום סמן הטקסט אם לא נבחרה בחירה.
-
מיקוד
number
המיקום האחרון של הבחירה. הערך הזה מציין את מיקום סמן הטקסט אם לא נבחרה בחירה.
-
לקזז
number
Chrome 46 ואילךמיקום ההיסט של
text
.text
כולל רק קבוצת משנה של טקסט מסביב לסמן, ולכן ההיסט מציין את המיקום המוחלט של התו הראשון שלtext
. -
טקסט
string
הטקסט שמסביב לסמן. זו רק קבוצת משנה של כל הטקסט בשדה להזנת הקלט.
-
-