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 mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 1998
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Masayuki Nakano <masayuki@d-toybox.com>
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either of the GNU General Public License Version 2 or later (the "GPL"),
27 * or 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 %{C++
43 class nsIPrivateTextRangeList;
44 struct nsTextEventReply;
45 struct nsReconversionEventReply;
46 struct nsQueryCaretRectEventReply;
47 %}
48
49 [ptr] native nsIPrivateTextRangeListPtr(nsIPrivateTextRangeList);
50 [ptr] native nsTextEventReplyPtr(nsTextEventReply);
51 [ptr] native nsReconversionEventReplyPtr(nsReconversionEventReply);
52 [ptr] native nsQueryCaretRectEventReplyPtr(nsQueryCaretRectEventReply);
53
54
55 [scriptable, uuid(ce1c0424-c3c0-44b0-97d6-df12deb19d45)]
56
57 interface nsIEditorIMESupport : nsISupports
58 {
59
60
61 /**
62 * beginComposition(nsTextEventReply* aReply) Handles the start of inline input composition.
63 */
64
65 [noscript] void beginComposition(in nsTextEventReplyPtr aReply);
66
67 /**
68 * setCompositionString() Sets the inline input composition string.
69 * beginComposition must be called prior to this.
70 */
71
72 [noscript] void setCompositionString(in DOMString aCompositionString, in nsIPrivateTextRangeListPtr aTextRange, in nsTextEventReplyPtr aReply);
73
74 /**
75 * endComposition() Handles the end of inline input composition.
76 */
77
78 void endComposition();
79
80 /**
81 * queryComposition() Get the composition position
82 */
83
84 [noscript] void queryComposition(in nsTextEventReplyPtr aReply);
85
86 /**
87 * forceCompositionEnd() force the composition end
88 */
89
90 void forceCompositionEnd();
91
92 /**
93 * getReconversionString() Get the reconvertion string
94 */
95
96 [noscript] void getReconversionString(in nsReconversionEventReplyPtr aReply);
97
98 /**
99 * Notify for IME when the editor got focus.
100 */
101
102 void notifyIMEOnFocus();
103
104 /**
105 * Notify for IME when the editor lost focus.
106 */
107
108 void notifyIMEOnBlur();
109
110 /**
111 * getQueryCaretRect() Get the query caret rect
112 */
113
114 [noscript] void getQueryCaretRect(in nsQueryCaretRectEventReplyPtr aReply);
115
116 /**
117 * Get preferred IME status of current widget.
118 */
119
120 [noscript] void getPreferredIMEState(out unsigned long aState);
121
122 /**
123 * whether this editor has active IME transaction
124 */
125 readonly attribute boolean composing;
126 };