Modify languageSettingsPrivate IDL and flesh out stub implementation

chrome/common/extensions/api/language_settings_private.idl

 // 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.
 
 // Use the <code>chrome.languageSettingsPrivate</code> API to get or change
 // language and input method settings.
 namespace languageSettingsPrivate {
-  // Status of a spell check dictionary download.
-  enum DownloadStatus { DOWNLOADED, DOWNLOADING, FAILURE };
-
   dictionary Language {
     // The unique code identifying the language.
     DOMString code;
 
     // The name of the language, in the current UI language.
     DOMString displayName;
 
     // The name of the language as it is in its own language.
     DOMString nativeDisplayName;
 
-    // Whether the directionality is RTL. Defaults to false.
+    // Whether the display name has RTL. Defaults to false.
     boolean? rtl;

[stevenjb, 2015/08/10 15:57:20]

As long as we are renaming things, I would rename this something like
displayNameRTL.

[michaelpg, 2015/08/10 22:35:06]

Done.

 
     // Whether the UI can be displayed in this language. Defaults to false.
-    boolean? supportsUI;
+    boolean? supportsUi;

[stevenjb, 2015/08/10 15:57:20]

I would leave this UI. With a TLA like RTL I could be convinced that Rtl is OK,
but with UI it looks really strange (and UI is way more common than Ui in our
existing JS).

[not at google - send to devlin, 2015/08/10 17:01:04]

+1 and I don't see the point of this little bit of churn anyway.

[michaelpg, 2015/08/10 22:35:06]

Done. I guess I was thinking of the C++ naming guidelines.

 
     // Whether this language can be used for spell checking. Defaults to false.
-    boolean? supportsSpellCheck;
+    boolean? supportsSpellcheck;
 
     // Whether this language has translations for the current target language.
     // Defaults to false.
     boolean? supportsTranslate;
   };
 
-  dictionary SpellCheckDictionaryStatus {
+  dictionary SpellcheckDictionaryStatus {
     // The language code of the dictionary that the status describes.
     DOMString languageCode;
 
-    // The download status of the dictionary.
-    DownloadStatus status;
+    // Whether the dictionary is ready (has been loaded from disk or
+    // successfully downloaded).
+    boolean isReady;
+
+    // Whether the dictionary is being downloaded. Defaults to false.
+    boolean? isDownloading;
+
+    // Whether the dictionary download failed. Defaults to false.
+    boolean? downloadFailed;
   };
 
   dictionary InputMethod {
     // The ID of the input method descriptor.
     DOMString id;
 
     // The human-readable name of the input method.
     DOMString displayName;
 
     // The language codes this input method supports.
     DOMString[] languageCodes;
 
     // True if the input method is enabled.
     boolean enabled;
   };
 
   dictionary InputMethodLists {
     // The list of built-in input methods.
     InputMethod[] inputMethods;
 
     // The list of component extension input methods.
     InputMethod[] componentExtensionIMEs;
 
     // The list of third-party extension input methods.
     InputMethod[] thirdPartyExtensionIMEs;
   };
 
   callback GetLanguageListCallback = void (Language[] languages);
   callback GetInputMethodListsCallback = void (InputMethodLists lists);
-  callback GetSpellCheckWordsCallback = void (DOMString[] words);
+  callback GetSpellcheckWordsCallback = void (DOMString[] words);
   callback GetTranslateTargetLanguageCallback = void (DOMString languageCode);
-  callback GetSpellCheckDictionaryStatusCallback =
-      void (SpellCheckDictionaryStatus status);
+  callback GetSpellcheckDictionaryStatusesCallback =
+      void (SpellcheckDictionaryStatus[] status);
   callback InputMethodAddedRemovedCallback = void (DOMString inputMethodId);

[stevenjb, 2015/08/10 15:57:20]

Unused

[michaelpg, 2015/08/10 22:35:06]

Removed.

 
   interface Functions {
     // Gets languages available for translate, spell checking, input and locale.
     static void getLanguageList(GetLanguageListCallback callback);
 
     // Sets the accepted languages, used to decide which languages to translate,
     // generate the Accept-Language header, etc.
     static void setLanguageList(DOMString[] languageCodes);
 
-    // Gets the current status of the spell check dictionary.
-    static void getSpellCheckDictionaryStatus(
-        GetSpellCheckDictionaryStatusCallback callback);
+    // Gets the current status of the chosen spell check dictionaries.
+    static void getSpellcheckDictionaryStatuses(
+        GetSpellcheckDictionaryStatusesCallback callback);
 
     // Gets the custom spell check words.
-    static void getSpellCheckWords(GetSpellCheckWordsCallback callback);
+    static void getSpellcheckWords(GetSpellcheckWordsCallback callback);
 
     // Gets the translate target language (in most cases, the display locale).
     static void getTranslateTargetLanguage(
         GetTranslateTargetLanguageCallback callback);
 
     // Gets all supported input methods, including IMEs. Chrome OS only.
     static void getInputMethodLists(GetInputMethodListsCallback callback);
 
     // Adds the input method to the current user's list of enabled input
     // methods, enabling the input method for the current user. Chrome OS only.
     static void addInputMethod(DOMString inputMethodId);
 
     // 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.
     static void removeInputMethod(DOMString inputMethodId);
   };
 
   interface Events {
-    // Called when the language used for spell checking changes or the
-    // dictionary download status changes.
-    static void onSpellCheckDictionaryChanged(
-        GetSpellCheckDictionaryStatusCallback callback);
+    // Called when the pref for the dictionaries used for spell checking changes
+    // or the status of one of the spell check dictionaries changes.
+    static void onSpellcheckDictionariesChanged(
+        SpellcheckDictionaryStatus[] statuses);
+
+    // Called when words are added to and/or removed from the custom spell check
+    // dictionary.
+    static void onCustomDictionaryChanged(
+        DOMString[] wordsAdded, DOMString[] wordsRemoved);
 
     // Called when an input method is added.
-    static void onInputMethodAdded(
-        InputMethodAddedRemovedCallback callback);
+    static void onInputMethodAdded(DOMString inputMethodId);
 
     // Called when an input method is removed.
-    static void onInputMethodRemoved(
-        InputMethodAddedRemovedCallback callback);
+    static void onInputMethodRemoved(DOMString inputMethodId);
   };
 };