Back to index

lightning-sunbird  0.9+nobinonly
nsIEditorSpellCheck.idl
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  *   Brett Wilson <brettw@gmail.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038  
00039 #include "nsISupports.idl"
00040 
00041 interface nsIEditor;
00042 interface nsITextServicesFilter;
00043 
00044 [scriptable, uuid(6088a862-1229-11d9-941d-c035b2e390c6)]
00045 interface nsIEditorSpellCheck : nsISupports
00046 {
00047 
00054   void          InitSpellChecker(in nsIEditor editor, in boolean enableSelectionChecking);
00055 
00063   wstring       GetNextMisspelledWord();
00064 
00074   wstring       GetSuggestedWord();
00075 
00084   boolean       CheckCurrentWord(in wstring suggestedWord);
00085 
00091   void          ReplaceWord(in wstring misspelledWord, in wstring replaceWord, in boolean allOccurrences);
00092 
00097   void          IgnoreWordAllOccurrences(in wstring word);
00098 
00106   void          GetPersonalDictionary();
00107 
00113   wstring       GetPersonalDictionaryWord();
00114 
00120   void          AddWordToDictionary(in wstring word);
00121 
00127   void          RemoveWordFromDictionary(in wstring word);
00128 
00135   void          GetDictionaryList([array, size_is(count)] out wstring dictionaryList, out PRUint32 count);
00136 
00140   wstring       GetCurrentDictionary();
00141 
00145   void          SetCurrentDictionary(in wstring dictionary);
00146 
00155   void          UninitSpellChecker();
00156 
00164   void          setFilter(in nsITextServicesFilter filter);
00165 
00175   boolean       CheckCurrentWordNoSuggest(in wstring suggestedWord);
00176 
00177 };
00178 
00183 [scriptable, uuid(0455cf88-c679-40c3-8e9f-ff4554ee9559)]
00184 interface nsIEditorSpellCheck_MOZILLA_1_8_BRANCH : nsIEditorSpellCheck
00185 {
00190   boolean       CanSpellCheck();
00191 
00198   void saveDefaultDictionary();
00199 };