Back to index

lightning-sunbird  0.9+nobinonly
mozSpellChecker.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 Spellchecker Component.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * David Einstein.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s): David Einstein Deinst@world.std.com
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * 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 mozSpellChecker_h__
00039 #define mozSpellChecker_h__
00040 
00041 #include "nsCOMPtr.h"
00042 #include "nsISpellChecker.h"
00043 #include "nsString.h"
00044 #include "nsITextServicesDocument.h"
00045 #include "mozIPersonalDictionary.h"
00046 #include "mozISpellCheckingEngine.h"
00047 #include "nsVoidArray.h"
00048 #include "mozISpellI18NUtil.h"
00049 
00050 class mozSpellChecker : public nsISpellChecker
00051 {
00052 public:
00053   NS_DECL_ISUPPORTS
00054 
00055   mozSpellChecker();
00056   virtual ~mozSpellChecker();
00057 
00058   nsresult Init();
00059 
00060   // nsISpellChecker
00061   NS_IMETHOD SetDocument(nsITextServicesDocument *aDoc, PRBool aFromStartofDoc);
00062   NS_IMETHOD NextMisspelledWord(nsAString &aWord, nsStringArray *aSuggestions);
00063   NS_IMETHOD CheckWord(const nsAString &aWord, PRBool *aIsMisspelled, nsStringArray *aSuggestions);
00064   NS_IMETHOD Replace(const nsAString &aOldWord, const nsAString &aNewWord, PRBool aAllOccurrences);
00065   NS_IMETHOD IgnoreAll(const nsAString &aWord);
00066 
00067   NS_IMETHOD AddWordToPersonalDictionary(const nsAString &aWord);
00068   NS_IMETHOD RemoveWordFromPersonalDictionary(const nsAString &aWord);
00069   NS_IMETHOD GetPersonalDictionary(nsStringArray *aWordList);
00070 
00071   NS_IMETHOD GetDictionaryList(nsStringArray *aDictionaryList);
00072   NS_IMETHOD GetCurrentDictionary(nsAString &aDictionary);
00073   NS_IMETHOD SetCurrentDictionary(const nsAString &aDictionary);
00074 
00075 protected:
00076   nsCOMPtr<mozISpellI18NUtil> mConverter;
00077   nsCOMPtr<nsITextServicesDocument> mTsDoc;
00078   nsCOMPtr<mozIPersonalDictionary> mPersonalDictionary;
00079   nsString mDictionaryName;
00080   nsCOMPtr<mozISpellCheckingEngine>  mSpellCheckingEngine;
00081   PRBool mFromStart;
00082   nsStringArray mIgnoreList;
00083 
00084   nsresult SetupDoc(PRUint32 *outBlockOffset);
00085 
00086   nsresult GetCurrentBlockIndex(nsITextServicesDocument *aDoc, PRInt32 *outBlockIndex);
00087 };
00088 #endif // mozSpellChecker_h__