SpellingChecker REALbasic Plugin |
|
SpellingChecker Class
SpellChecker is a REALbasic plugin to check spelling by using the spell checking from Cocoa framework on MacOS X .
NotesThe Plugin is OS X only since it is using MacOS X Cocoa Framework to do the work. The plugin has MacOS PPC, Windows and Linux stubs that do nothing. Those stubs do enable development for MacOS X on the other platforms.
Object
SpellingChecker
class SpellingChecker
Constructors
SpellingChecker | Use this constructor to construct a instance of the SpellChecker class. This constructor takes in the location of the SpellingChecker.bundle. |
Properties
CurrentIgnoreListID | Use this property to let the SpellingChecker class use a custom ignore list. |
Length | When a misspelled word is found then this property will contain the length of the word. |
MisspelledWord | When a misspelled word is found then this property will contain the word. |
Start | When a misspelled word is found then this property will contain the starting location of the word. |
Methods
Change | Once a word faulty word has been found then this method can be called to change the faulty word. |
Check | Call this function to check spelling of a string. |
CloseIgnoreList | Use this function to destroy a ignore list. |
GetGetSuggestions | Once a word faulty word has been found then this function can be called to get a list of suggested words from the SpellingChecker. |
GetIgnoredWords | Use this function to retrieve the ignore list from the currently selected ignore list context. |
GetUniqueIgnoreListID | Use this function to create a unique ignore list id. Unique Ignore list ID's are needed when creating a ignore list for each document in your application. |
Ignore | Once a word faulty word has been found then this method can be called to add the faulty word to the currently selected Ignore list.
After calling ignore then if it is desired to continue spell checking then call the Check function again. (See the example project for better reference). |
SetIgnoredWords | Use this method to restore a saved ignore list to the currently selected ignore list context. |
Supported Platforms:
MacOS X PPC - (Mach-O)MacOS X Universal Binary (Mach-O)MacOS X Cocoa Universal Binary (Mach-O)Unsupported Platforms:
Win32 - WindowsLinux x86