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 Communicator client 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 : *
24 : * Alternatively, the contents of this file may be used under the terms of
25 : * either of the GNU General Public License Version 2 or later (the "GPL"),
26 : * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 : * in which case the provisions of the GPL or the LGPL are applicable instead
28 : * of those above. If you wish to allow use of your version of this file only
29 : * under the terms of either the GPL or the LGPL, and not to allow others to
30 : * use your version of this file under the terms of the MPL, indicate your
31 : * decision by deleting the provisions above and replace them with the notice
32 : * and other provisions required by the GPL or the LGPL. If you do not delete
33 : * the provisions above, a recipient may use your version of this file under
34 : * the terms of any one of the MPL, the GPL or the LGPL.
35 : *
36 : * ***** END LICENSE BLOCK ***** */
37 :
38 : #ifndef nsITextControlFrame_h___
39 : #define nsITextControlFrame_h___
40 :
41 : #include "nsIFormControlFrame.h"
42 :
43 : class nsIEditor;
44 : class nsIDocShell;
45 : class nsISelectionController;
46 : class nsFrameSelection;
47 :
48 : class nsITextControlFrame : public nsIFormControlFrame
49 0 : {
50 : public:
51 : NS_DECL_QUERYFRAME_TARGET(nsITextControlFrame)
52 :
53 : enum SelectionDirection {
54 : eNone,
55 : eForward,
56 : eBackward
57 : };
58 :
59 : NS_IMETHOD GetEditor(nsIEditor **aEditor) = 0;
60 :
61 : NS_IMETHOD GetTextLength(PRInt32* aTextLength) = 0;
62 :
63 : /**
64 : * Fire onChange if the value has changed since it was focused or since it
65 : * was last fired.
66 : */
67 : NS_IMETHOD CheckFireOnChange() = 0;
68 : NS_IMETHOD SetSelectionStart(PRInt32 aSelectionStart) = 0;
69 : NS_IMETHOD SetSelectionEnd(PRInt32 aSelectionEnd) = 0;
70 :
71 : NS_IMETHOD SetSelectionRange(PRInt32 aSelectionStart,
72 : PRInt32 aSelectionEnd,
73 : SelectionDirection aDirection = eNone) = 0;
74 : NS_IMETHOD GetSelectionRange(PRInt32* aSelectionStart,
75 : PRInt32* aSelectionEnd,
76 : SelectionDirection* aDirection = nsnull) = 0;
77 :
78 : NS_IMETHOD GetOwnedSelectionController(nsISelectionController** aSelCon) = 0;
79 : virtual nsFrameSelection* GetOwnedFrameSelection() = 0;
80 :
81 : virtual nsresult GetPhonetic(nsAString& aPhonetic) = 0;
82 :
83 : /**
84 : * Ensure editor is initialized with the proper flags and the default value.
85 : * @throws NS_ERROR_NOT_INITIALIZED if mEditor has not been created
86 : * @throws various and sundry other things
87 : */
88 : virtual nsresult EnsureEditorInitialized() = 0;
89 :
90 : virtual nsresult ScrollSelectionIntoView() = 0;
91 : };
92 :
93 : #endif
|