Back to index

lightning-sunbird  0.9+nobinonly
nsISpellChecker.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsISpellChecker_h__
00039 #define nsISpellChecker_h__
00040 
00041 #include "nsISupports.h"
00042 
00043 #define NS_SPELLCHECKER_CONTRACTID "@mozilla.org/spellchecker;1"
00044 
00045 #define NS_ISPELLCHECKER_IID                    \
00046 { /* E75AC48C-E948-452E-8DB3-30FEE29FE3D2 */    \
00047 0xe75ac48c, 0xe948, 0x452e, \
00048   { 0x8d, 0xb3, 0x30, 0xfe, 0xe2, 0x9f, 0xe3, 0xd2 } }
00049 
00050 class nsITextServicesDocument;
00051 class nsString;
00052 class nsStringArray;
00053 
00057 class nsISpellChecker  : public nsISupports{
00058 public:
00059 
00060   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISPELLCHECKER_IID)
00061 
00062   
00068   NS_IMETHOD SetDocument(nsITextServicesDocument *aDoc, PRBool aFromStartofDoc) = 0;
00069 
00076   NS_IMETHOD NextMisspelledWord(nsAString &aWord, nsStringArray *aSuggestions) = 0;
00077 
00086   NS_IMETHOD CheckWord(const nsAString &aWord, PRBool *aIsMisspelled, nsStringArray *aSuggestions) = 0;
00087 
00096   NS_IMETHOD Replace(const nsAString &aOldWord, const nsAString &aNewWord, PRBool aAllOccurrences) = 0;
00097 
00102   NS_IMETHOD IgnoreAll(const nsAString &aWord) = 0;
00103 
00108   NS_IMETHOD AddWordToPersonalDictionary(const nsAString &aWord) = 0;
00109 
00114   NS_IMETHOD RemoveWordFromPersonalDictionary(const nsAString &aWord) = 0;
00115 
00121   NS_IMETHOD GetPersonalDictionary(nsStringArray *aWordList) = 0;
00122 
00132   NS_IMETHOD GetDictionaryList(nsStringArray *aDictionaryList) = 0;
00133 
00140   NS_IMETHOD GetCurrentDictionary(nsAString &aDictionary) = 0;
00141 
00147   NS_IMETHOD SetCurrentDictionary(const nsAString &aDictionary) = 0;
00148 };
00149 
00150 #endif // nsISpellChecker_h__
00151