Modify languageSettingsPrivate IDL and flesh out stub implementation

third_party/closure_compiler/externs/language_settings_private.js

-language_settings_private_externs.js

[Dan Beam, 2015/08/14 17:51:57]

@_@

[michaelpg, 2015/08/14 17:56:09]

Don't @_@ at me, @_@ at compiler.py --generator=externs.

-
 // Copyright 2015 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.
 
 /** @fileoverview Externs generated from namespace: languageSettingsPrivate */
 
 /**
  * @const
  */
 chrome.languageSettingsPrivate = {};
 
 /**
- * @enum {string}
- * @see https://developer.chrome.com/extensions/languageSettingsPrivate#type-DownloadStatus
- */
-chrome.languageSettingsPrivate.DownloadStatus = {
-  DOWNLOADED: 'DOWNLOADED',
-  DOWNLOADING: 'DOWNLOADING',
-  FAILURE: 'FAILURE',
-};
-
-/**
  * @typedef {{
  *   code: string,
  *   displayName: string,
  *   nativeDisplayName: string,
- *   rtl: (boolean|undefined),
+ *   displayNameRTL: (boolean|undefined),
  *   supportsUI: (boolean|undefined),
- *   supportsSpellCheck: (boolean|undefined),
+ *   supportsSpellcheck: (boolean|undefined),
  *   supportsTranslate: (boolean|undefined)
  * }}
  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#type-Language
  */
 var Language;
 
 /**
  * @typedef {{
  *   languageCode: string,
- *   status: !chrome.languageSettingsPrivate.DownloadStatus
+ *   isReady: boolean,
+ *   isDownloading: (boolean|undefined),
+ *   downloadFailed: (boolean|undefined)
  * }}
- * @see https://developer.chrome.com/extensions/languageSettingsPrivate#type-SpellCheckDictionaryStatus
+ * @see https://developer.chrome.com/extensions/languageSettingsPrivate#type-SpellcheckDictionaryStatus
  */
-var SpellCheckDictionaryStatus;
+var SpellcheckDictionaryStatus;
 
 /**
  * @typedef {{
  *   id: string,
  *   displayName: string,
  *   languageCodes: !Array<string>,
  *   enabled: boolean
  * }}
  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#type-InputMethod
  */
@@ skipping 18 matching lines @@
 
 /**
  * Sets the accepted languages, used to decide which languages to translate,
  * generate the Accept-Language header, etc.
  * @param {!Array<string>} languageCodes
  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-setLanguageList
  */
 chrome.languageSettingsPrivate.setLanguageList = function(languageCodes) {};
 
 /**
- * Gets the current status of the spell check dictionary.
- * @param {function(SpellCheckDictionaryStatus):void} callback
- * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-getSpellCheckDictionaryStatus
+ * Gets the current status of the chosen spell check dictionaries.
+ * @param {function(!Array<SpellcheckDictionaryStatus>):void} callback
+ * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-getSpellcheckDictionaryStatuses
  */
-chrome.languageSettingsPrivate.getSpellCheckDictionaryStatus = function(callback) {};
+chrome.languageSettingsPrivate.getSpellcheckDictionaryStatuses = function(callback) {};
 
 /**
  * Gets the custom spell check words.
  * @param {function(!Array<string>):void} callback
- * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-getSpellCheckWords
+ * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-getSpellcheckWords
  */
-chrome.languageSettingsPrivate.getSpellCheckWords = function(callback) {};
+chrome.languageSettingsPrivate.getSpellcheckWords = function(callback) {};
 
 /**
  * Gets the translate target language (in most cases, the display locale).
  * @param {function(string):void} callback
  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-getTranslateTargetLanguage
  */
 chrome.languageSettingsPrivate.getTranslateTargetLanguage = function(callback) {};
 
 /**
  * Gets all supported input methods, including IMEs. Chrome OS only.
@@ skipping 12 matching lines @@
 
 /**
  * Removes the input method from the current user's list of enabled input
  * methods, disabling the input method for the current user. Chrome OS only.
  * @param {string} inputMethodId
  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#method-removeInputMethod
  */
 chrome.languageSettingsPrivate.removeInputMethod = function(inputMethodId) {};
 
 /**
- * Called when the language used for spell checking changes or the dictionary
- * download status changes.
+ * Called when the pref for the dictionaries used for spell checking changes or
+ * the status of one of the spell check dictionaries changes.
  * @type {!ChromeEvent}
- * @see https://developer.chrome.com/extensions/languageSettingsPrivate#event-onSpellCheckDictionaryChanged
+ * @see https://developer.chrome.com/extensions/languageSettingsPrivate#event-onSpellcheckDictionariesChanged
  */
-chrome.languageSettingsPrivate.onSpellCheckDictionaryChanged;
+chrome.languageSettingsPrivate.onSpellcheckDictionariesChanged;
+
+/**
+ * Called when words are added to and/or removed from the custom spell check
+ * dictionary.
+ * @type {!ChromeEvent}
+ * @see https://developer.chrome.com/extensions/languageSettingsPrivate#event-onCustomDictionaryChanged
+ */
+chrome.languageSettingsPrivate.onCustomDictionaryChanged;
 
 /**
  * Called when an input method is added.
  * @type {!ChromeEvent}
  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#event-onInputMethodAdded
  */
 chrome.languageSettingsPrivate.onInputMethodAdded;
 
 /**
  * Called when an input method is removed.
  * @type {!ChromeEvent}
  * @see https://developer.chrome.com/extensions/languageSettingsPrivate#event-onInputMethodRemoved
  */
 chrome.languageSettingsPrivate.onInputMethodRemoved;