third_party/closure_compiler/externs/language_settings_private.js

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