OLD | NEW |
1 // Copyright 2016 The Chromium Authors. All rights reserved. | 1 // Copyright 2016 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef WebInputMethodController_h | 5 #ifndef WebInputMethodController_h |
6 #define WebInputMethodController_h | 6 #define WebInputMethodController_h |
7 | 7 |
8 #include "../platform/WebTextInputInfo.h" | |
9 #include "WebCompositionUnderline.h" | 8 #include "WebCompositionUnderline.h" |
10 #include "WebTextInputType.h" | |
11 #include "WebWidget.h" | 9 #include "WebWidget.h" |
12 | 10 |
13 namespace blink { | 11 namespace blink { |
14 | 12 |
15 class WebString; | 13 class WebString; |
16 template <typename T> | 14 template <typename T> |
17 class WebVector; | 15 class WebVector; |
18 | 16 |
19 class WebInputMethodController { | 17 class WebInputMethodController { |
20 public: | 18 public: |
21 enum ConfirmCompositionBehavior { | 19 enum ConfirmCompositionBehavior { |
22 DoNotKeepSelection, | 20 DoNotKeepSelection, |
23 KeepSelection, | 21 KeepSelection, |
24 }; | 22 }; |
25 | 23 |
26 virtual ~WebInputMethodController() {} | 24 virtual ~WebInputMethodController() {} |
27 // Called to inform the WebInputMethodController of a new composition text. | 25 // Called to inform the WebInputMethodController of a new composition text. |
28 // If selectionStart and selectionEnd has the same value, then it indicates | 26 // If selectionStart and selectionEnd has the same value, then it indicates |
29 // the input caret position. If the text is empty, then the existing | 27 // the input caret position. If the text is empty, then the existing |
30 // composition text will be canceled. | 28 // composition text will be canceled. |
31 // Returns true if the composition text was set successfully. | 29 // Returns true if the composition text was set successfully. |
32 virtual bool setComposition( | 30 virtual bool setComposition( |
33 const WebString& text, | 31 const WebString& text, |
34 const WebVector<WebCompositionUnderline>& underlines, | 32 const WebVector<WebCompositionUnderline>& underlines, |
35 int selectionStart, | 33 int selectionStart, |
36 int selectionEnd) = 0; | 34 int selectionEnd) = 0; |
37 | 35 |
38 // Called to inform the controller that deleting the ongoing composition if | 36 // Called to inform the WebWidget that deleting the ongoing composition if |
39 // any, inserting the specified text, and moving the caret according to | 37 // any, inserting the specified text, and moving the caret according to |
40 // relativeCaretPosition. | 38 // relativeCaretPosition. |
41 virtual bool commitText(const WebString& text, int relativeCaretPosition) = 0; | 39 virtual bool commitText(const WebString& text, int relativeCaretPosition) = 0; |
42 | 40 |
43 // Called to inform the controller to confirm an ongoing composition. | 41 // Called to inform the WebWidget to confirm an ongoing composition. |
44 virtual bool finishComposingText( | 42 virtual bool finishComposingText( |
45 ConfirmCompositionBehavior selectionBehavior) = 0; | 43 ConfirmCompositionBehavior selectionBehavior) = 0; |
46 | |
47 // Returns information about the current text input of this controller. Note | |
48 // that this query can be expensive for long fields, as it returns the | |
49 // plain-text representation of the current editable element. Consider using | |
50 // the lighter-weight textInputType() when appropriate. | |
51 virtual WebTextInputInfo textInputInfo() { return WebTextInputInfo(); } | |
52 | |
53 // Returns the type of current text input of this controller. | |
54 virtual WebTextInputType textInputType() { return WebTextInputTypeNone; } | |
55 }; | 44 }; |
56 | 45 |
57 } // namespace blink | 46 } // namespace blink |
58 #endif | 47 #endif |
OLD | NEW |