Interface mozISpellCheckingEngineType

This interface represents a SpellChecker.

Hierarchy

Properties

personalDictionary

Methods

AddRef QueryInterface Release addDictionary addDirectory check loadDictionariesFromDir removeDictionary removeDirectory

Properties

personalDictionary

personalDictionary: mozIPersonalDictionary

the personal dictionary

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

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

addDictionary

  • Add a dictionary with the given language code and source URI. The URI must point to an affix file, with the ".aff" extension. The word list file must be in the same directory, with the same base name, and the ".dic" extension.

    Parameters

    • lang: string
    • file: nsIURI

    Returns void

addDirectory

  • Add dictionaries from a directory to the spell checker

    Parameters

    • dir: nsIFile

    Returns void

check

  • check a word

    Parameters

    • word: string

    Returns boolean

loadDictionariesFromDir

  • Load dictionaries from the specified dir

    Parameters

    • dir: nsIFile

    Returns void

removeDictionary

  • Remove a dictionary with the given language code and path. If the path does not match that of the current entry with the given language code, it is not removed.

    Returns

    True if the dictionary was found and removed.

    Parameters

    • lang: string
    • file: nsIURI

    Returns bool

removeDirectory

  • Remove dictionaries from a directory from the spell checker

    Parameters

    • dir: nsIFile

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc