third_party/closure_compiler/externs/language_settings_private.js

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /** @fileoverview Externs generated from namespace: languageSettingsPrivate */
   6
   7 /**
   8  * @const
   9  */
  10 chrome.languageSettingsPrivate = {};
  11
  12 /**
  13  * @typedef {{
  14  *   code: string,
  15  *   displayName: string,
  16  *   nativeDisplayName: string,
  17  *   displayNameRTL: (boolean|undefined),
  18  *   supportsUI: (boolean|undefined),
  19  *   supportsSpellcheck: (boolean|undefined),
  20  *   supportsTranslate: (boolean|undefined)
  21  * }}
  22  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#type-Language
  23  */
  24 var Language;
  25
  26 /**
  27  * @typedef {{
  28  *   languageCode: string,
  29  *   isReady: boolean,
  30  *   isDownloading: (boolean|undefined),
  31  *   downloadFailed: (boolean|undefined)
  32  * }}
  33  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#type-SpellcheckDictionaryStatus
  34  */
  35 var SpellcheckDictionaryStatus;
  36
  37 /**
  38  * @typedef {{
  39  *   id: string,
  40  *   displayName: string,
  41  *   languageCodes: !Array<string>,
  42  *   enabled: boolean
  43  * }}
  44  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#type-InputMethod
  45  */
  46 var InputMethod;
  47
  48 /**
  49  * @typedef {{
  50  *   inputMethods: !Array<InputMethod>,
  51  *   componentExtensionIMEs: !Array<InputMethod>,
  52  *   thirdPartyExtensionIMEs: !Array<InputMethod>
  53  * }}
  54  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#type-InputMethodLists
  55  */
  56 var InputMethodLists;
  57
  58 /**
  59  * Gets languages available for translate, spell checking, input and locale.
  60  * @param {function(!Array<Language>):void} callback
  61  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-getLanguageList
  62  */
  63 chrome.languageSettingsPrivate.getLanguageList = function(callback) {};
  64
  65 /**
  66  * Sets the accepted languages, used to decide which languages to translate,
  67  * generate the Accept-Language header, etc.
  68  * @param {!Array<string>} languageCodes
  69  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-setLanguageList
  70  */
  71 chrome.languageSettingsPrivate.setLanguageList = function(languageCodes) {};
  72
  73 /**
  74  * Gets the current status of the chosen spell check dictionaries.
  75  * @param {function(!Array<SpellcheckDictionaryStatus>):void} callback
  76  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-getSpellcheckDictionaryStatuses
  77  */
  78 chrome.languageSettingsPrivate.getSpellcheckDictionaryStatuses = function(callback) {};
  79
  80 /**
  81  * Gets the custom spell check words.
  82  * @param {function(!Array<string>):void} callback
  83  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-getSpellcheckWords
  84  */
  85 chrome.languageSettingsPrivate.getSpellcheckWords = function(callback) {};
  86
  87 /**
  88  * Gets the translate target language (in most cases, the display locale).
  89  * @param {function(string):void} callback
  90  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-getTranslateTargetLanguage
  91  */
  92 chrome.languageSettingsPrivate.getTranslateTargetLanguage = function(callback) {};
  93
  94 /**
  95  * Gets all supported input methods, including IMEs. Chrome OS only.
  96  * @param {function(InputMethodLists):void} callback
  97  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-getInputMethodLists
  98  */
  99 chrome.languageSettingsPrivate.getInputMethodLists = function(callback) {};
 100
 101 /**
 102  * Adds the input method to the current user's list of enabled input methods,
 103  * enabling the input method for the current user. Chrome OS only.
 104  * @param {string} inputMethodId
 105  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-addInputMethod
 106  */
 107 chrome.languageSettingsPrivate.addInputMethod = function(inputMethodId) {};
 108
 109 /**
 110  * Removes the input method from the current user's list of enabled input
 111  * methods, disabling the input method for the current user. Chrome OS only.
 112  * @param {string} inputMethodId
 113  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-removeInputMethod
 114  */
 115 chrome.languageSettingsPrivate.removeInputMethod = function(inputMethodId) {};
 116
 117 /**
 118  * Called when the pref for the dictionaries used for spell checking changes or
 119  * the status of one of the spell check dictionaries changes.
 120  * @type {!ChromeEvent}
 121  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#event-onSpellcheckDictionariesChanged
 122  */
 123 chrome.languageSettingsPrivate.onSpellcheckDictionariesChanged;
 124
 125 /**
 126  * Called when words are added to and/or removed from the custom spell check
 127  * dictionary.
 128  * @type {!ChromeEvent}
 129  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#event-onCustomDictionaryChanged
 130  */
 131 chrome.languageSettingsPrivate.onCustomDictionaryChanged;
 132
 133 /**
 134  * Called when an input method is added.
 135  * @type {!ChromeEvent}
 136  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#event-onInputMethodAdded
 137  */
 138 chrome.languageSettingsPrivate.onInputMethodAdded;
 139
 140 /**
 141  * Called when an input method is removed.
 142  * @type {!ChromeEvent}
 143  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#event-onInputMethodRemoved
 144  */
 145 chrome.languageSettingsPrivate.onInputMethodRemoved;
 146
 147