Linux Mac OSX Windows

Implemented by


  
[scriptable, uuid(90c93610-c116-44ab-9793-62dccb9f43ce)]
interface nsIEditorSpellCheck : nsISupports

Methods

 Adds a word to the current personal dictionary.

 @see nsISpellChecker::AddWordToDictionary
void AddWordToDictionary(in wstring word)
 Returns true if we can enable spellchecking. If there are no available
 dictionaries, this will return false.
boolean canSpellCheck()
 Check a given word. In spite of the name, this function checks the word
 you give it, returning true if the word is misspelled. If the word is
 misspelled, it will compute the suggestions which you can get from
 GetSuggestedWord().

 @see nsISpellChecker::CheckCurrentWord
boolean CheckCurrentWord(in wstring suggestedWord)
 Like CheckCurrentWord, checks the word you give it, returning true if it's
 misspelled. This is faster than CheckCurrentWord because it does not
 compute any suggestions.

 Watch out: this does not clear any suggestions left over from previous
 calls to CheckCurrentWord, so there may be suggestions, but they will be
 invalid.
boolean CheckCurrentWordNoSuggest(in wstring suggestedWord)
 @see nsISpellChecker::GetCurrentDictionary
wstring GetCurrentDictionary()
 Retrieves a list of the currently available dictionaries. The strings will
 typically be language IDs, like "en-US".

 @see mozISpellCheckingEngine::GetDictionaryList
void GetDictionaryList([array, size_is(count)] out wstring dictionaryList, out PRUint32 count)
 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 nsISpellChecker::GetNextMisspelledWord
wstring GetNextMisspelledWord()
 Fills an internal list of words added to the personal dictionary. These
 words can be retrieved using GetPersonalDictionaryWord()

 @see nsISpellChecker::GetPersonalDictionary
 @see GetPersonalDictionaryWord
void GetPersonalDictionary()
 Used after you call GetPersonalDictionary() to iterate through all the
 words added to the personal dictionary. Will return the empty string when
 there are no more words.
wstring GetPersonalDictionaryWord()
 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 nsISpellChecker::GetSuggestedWord
wstring GetSuggestedWord()
 @see nsISpellChecker::IgnoreAll
void IgnoreWordAllOccurrences(in wstring word)
 Turns on the spell checker for the given editor. enableSelectionChecking
 set means that we only want to check the current selection in the editor,
 (this controls the behavior of GetNextMisspelledWord). For spellchecking
 clients with no modal UI (such as inline spellcheckers), this flag doesn't
 matter
void InitSpellChecker(in nsIEditor editor, in boolean enableSelectionChecking)
 Removes a word from the current personal dictionary.

 @see nsISpellChecker::RemoveWordFromPersonalDictionary
void RemoveWordFromDictionary(in wstring word)
 Use when modally checking the document to replace a word.

 @see nsISpellChecker::CheckCurrentWord
void ReplaceWord(in wstring misspelledWord, in wstring replaceWord, in boolean allOccurrences)
 Call to save the currently selected dictionary as the default. The
 function UninitSpellChecker will also do this, but that function may not
 be called in some situations. This function allows the caller to force the
 default right now.
void saveDefaultDictionary()
 @see nsISpellChecker::SetCurrentDictionary
void SetCurrentDictionary(in wstring dictionary)
 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 effect.

 @see nsITextServicesDocument::setFilter
void setFilter(in nsITextServicesFilter filter)
 Call this to free up the spell checking object. It will also save the
 current selected language as the default for future use.

 If you have called CanSpellCheck but not InitSpellChecker, you can still
 call this function to clear the cached spell check object, and no
 preference saving will happen.
void UninitSpellChecker()