123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530 |
- // Copyright 2022 The Chromium Authors. All rights reserved.
- // Use of this source code is governed by a BSD-style license that can be
- // found in the LICENSE file.
- // This file was generated by:
- // tools/json_schema_compiler/compiler.py.
- // NOTE: The format of types has changed. 'FooType' is now
- // 'chrome.inputMethodPrivate.FooType'.
- // Please run the closure compiler before committing changes.
- // See https://chromium.googlesource.com/chromium/src/+/main/docs/closure_compilation.md
- /** @fileoverview Externs generated from namespace: inputMethodPrivate */
- /** @const */
- chrome.inputMethodPrivate = {};
- /**
- * @enum {string}
- */
- chrome.inputMethodPrivate.MenuItemStyle = {
- CHECK: 'check',
- RADIO: 'radio',
- SEPARATOR: 'separator',
- };
- /**
- * A menu item used by an input method to interact with the user from the language menu.
- * @typedef {{
- * id: string,
- * label: (string|undefined),
- * style: (!chrome.inputMethodPrivate.MenuItemStyle|undefined),
- * visible: (boolean|undefined),
- * checked: (boolean|undefined),
- * enabled: (boolean|undefined)
- * }}
- */
- chrome.inputMethodPrivate.MenuItem;
- /**
- * @enum {string}
- */
- chrome.inputMethodPrivate.UnderlineStyle = {
- UNDERLINE: 'underline',
- DOUBLE_UNDERLINE: 'doubleUnderline',
- NO_UNDERLINE: 'noUnderline',
- };
- /**
- * @enum {string}
- */
- chrome.inputMethodPrivate.FocusReason = {
- MOUSE: 'mouse',
- TOUCH: 'touch',
- PEN: 'pen',
- OTHER: 'other',
- };
- /**
- * @enum {string}
- */
- chrome.inputMethodPrivate.InputModeType = {
- NO_KEYBOARD: 'noKeyboard',
- TEXT: 'text',
- TEL: 'tel',
- URL: 'url',
- EMAIL: 'email',
- NUMERIC: 'numeric',
- DECIMAL: 'decimal',
- SEARCH: 'search',
- };
- /**
- * @enum {string}
- */
- chrome.inputMethodPrivate.InputContextType = {
- TEXT: 'text',
- SEARCH: 'search',
- TEL: 'tel',
- URL: 'url',
- EMAIL: 'email',
- NUMBER: 'number',
- PASSWORD: 'password',
- NULL: 'null',
- };
- /**
- * @enum {string}
- */
- chrome.inputMethodPrivate.AutoCapitalizeType = {
- OFF: 'off',
- CHARACTERS: 'characters',
- WORDS: 'words',
- SENTENCES: 'sentences',
- };
- /**
- * Describes an input Context
- * @typedef {{
- * contextID: number,
- * type: !chrome.inputMethodPrivate.InputContextType,
- * mode: !chrome.inputMethodPrivate.InputModeType,
- * autoCorrect: boolean,
- * autoComplete: boolean,
- * autoCapitalize: !chrome.inputMethodPrivate.AutoCapitalizeType,
- * spellCheck: boolean,
- * shouldDoLearning: boolean,
- * focusReason: !chrome.inputMethodPrivate.FocusReason,
- * hasBeenPassword: boolean,
- * appKey: (string|undefined)
- * }}
- */
- chrome.inputMethodPrivate.InputContext;
- /**
- * User preference settings for a specific input method. Japanese input methods are not included because they are managed separately by Mozc module.
- * @typedef {{
- * enableCompletion: (boolean|undefined),
- * enableDoubleSpacePeriod: (boolean|undefined),
- * enableGestureTyping: (boolean|undefined),
- * enablePrediction: (boolean|undefined),
- * enableSoundOnKeypress: (boolean|undefined),
- * physicalKeyboardAutoCorrectionLevel: (number|undefined),
- * physicalKeyboardEnableCapitalization: (boolean|undefined),
- * virtualKeyboardAutoCorrectionLevel: (number|undefined),
- * virtualKeyboardEnableCapitalization: (boolean|undefined),
- * xkbLayout: (string|undefined),
- * koreanEnableSyllableInput: (boolean|undefined),
- * koreanKeyboardLayout: (string|undefined),
- * koreanShowHangulCandidate: (boolean|undefined),
- * pinyinChinesePunctuation: (boolean|undefined),
- * pinyinDefaultChinese: (boolean|undefined),
- * pinyinEnableFuzzy: (boolean|undefined),
- * pinyinEnableLowerPaging: (boolean|undefined),
- * pinyinEnableUpperPaging: (boolean|undefined),
- * pinyinFullWidthCharacter: (boolean|undefined),
- * pinyinFuzzyConfig: ({
- * an_ang: (boolean|undefined),
- * c_ch: (boolean|undefined),
- * en_eng: (boolean|undefined),
- * f_h: (boolean|undefined),
- * ian_iang: (boolean|undefined),
- * in_ing: (boolean|undefined),
- * k_g: (boolean|undefined),
- * l_n: (boolean|undefined),
- * r_l: (boolean|undefined),
- * s_sh: (boolean|undefined),
- * uan_uang: (boolean|undefined),
- * z_zh: (boolean|undefined)
- * }|undefined),
- * zhuyinKeyboardLayout: (string|undefined),
- * zhuyinPageSize: (number|undefined),
- * zhuyinSelectKeys: (string|undefined)
- * }}
- */
- chrome.inputMethodPrivate.InputMethodSettings;
- /**
- * Gets configurations for input methods.
- * @param {function({
- * isPhysicalKeyboardAutocorrectEnabled: boolean,
- * isImeMenuActivated: boolean
- * }): void} callback Callback which is called with the config object.
- */
- chrome.inputMethodPrivate.getInputMethodConfig = function(callback) {};
- /**
- * Gets all enabled input methods, sorted in ascending order of their localized
- * full display names, according to the lexicographical order defined by the
- * current system locale aka. display language.
- * @param {function(!Array<{
- * id: string,
- * name: string,
- * indicator: string
- * }>): void} callback Callback which is called with the input method objects.
- */
- chrome.inputMethodPrivate.getInputMethods = function(callback) {};
- /**
- * Gets the current input method.
- * @param {function(string): void} callback Callback which is called with the
- * current input method.
- */
- chrome.inputMethodPrivate.getCurrentInputMethod = function(callback) {};
- /**
- * Sets the current input method.
- * @param {string} inputMethodId The input method ID to be set as current input
- * method.
- * @param {function(): void=} callback Callback which is called once the current
- * input method is set. If unsuccessful $(ref:runtime.lastError) is set.
- */
- chrome.inputMethodPrivate.setCurrentInputMethod = function(inputMethodId, callback) {};
- /**
- * Switches to the last used input method. If no last used input method, this is
- * a no-op.
- * @param {function(): void=} callback Callback which is called once the input
- * method is swapped (if applicable). If unsuccessful
- * $(ref:runtime.lastError) is set.
- */
- chrome.inputMethodPrivate.switchToLastUsedInputMethod = function(callback) {};
- /**
- * Fetches a list of all the words currently in the dictionary.
- * @param {function(!Array<string>): void} callback Callback which is called
- * once the list of dictionary words are ready.
- */
- chrome.inputMethodPrivate.fetchAllDictionaryWords = function(callback) {};
- /**
- * Adds a single word to be stored in the dictionary.
- * @param {string} word A new word to add to the dictionary.
- * @param {function(): void=} callback Callback which is called once the word is
- * added. If unsuccessful $(ref:runtime.lastError) is set.
- */
- chrome.inputMethodPrivate.addWordToDictionary = function(word, callback) {};
- /**
- * Gets whether the encrypt sync is enabled.
- * @param {function(boolean): void=} callback Callback which is called to
- * provide the result.
- */
- chrome.inputMethodPrivate.getEncryptSyncEnabled = function(callback) {};
- /**
- * Sets the XKB layout for the given input method.
- * @param {string} xkb_name The XKB layout name.
- * @param {function(): void=} callback Callback which is called when the layout
- * is set.
- */
- chrome.inputMethodPrivate.setXkbLayout = function(xkb_name, callback) {};
- /**
- * Commits the text currently being composed without moving the selected text
- * range. This is a no-op if the context is incorrect.
- * @param {{
- * contextID: number
- * }} parameters
- * @param {function(): void=} callback Called when the operation completes.
- */
- chrome.inputMethodPrivate.finishComposingText = function(parameters, callback) {};
- /**
- * Sets the selection range
- * @param {{
- * contextID: number,
- * selectionStart: (number|undefined),
- * selectionEnd: (number|undefined)
- * }} parameters
- * @param {function(boolean): void=} callback Called when the operation
- * completes with a boolean indicating if the text was accepted or not.
- */
- chrome.inputMethodPrivate.setSelectionRange = function(parameters, callback) {};
- /**
- * Fires the input.ime.onMenuItemActivated event.
- * @param {string} engineID ID of the engine to use.
- * @param {string} name Name of the MenuItem which was activated
- */
- chrome.inputMethodPrivate.notifyImeMenuItemActivated = function(engineID, name) {};
- /**
- * Shows the input view window. If the input view window is already shown, this
- * function will do nothing.
- * @param {function(): void=} callback Called when the operation completes.
- */
- chrome.inputMethodPrivate.showInputView = function(callback) {};
- /**
- * Hides the input view window. If the input view window is already hidden, this
- * function will do nothing.
- * @param {function(): void=} callback Called when the operation completes.
- */
- chrome.inputMethodPrivate.hideInputView = function(callback) {};
- /**
- * Opens the options page for the input method extension. If the input method
- * does not have options, this function will do nothing.
- * @param {string} inputMethodId ID of the input method to open options for.
- */
- chrome.inputMethodPrivate.openOptionsPage = function(inputMethodId) {};
- /**
- * Gets the composition bounds
- * @param {function(!Array<{
- * x: number,
- * y: number,
- * w: number,
- * h: number
- * }>): void} callback Callback which is called to provide the result
- */
- chrome.inputMethodPrivate.getCompositionBounds = function(callback) {};
- /**
- * Gets the surrounding text of the current selection. WARNING: This could
- * return a stale cache that doesn't reflect reality, due to async between IMF
- * and TextInputClient.
- * @param {number} beforeLength The number of characters before the current
- * selection.
- * @param {number} afterLength The number of characters after the current
- * selection.
- * @param {function({
- * before: string,
- * selected: string,
- * after: string
- * }): void} callback Callback which is called to provide the result
- */
- chrome.inputMethodPrivate.getSurroundingText = function(beforeLength, afterLength, callback) {};
- /**
- * Gets the current values of all settings for a particular input method
- * @param {string} engineID The ID of the engine (e.g. 'zh-t-i0-pinyin',
- * 'xkb:us::eng')
- * @param {function((!chrome.inputMethodPrivate.InputMethodSettings|undefined)): void}
- * callback Callback to receive the settings
- */
- chrome.inputMethodPrivate.getSettings = function(engineID, callback) {};
- /**
- * Sets the value of all settings for a particular input method
- * @param {string} engineID The ID of the engine (e.g. 'zh-t-i0-pinyin',
- * 'xkb:us::eng')
- * @param {!chrome.inputMethodPrivate.InputMethodSettings} settings The settings
- * to set
- * @param {function(): void=} callback Callback to notify that the new value has
- * been set
- */
- chrome.inputMethodPrivate.setSettings = function(engineID, settings, callback) {};
- /**
- * (Deprecated) Set the composition range. If this extension does not own the
- * active IME, this fails. Use setComposingRange instead.
- * @param {{
- * contextID: number,
- * selectionBefore: number,
- * selectionAfter: number,
- * segments: (!Array<{
- * start: number,
- * end: number,
- * style: !chrome.inputMethodPrivate.UnderlineStyle
- * }>|undefined)
- * }} parameters
- * @param {function(boolean): void=} callback Called when the operation
- * completes with a boolean indicating if the text was accepted or not. On
- * failure, $(ref:runtime.lastError) is set.
- */
- chrome.inputMethodPrivate.setCompositionRange = function(parameters, callback) {};
- /**
- * Sets the composing range. If this extension does not own the active IME, this
- * fails.
- * @param {{
- * contextID: number,
- * start: number,
- * end: number,
- * segments: (!Array<{
- * start: number,
- * end: number,
- * style: !chrome.inputMethodPrivate.UnderlineStyle
- * }>|undefined)
- * }} parameters
- * @param {function(): void=} callback Called when the operation is complete. On
- * failure, $(ref:runtime.lastError) is set.
- */
- chrome.inputMethodPrivate.setComposingRange = function(parameters, callback) {};
- /**
- * Get the autocorrected word's bounds. Returns an empty range if there is no
- * autocorrected word.
- * @param {{
- * contextID: number
- * }} parameters
- * @param {function({
- * start: number,
- * end: number
- * }): void} callback Called with the bounds of the autocorrect word when the
- * operation completes. On failure, $(ref:runtime.lastError) is set.
- */
- chrome.inputMethodPrivate.getAutocorrectRange = function(parameters, callback) {};
- /**
- * Get the screen coordinates of the autocorrected word's bounds.
- * @param {{
- * contextID: number
- * }} parameters
- * @param {function({
- * x: number,
- * y: number,
- * width: number,
- * height: number
- * }): void} callback Called with screen coordinates of the autocorrect word
- * when the operation completes. On failure, $(ref:runtime.lastError) is
- * set.
- */
- chrome.inputMethodPrivate.getAutocorrectCharacterBounds = function(parameters, callback) {};
- /**
- * Set the autocorrect range and autocorrect word. If this extension does not
- * own the active IME, this fails.
- * @param {{
- * contextID: number,
- * autocorrectString: string,
- * selectionStart: number,
- * selectionEnd: number
- * }} parameters
- * @param {function(): void=} callback Called when the operation completes. On
- * failure, chrome.runtime.lastError is set.
- */
- chrome.inputMethodPrivate.setAutocorrectRange = function(parameters, callback) {};
- /**
- * Resets the current engine to its initial state. Fires an OnReset event.
- */
- chrome.inputMethodPrivate.reset = function() {};
- /**
- * Called after a word has been autocorrected to show some UI for autocorrect.
- * @param {{
- * contextID: number,
- * typedWord: string,
- * correctedWord: string,
- * startIndex: number
- * }} parameters
- */
- chrome.inputMethodPrivate.onAutocorrect = function(parameters) {};
- /**
- * Get the bounds of the current text field
- * @param {{
- * contextID: number
- * }} parameters
- * @param {function({
- * x: number,
- * y: number,
- * width: number,
- * height: number
- * }): void} callback Called with screen coordinates of the text field when the
- * operation completes. On failure, $(ref:runtime.lastError) is set.
- */
- chrome.inputMethodPrivate.getTextFieldBounds = function(parameters, callback) {};
- /**
- * Fired when the caret bounds change.
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onCaretBoundsChanged;
- /**
- * Fired when the input method is changed.
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onChanged;
- /**
- * Fired when the composition bounds or cursor bounds are changed.
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onCompositionBoundsChanged;
- /**
- * Fired when the custom spelling dictionary is loaded.
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onDictionaryLoaded;
- /**
- * Fired when words are added or removed from the custom spelling dictionary.
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onDictionaryChanged;
- /**
- * Fired when the IME menu is activated or deactivated.
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onImeMenuActivationChanged;
- /**
- * Fired when the input method or the list of active input method IDs is
- * changed.
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onImeMenuListChanged;
- /**
- * Fired when the input.ime.setMenuItems or input.ime.updateMenuItems API is
- * called.
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onImeMenuItemsChanged;
- /**
- * This event is sent when focus enters a text box. It is sent to all extensions
- * that are listening to this event, and enabled by the user.
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onFocus;
- /**
- * This event is sent when a touch occurs in a text field. Should only happen
- * after onFocus()
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onTouch;
- /**
- * This event is sent when the settings for any input method changed. It is sent
- * to all extensions that are listening to this event, and enabled by the user.
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onSettingsChanged;
- /**
- * This event is sent when the screen is being mirrored or the desktop is being
- * cast.
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onScreenProjectionChanged;
- /**
- * This event is sent when a new set of suggestions has been generated
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onSuggestionsChanged;
- /**
- * This event is sent when input method options are changed.
- * @type {!ChromeEvent}
- */
- chrome.inputMethodPrivate.onInputMethodOptionsChanged;
|