1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is Inline Spellchecking
16 *
17 * The Initial Developer of the Original Code is Neil Deakin.
18 * Portions created by the Initial Developer are Copyright (C) 2004
19 * the Initial Developer. All Rights Reserved.
20 *
21 * Contributor(s):
22 * Neil Deakin (enndeakin@sympatico.ca)
23 * Scott MacGregor (mscott@mozilla.org)
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either the GNU General Public License Version 2 or later (the "GPL"), or
27 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
36 *
37 * ***** END LICENSE BLOCK ***** */
38
39 #include "nsISupports.idl"
40 #include "domstubs.idl"
41
42 interface nsISelection;
43 interface nsIEditor;
44 interface nsIEditorSpellCheck;
45
46 [scriptable, uuid(f5d1ec9e-4d30-11d8-8053-da0cc7df1f20)]
47
48 interface nsIInlineSpellChecker : nsISupports
49 {
50 readonly attribute nsIEditorSpellCheck spellChecker;
51
52 [noscript] void init(in nsIEditor aEditor);
53 [noscript] void cleanup();
54
55 attribute boolean enableRealTimeSpell;
56
57 void spellCheckAfterEditorChange(in long aAction,
58 in nsISelection aSelection,
59 in nsIDOMNode aPreviousSelectedNode,
60 in long aPreviousSelectedOffset,
61 in nsIDOMNode aStartNode,
62 in long aStartOffset,
63 in nsIDOMNode aEndNode,
64 in long aEndOffset);
65
66 void spellCheckRange(in nsIDOMRange aSelection);
67
68 nsIDOMRange getMispelledWord(in nsIDOMNode aNode, in long aOffset);
69 void replaceWord(in nsIDOMNode aNode, in long aOffset, in AString aNewword);
70 void addWordToDictionary(in AString aWord);
71
72 void ignoreWord(in AString aWord);
73 void ignoreWords([array, size_is(aCount)] in wstring aWordsToIgnore, in unsigned long aCount);
74 };
75
76 %{C++
77
78 #define MOZ_INLINESPELLCHECKER_CONTRACTID "@mozilla.org/spellchecker-inline;1"
79
80 %}