Public Member Functions | Public Attributes

mozIPersonalDictionary Interface Reference

This interface represents a Personal Dictionary. More...

import "mozIPersonalDictionary.idl";

Collaboration diagram for mozIPersonalDictionary:

List of all members.

Public Member Functions

void load ()
 Load the dictionary.
void save ()
 Save the dictionary.
boolean check (in wstring word, in wstring lang)
 Check a unicode string.
void addWord (in wstring word, in wstring lang)
 Add a word to the personal dictionary.
void removeWord (in wstring word, in wstring lang)
 Remove a word from the personal dictionary.
void ignoreWord (in wstring word)
 Add a word to the ignore all list.
void endSession ()
 Clear the ignore list.
void addCorrection (in wstring word, in wstring correction, in wstring lang)
 These three functions are here in case we want to store previous misspellings and return them at the head of the misspell list.
void removeCorrection (in wstring word, in wstring correction, in wstring lang)
 Remove a misspelling from the list of corrections.
void getCorrection (in wstring word,[array, size_is(count)] out wstring words, out PRUint32 count)
 Get a list of previous corrections for the word.

Public Attributes

readonly attribute
nsIStringEnumerator 
wordList
 Get the (lexicographically sorted) list of words.

Detailed Description

This interface represents a Personal Dictionary.


Member Function Documentation

void mozIPersonalDictionary::addCorrection ( in wstring  word,
in wstring  correction,
in wstring  lang 
)

These three functions are here in case we want to store previous misspellings and return them at the head of the misspell list.

Add a misspelling to the list of corrections

void mozIPersonalDictionary::addWord ( in wstring  word,
in wstring  lang 
)

Add a word to the personal dictionary.

boolean mozIPersonalDictionary::check ( in wstring  word,
in wstring  lang 
)

Check a unicode string.

void mozIPersonalDictionary::endSession (  ) 

Clear the ignore list.

void mozIPersonalDictionary::getCorrection ( in wstring  word,
[array, size_is(count)] out wstring  words,
out PRUint32  count 
)

Get a list of previous corrections for the word.

void mozIPersonalDictionary::ignoreWord ( in wstring  word  ) 

Add a word to the ignore all list.

void mozIPersonalDictionary::load (  ) 

Load the dictionary.

void mozIPersonalDictionary::removeCorrection ( in wstring  word,
in wstring  correction,
in wstring  lang 
)

Remove a misspelling from the list of corrections.

void mozIPersonalDictionary::removeWord ( in wstring  word,
in wstring  lang 
)

Remove a word from the personal dictionary.

void mozIPersonalDictionary::save (  ) 

Save the dictionary.


Member Data Documentation

Get the (lexicographically sorted) list of words.


The documentation for this interface was generated from the following file: