Interface nsIEditorSpellCheckType

Hierarchy

Methods

AddRef AddWordToDictionary CheckCurrentWord GetNextMisspelledWord GetPersonalDictionary GetPersonalDictionaryWord GetSuggestedWord IgnoreWordAllOccurrences InitSpellChecker QueryInterface Release RemoveWordFromDictionary ReplaceWord UninitSpellChecker UpdateCurrentDictionary canSpellCheck setCurrentDictionaries setFilterType suggest

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

AddWordToDictionary

  • Adds a word to the current personal dictionary.

    See

    mozSpellChecker::AddWordToDictionary

    Parameters

    • word: string

    Returns void

CheckCurrentWord

  • 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

    mozSpellChecker::CheckCurrentWord

    Parameters

    • suggestedWord: string

    Returns boolean

GetNextMisspelledWord

  • 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::GetNextMisspelledWord

    Returns string

GetPersonalDictionary

  • Fills an internal list of words added to the personal dictionary. These words can be retrieved using GetPersonalDictionaryWord()

    See

    • mozSpellChecker::GetPersonalDictionary
    • GetPersonalDictionaryWord

    Returns void

GetPersonalDictionaryWord

  • 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.

    Returns string

GetSuggestedWord

  • 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

    Returns string

IgnoreWordAllOccurrences

  • See

    mozSpellChecker::IgnoreAll

    Parameters

    • word: string

    Returns void

InitSpellChecker

  • 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. Initialization is asynchronous and is not complete until the given callback is called.

    Parameters

    • editor: nsIEditor
    • enableSelectionChecking: boolean
    • callback: nsIEditorSpellCheckCallback

    Returns void

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

RemoveWordFromDictionary

  • Removes a word from the current personal dictionary.

    See

    mozSpellChecker::RemoveWordFromPersonalDictionary

    Parameters

    • word: string

    Returns void

ReplaceWord

  • Use when modally checking the document to replace a word.

    See

    mozSpellChecker::CheckCurrentWord

    Parameters

    • misspelledWord: string
    • replaceWord: string
    • allOccurrences: boolean

    Returns void

UninitSpellChecker

  • 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.

    Returns void

UpdateCurrentDictionary

  • 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.

    Parameters

    • callback: nsIEditorSpellCheckCallback

    Returns void

canSpellCheck

  • Returns true if we can enable spellchecking. If there are no available dictionaries, this will return false.

    Returns boolean

setCurrentDictionaries

  • See

    mozSpellChecker::SetCurrentDictionaries

    Parameters

    • dictionaries: invalid

    Returns any

setFilterType

  • 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.

    Parameters

    • filterType: number

    Returns void

suggest

  • Check a given word then returns suggestion words via Promise if a given word is misspelled. If not misspelled, returns empty string array.

    Parameters

    • aCheckingWorkd: string
    • aMaxCount: number

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc