Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(15)

Side by Side Diff: ppapi/api/ppb_text_input_controller.idl

Issue 18671004: PPAPI: Move IMEInputEvent and TextInput to stable. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Addressing one comment Created 7 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « ppapi/api/ppb_input_event.idl ('k') | ppapi/c/pp_macros.h » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. 1 /* Copyright (c) 2013 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 5
6 /** 6 /**
7 * This file defines the <code>PPB_TextInput_Dev</code> interface. 7 * This file defines the <code>PPB_TextInputController</code> interface.
8 */ 8 */
9 9
10 label Chrome { 10 label Chrome {
11 M16 = 0.1, 11 M30 = 1.0
12 M19 = 0.2
13 }; 12 };
14 13
15 /** 14 /**
16 * PP_TextInput_Type is used to indicate the status of a plugin in regard to 15 * PP_TextInput_Type is used to indicate the status of a plugin in regard to
17 * text input. 16 * text input.
18 */ 17 */
19 [assert_size(4)] 18 [assert_size(4)]
20 enum PP_TextInput_Type { 19 enum PP_TextInput_Type {
21 /** 20 /**
22 * Input caret is not in an editable mode, no input method shall be used. 21 * Input caret is not in an editable mode, no input method shall be used.
23 */ 22 */
24 PP_TEXTINPUT_TYPE_NONE = 0, 23 PP_TEXTINPUT_TYPE_NONE = 0,
25 /** 24 /**
26 * Input caret is in a normal editable mode, any input method can be used. 25 * Input caret is in a normal editable mode, any input method can be used.
27 */ 26 */
28 PP_TEXTINPUT_TYPE_TEXT = 1, 27 PP_TEXTINPUT_TYPE_TEXT = 1,
29 /** 28 /**
30 * Input caret is in a password box, an input method may be used only if 29 * Input caret is in a password box, an input method may be used only if
31 * it's suitable for password input. 30 * it's suitable for password input.
32 */ 31 */
33 PP_TEXTINPUT_TYPE_PASSWORD = 2, 32 PP_TEXTINPUT_TYPE_PASSWORD = 2,
34 PP_TEXTINPUT_TYPE_SEARCH = 3, 33 PP_TEXTINPUT_TYPE_SEARCH = 3,
35 PP_TEXTINPUT_TYPE_EMAIL = 4, 34 PP_TEXTINPUT_TYPE_EMAIL = 4,
36 PP_TEXTINPUT_TYPE_NUMBER = 5, 35 PP_TEXTINPUT_TYPE_NUMBER = 5,
37 PP_TEXTINPUT_TYPE_TELEPHONE = 6, 36 PP_TEXTINPUT_TYPE_TELEPHONE = 6,
38 PP_TEXTINPUT_TYPE_URL = 7 37 PP_TEXTINPUT_TYPE_URL = 7
39 }; 38 };
40 39
41 /** 40 /**
42 * <code>PPB_TextInput_Dev</code> provides a set of functions for giving hints 41 * <code>PPB_TextInputController</code> provides a set of functions for giving
43 * to the browser about the text input status of plugins, and functions for 42 * hints to the browser about the text input status of plugins, and functions
44 * controlling input method editors (IMEs). 43 * for controlling input method editors (IMEs).
45 */ 44 */
46 interface PPB_TextInput_Dev { 45 interface PPB_TextInputController {
47 /** 46 /**
48 * Informs the browser about the current text input mode of the plugin. 47 * Informs the browser about the current text input mode of the plugin.
49 * Typical use of this information in the browser is to properly 48 * Typical use of this information in the browser is to properly
50 * display/suppress tools for supporting text inputs (such as virtual 49 * display/suppress tools for supporting text inputs (such as virtual
51 * keyboards in touch screen based devices, or input method editors often 50 * keyboards in touch screen based devices, or input method editors often
52 * used for composing East Asian characters). 51 * used for composing East Asian characters).
53 */ 52 */
54 void SetTextInputType([in] PP_Instance instance, 53 void SetTextInputType([in] PP_Instance instance,
55 [in] PP_TextInput_Type type); 54 [in] PP_TextInput_Type type);
56 55
57 /** 56 /**
58 * Informs the browser about the coordinates of the text input caret and the 57 * Informs the browser about the coordinates of the text input caret area.
59 * bounding box of the text input area. Typical use of this information in 58 * Typical use of this information in the browser is to layout IME windows
60 * the browser is to layout IME windows etc. 59 * etc.
61 */ 60 */
62 void UpdateCaretPosition([in] PP_Instance instance, 61 void UpdateCaretPosition([in] PP_Instance instance,
63 [in] PP_Rect caret, 62 [in] PP_Rect caret);
64 [in] PP_Rect bounding_box);
65 63
66 /** 64 /**
67 * Cancels the current composition in IME. 65 * Cancels the current composition in IME.
68 */ 66 */
69 void CancelCompositionText([in] PP_Instance instance); 67 void CancelCompositionText([in] PP_Instance instance);
70 68
71 /** 69 /**
72 * In response to the <code>PPP_TextInput_Dev::RequestSurroundingText</code> 70 * Informs the browser about the current text selection and surrounding
73 * call, informs the browser about the current text selection and surrounding
74 * text. <code>text</code> is a UTF-8 string that contains the current range 71 * text. <code>text</code> is a UTF-8 string that contains the current range
75 * of text selection in the plugin. <code>caret</code> is the byte-index of 72 * of text selection in the plugin. <code>caret</code> is the byte-index of
76 * the caret position within <code>text</code>. <code>anchor</code> is the 73 * the caret position within <code>text</code>. <code>anchor</code> is the
77 * byte-index of the anchor position (i.e., if a range of text is selected, 74 * byte-index of the anchor position (i.e., if a range of text is selected,
78 * it is the other edge of selection different from <code>caret</code>. If 75 * it is the other edge of selection different from <code>caret</code>. If
79 * there are no selection, <code>anchor</code> is equal to <code>caret</code>. 76 * there are no selection, <code>anchor</code> is equal to <code>caret</code>.
80 * 77 *
81 * Typical use of this information in the browser is to enable "reconversion" 78 * Typical use of this information in the browser is to enable "reconversion"
82 * features of IME that puts back the already committed text into the 79 * features of IME that puts back the already committed text into the
83 * pre-commit composition state. Another use is to improve the precision 80 * pre-commit composition state. Another use is to improve the precision
84 * of suggestion of IME by taking the context into account (e.g., if the caret 81 * of suggestion of IME by taking the context into account (e.g., if the caret
85 * looks to be on the beginning of a sentence, suggest capital letters in a 82 * looks to be on the beginning of a sentence, suggest capital letters in a
86 * virtual keyboard). 83 * virtual keyboard).
87 * 84 *
88 * When the focus is not on text, call this function setting <code>text</code> 85 * When the focus is not on text, call this function setting <code>text</code>
89 * to an empty string and <code>caret</code> and <code>anchor</code> to zero. 86 * to an empty string and <code>caret</code> and <code>anchor</code> to zero.
90 * Also, the plugin should send the empty text when it does not want to reveal 87 * Also, the plugin should send the empty text when it does not want to reveal
91 * the selection to IME (e.g., when the surrounding text is containing 88 * the selection to IME (e.g., when the surrounding text is containing
92 * password text). 89 * password text).
93 */ 90 */
94 [version=0.2]
95 void UpdateSurroundingText([in] PP_Instance instance, 91 void UpdateSurroundingText([in] PP_Instance instance,
96 [in] str_t text, 92 [in] PP_Var text,
97 [in] uint32_t caret, 93 [in] uint32_t caret,
98 [in] uint32_t anchor); 94 [in] uint32_t anchor);
99
100 /**
101 * Informs the browser when a range of text selection is changed in a plugin.
102 * When the browser needs to know the content of the updated selection, it
103 * pings back by <code>PPP_TextInput_Dev::RequestSurroundingText</code>. The
104 * plugin then should send the information with
105 * <code>UpdateSurroundingText</code>.
106 */
107 [version=0.2]
108 void SelectionChanged([in] PP_Instance instance);
109 }; 95 };
OLDNEW
« no previous file with comments | « ppapi/api/ppb_input_event.idl ('k') | ppapi/c/pp_macros.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698