Back to index

lightning-sunbird  0.9+nobinonly
nsIInlineSpellChecker.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 Inline Spellchecking
00016  *
00017  * The Initial Developer of the Original Code is Neil Deakin.
00018  * Portions created by the Initial Developer are Copyright (C) 2004
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s): 
00022  *   Neil Deakin (enndeakin@sympatico.ca)
00023  *   Scott MacGregor (mscott@mozilla.org)
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * 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 #include "domstubs.idl"
00041 
00042 interface nsISelection;
00043 interface nsIEditor;
00044 interface nsIEditorSpellCheck;
00045 
00046 [scriptable, uuid(f5d1ec9e-4d30-11d8-8053-da0cc7df1f20)]
00047 
00048 interface nsIInlineSpellChecker : nsISupports
00049 {
00050   readonly attribute nsIEditorSpellCheck spellChecker;
00051 
00052   [noscript] void init(in nsIEditor aEditor);
00053   [noscript] void cleanup(); 
00054 
00055   attribute boolean enableRealTimeSpell;
00056 
00057   void spellCheckAfterEditorChange(in long aAction,
00058                                    in nsISelection aSelection,
00059                                    in nsIDOMNode aPreviousSelectedNode,
00060                                    in long aPreviousSelectedOffset,
00061                                    in nsIDOMNode aStartNode,
00062                                    in long aStartOffset,
00063                                    in nsIDOMNode aEndNode,
00064                                    in long aEndOffset);
00065 
00066   void spellCheckRange(in nsIDOMRange aSelection);
00067 
00068   nsIDOMRange getMispelledWord(in nsIDOMNode aNode, in long aOffset);
00069   void replaceWord(in nsIDOMNode aNode, in long aOffset, in AString aNewword);
00070   void addWordToDictionary(in AString aWord);
00071   
00072   void ignoreWord(in AString aWord);
00073   void ignoreWords([array, size_is(aCount)] in wstring aWordsToIgnore, in unsigned long aCount);
00074 };
00075 
00076 %{C++
00077 
00078 #define MOZ_INLINESPELLCHECKER_CONTRACTID "@mozilla.org/spellchecker-inline;1"
00079 
00080 %}