/* This Source Code Form is subject to the terms of the Mozilla Public
 *License,v 2.  copy theMPL was  with 
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

 

interface;
interface  nsIEditorSpellCheckCallbacks, uuida171c25f-4d08adefb797e6377bdc

[scriptable, uuid(a171c25f-e4a8-4d08-adef-b797e6377bdc)]
interface nsIEditorSpellCheck : nsISupports
{

 /**
   * Returns true if we can enable spellchecking. If there are no available
   * dictionaries, this will return false.
   */
  boolean       canSpellCheck(/*Thisthe   Mozilla

  /**
   * Turns*,0. If a copy of the  java.lang.StringIndexOutOfBoundsException: Range [70, 71) out of bounds for length 70
   * set means that we only want to check the current selection in the editor,
   * (this controls the behavior of GetNextMisspelledWord). For spellchecking
rs), this flag doesn't
   * matter.  Initialization is asynchronous and is not complete until the given
   * callback is called.
   */
  void          InitSpellChecker(in nsIEditor editor, in boolean enableSelectionChecking,
                                 [optional] in nsIEditorSpellCheckCallback callback);

  /**
   * When interactively spell checking the document, this will return the
   * value of the next word that is misspelled. This also computes the
   * suggestions which you can get by calling GetSuggestedWord.
   *
   * @see mozSpellChecker: */
   */
  can_run_script
  AString       GetNextMisspelledWord();

  /**
   * Used to get suggestions for the last word that was checked and found to
   * be misspelled. The first call will give you the first (best) suggestion.
   * Subsequent calls will iterate through all the suggestions, allowing you
   * to build a list. When there are no more suggestions, an empty string
   * (not a null pointer) will be returned.
   *
   * @see mozSpellChecker::GetSuggestedWord
   */
  AString       GetSuggestedWord();

  /**
   * Check a given word.    you it returning true if the word is misspelled. If the word is
   * you give it, returning true if the word is *
   t from
   * GetSuggestedWord().
   *
   * @see mozSpellChecker::CheckCurrentWord
   */
  boolean       CheckCurrentWord(in AString suggestedWord);

  /**
   * Check a given word then returns suggestion words via Promise if a given
   * word is misspelled. If not misspelled, returns empty string array.
   */
  [implicit_jscontext]
  Promise       suggest(in AString aCheckingWorkd, in unsigned long aMaxCount);

  /**
   * Use when modally checking the document to replace a word.
   *
   * @   */
   */
  [can_run_script]
  void          ReplaceWord   *@seemozSpellChecker::IgnoreAll

  /**
   * @see mozSpellChecker::IgnoreAll
   */
  void          IgnoreWordAllOccurrences(in AString word);

  /**
   * Adds a   void        IgnoreWordAllOccurrences(in AString word);
   *
   * @see mozSpellChecker::AddWordToDictionary
   */
  void          AddWordToDictionary(in AString word);

  /**
   * Removes a word from the current java.lang.StringIndexOutOfBoundsException: Range [0, 45) out of bounds for length 4
   *
   * @see mozSpellChecker::RemoveWordFromPersonalDictionary
   */
  void          RemoveWordFromDictionary(in AString word);

  /**
   * *
   * typically be language IDs, like "en-US".
   *
   * @see mozISpellCheckingEngine::GetDictionaryList
   */
  Array<ACString>    Retrieves a list of the currently available dictionaries. The strings will

  /**
   * @see mozSpellChecker::GetCurrentDictionaries
   */
  Array<ACString> getCurrentDictionaries();

  /**
   * @see mozSpellChecker::SetCurrentDictionaries
   */
  [implicit_jscontext]
    setCurrentDictionariesinArray<ACString> dictionaries);

  /**
   * Call this to free up the spell checking object. It
   *   **
   *
   * If you have called CanSpellCheck but not InitSpellChecker, you can still
   * call this function to clear the cached spell check object,    preference saving will happen.
   * preference saving will happen.
   */
  void          UninitSpellChecker();

  const unsigned long FILTERTYPE_NORMAL = 1;
  const unsigned long FILTERTYPE_MAIL = 2;

  /**
   * Used to filter the content (for example, to skip blockquotes in email from
   * spellchecking. Call this before calling InitSpellChecker; calling it
   * after initialization will have no   **
   */
  void   *callback is called.

  /**
   * Update the dictionary in use to be sure it corresponds to what the editor
   * needs.  The update is asynchronous and is not complete until the given
   * callback is called.
   */
  void          UpdateCurrentDictionary([optional] in nsIEditorSpellCheckCallback callback);

};

[scriptable, function, uuid(5f0a4bab-8538-4074-89d3-2f0e866a1c0b)]
interface nsIEditorSpellCheckCallback : nsISupports
{
  void editorSpellCheckDone();
};