Input method functions for chrome.languageSettingsPrivate and chrome.inputMethodPrivate

third_party/closure_compiler/externs/input_method_private.js

+// Copyright 2016 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/+/master/docs/closure_compilation.md
+
+/** @fileoverview Externs generated from namespace: inputMethodPrivate */
+
+/**
+ * @const
+ */
+chrome.inputMethodPrivate = {};
+
+/**
+ * Gets configurations for input methods.
+ * @param {function({
+ *   isPhysicalKeyboardAutocorrectEnabled: boolean,
+ *   isImeMenuActivated: boolean
+ * }):void} callback Callback which is called with the config object.
+ * @see https://developer.chrome.com/extensions/inputMethodPrivate#method-getInputMethodConfig
+ */
+chrome.inputMethodPrivate.getInputMethodConfig = function(callback) {};
+
+/**
+ * Gets all whitelisted input methods.
+ * @param {function(!Array<{
+ *   id: string,
+ *   name: string,
+ *   indicator: string
+ * }>):void} callback Callback which is called with the input method objects.
+ * @see https://developer.chrome.com/extensions/inputMethodPrivate#method-getInputMethods
+ */
+chrome.inputMethodPrivate.getInputMethods = function(callback) {};
+
+/**
+ * Gets the current input method.
+ * @param {function(string):void} callback Callback which is called with the
+ *     current input method.
+ * @see https://developer.chrome.com/extensions/inputMethodPrivate#method-getCurrentInputMethod
+ */
+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.
+ * @see https://developer.chrome.com/extensions/inputMethodPrivate#method-setCurrentInputMethod
+ */
+chrome.inputMethodPrivate.setCurrentInputMethod = function(inputMethodId, 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.
+ * @see https://developer.chrome.com/extensions/inputMethodPrivate#method-fetchAllDictionaryWords
+ */
+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.
+ * @see https://developer.chrome.com/extensions/inputMethodPrivate#method-addWordToDictionary
+ */
+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.
+ * @see https://developer.chrome.com/extensions/inputMethodPrivate#method-getEncryptSyncEnabled
+ */
+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.
+ * @see https://developer.chrome.com/extensions/inputMethodPrivate#method-setXkbLayout
+ */
+chrome.inputMethodPrivate.setXkbLayout = function(xkb_name, callback) {};
+
+/**
+ * Fired when the input method is changed.
+ * @type {!ChromeEvent}
+ * @see https://developer.chrome.com/extensions/inputMethodPrivate#event-onChanged
+ */
+chrome.inputMethodPrivate.onChanged;
+
+/**
+ * Fired when the composition bounds or cursor bounds are changed.
+ * @type {!ChromeEvent}
+ * @see https://developer.chrome.com/extensions/inputMethodPrivate#event-onCompositionBoundsChanged
+ */
+chrome.inputMethodPrivate.onCompositionBoundsChanged;
+
+/**
+ * Fired when the custom spelling dictionary is loaded.
+ * @type {!ChromeEvent}
+ * @see https://developer.chrome.com/extensions/inputMethodPrivate#event-onDictionaryLoaded
+ */
+chrome.inputMethodPrivate.onDictionaryLoaded;
+
+/**
+ * Fired when words are added or removed from the custom spelling dictionary.
+ * @type {!ChromeEvent}
+ * @see https://developer.chrome.com/extensions/inputMethodPrivate#event-onDictionaryChanged
+ */
+chrome.inputMethodPrivate.onDictionaryChanged;
+
+/**
+ * Fired when the IME menu is activated or deactivated.
+ * @type {!ChromeEvent}
+ * @see https://developer.chrome.com/extensions/inputMethodPrivate#event-onImeMenuActivationChanged
+ */
+chrome.inputMethodPrivate.onImeMenuActivationChanged;