Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIEditorSpellCheck_MOZILLA_1_8_BRANCH Interface Reference

This contains enhancements made to this interface on the trunk. More...

import "nsIEditorSpellCheck.idl";

Inheritance diagram for nsIEditorSpellCheck_MOZILLA_1_8_BRANCH:
Inheritance graph
[legend]
Collaboration diagram for nsIEditorSpellCheck_MOZILLA_1_8_BRANCH:
Collaboration graph
[legend]

List of all members.

Public Member Functions

boolean CanSpellCheck ()
 Returns true if we can enable spellchecking.
void saveDefaultDictionary ()
 Call to save the currently selected dictionary as the default.
void InitSpellChecker (in nsIEditor editor, in boolean enableSelectionChecking)
 Turns on the spell checker for the given editor.
wstring GetNextMisspelledWord ()
 When interactively spell checking the document, this will return the value of the next word that is misspelled.
wstring GetSuggestedWord ()
 Used to get suggestions for the last word that was checked and found to be misspelled.
boolean CheckCurrentWord (in wstring suggestedWord)
 Check a given word.
void ReplaceWord (in wstring misspelledWord, in wstring replaceWord, in boolean allOccurrences)
 Use when modaly checking the document to replace a word.
void IgnoreWordAllOccurrences (in wstring word)
void GetPersonalDictionary ()
 Fills an internal list of words added to the personal dictionary.
wstring GetPersonalDictionaryWord ()
 Used after you call GetPersonalDictionary() to iterate through all the words added to the personal dictionary.
void AddWordToDictionary (in wstring word)
 Adds a word to the current personal dictionary.
void RemoveWordFromDictionary (in wstring word)
 Removes a word from the current personal dictionary.
void GetDictionaryList ([array, size_is(count)] out wstring dictionaryList, out PRUint32 count)
 Retrieves a list of the currently available dictionaries.
wstring GetCurrentDictionary ()
void SetCurrentDictionary (in wstring dictionary)
void UninitSpellChecker ()
 Call this to free up the spell checking object.
void setFilter (in nsITextServicesFilter filter)
 Used to filter the content (for example, to skip blockquotes in email from spellchecking.
boolean CheckCurrentWordNoSuggest (in wstring suggestedWord)
 Like CheckCurrentWord, checks the word you give it, returning true if it's misspelled.

Detailed Description

This contains enhancements made to this interface on the trunk.

Here, it is on a separate interface to avoid changing interfaces on the branch.

Definition at line 184 of file nsIEditorSpellCheck.idl.


Member Function Documentation

void nsIEditorSpellCheck::AddWordToDictionary ( in wstring  word) [inherited]

Adds a word to the current personal dictionary.

See also:
nsISpellChecker::AddWordToDictionary

Returns true if we can enable spellchecking.

If there are no available dictionaries, this will return false.

boolean nsIEditorSpellCheck::CheckCurrentWord ( in wstring  suggestedWord) [inherited]

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 also:
nsISpellChecker::CheckCurrentWord
boolean nsIEditorSpellCheck::CheckCurrentWordNoSuggest ( in wstring  suggestedWord) [inherited]

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.

void nsIEditorSpellCheck::GetDictionaryList ( [array, size_is(count)] out wstring  dictionaryList,
out PRUint32  count 
) [inherited]

Retrieves a list of the currently available dictionaries.

The strings will typically be language IDs, like "en-US".

See also:
mozISpellCheckingEngine::GetDictionaryList

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 also:
nsISpellChecker::GetNextMisspelledWord

Fills an internal list of words added to the personal dictionary.

These words can be retrieved using GetPersonalDictionaryWord()

See also:
nsISpellChecker::GetPersonalDictionary
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.

wstring nsIEditorSpellCheck::GetSuggestedWord ( ) [inherited]

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 will be returned.

See also:
nsISpellChecker::GetSuggestedWord
void nsIEditorSpellCheck::IgnoreWordAllOccurrences ( in wstring  word) [inherited]
void nsIEditorSpellCheck::InitSpellChecker ( in nsIEditor  editor,
in boolean  enableSelectionChecking 
) [inherited]

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 inline spellchecking, we don't care about this.

void nsIEditorSpellCheck::RemoveWordFromDictionary ( in wstring  word) [inherited]

Removes a word from the current personal dictionary.

See also:
nsISpellChecker::RemoveWordFromPersonalDictionary
void nsIEditorSpellCheck::ReplaceWord ( in wstring  misspelledWord,
in wstring  replaceWord,
in boolean  allOccurrences 
) [inherited]

Use when modaly checking the document to replace a word.

See also:
nsISpellChecker::CheckCurrentWord

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 nsIEditorSpellCheck::SetCurrentDictionary ( in wstring  dictionary) [inherited]

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 also:
nsITextServicesDocument::setFilter

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.


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