Interface mozIPersonalDictionaryType

This interface represents a Personal Dictionary.

Hierarchy

Properties

wordList

Methods

AddRef QueryInterface Release addWord check endSession ignoreWord load removeWord save

Properties

Readonly wordList

wordList: nsIStringEnumerator

Get the (lexicographically sorted) list of words

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

addWord

  • Add a word to the personal dictionary

    Parameters

    • word: string

    Returns void

check

  • Check a unicode string

    Parameters

    • word: string

    Returns boolean

endSession

  • Clear the ignore list

    Returns void

ignoreWord

  • Add a word to the ignore all list

    Parameters

    • word: string

    Returns void

load

  • Load the dictionary

    Returns void

removeWord

  • Remove a word from the personal dictionary

    Parameters

    • word: string

    Returns void

save

  • Save the dictionary

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc