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

Side by Side Diff: ppapi/c/ppb_text_input.h

Issue 18671004: PPAPI: Move IMEInputEvent and TextInput to stable. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 7 years, 5 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
OLDNEW
1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved. 1 /* Copyright (c) 2012 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 /* From dev/ppb_text_input_dev.idl modified Thu Mar 28 10:54:47 2013. */ 6 /* From ppb_text_input.idl modified Tue Jul 16 14:52:11 2013. */
7 7
8 #ifndef PPAPI_C_DEV_PPB_TEXT_INPUT_DEV_H_ 8 #ifndef PPAPI_C_PPB_TEXT_INPUT_H_
9 #define PPAPI_C_DEV_PPB_TEXT_INPUT_DEV_H_ 9 #define PPAPI_C_PPB_TEXT_INPUT_H_
10 10
11 #include "ppapi/c/pp_instance.h" 11 #include "ppapi/c/pp_instance.h"
12 #include "ppapi/c/pp_macros.h" 12 #include "ppapi/c/pp_macros.h"
13 #include "ppapi/c/pp_point.h" 13 #include "ppapi/c/pp_point.h"
14 #include "ppapi/c/pp_rect.h" 14 #include "ppapi/c/pp_rect.h"
15 #include "ppapi/c/pp_size.h" 15 #include "ppapi/c/pp_size.h"
16 #include "ppapi/c/pp_stdint.h" 16 #include "ppapi/c/pp_stdint.h"
17 17
18 #define PPB_TEXTINPUT_DEV_INTERFACE_0_1 "PPB_TextInput(Dev);0.1" 18 #define PPB_TEXTINPUT_INTERFACE_1_0 "PPB_TextInput;1.0"
19 #define PPB_TEXTINPUT_DEV_INTERFACE_0_2 "PPB_TextInput(Dev);0.2" 19 #define PPB_TEXTINPUT_INTERFACE PPB_TEXTINPUT_INTERFACE_1_0
20 #define PPB_TEXTINPUT_DEV_INTERFACE PPB_TEXTINPUT_DEV_INTERFACE_0_2
21 20
22 /** 21 /**
23 * @file 22 * @file
24 * This file defines the <code>PPB_TextInput_Dev</code> interface. 23 * This file defines the <code>PPB_TextInput</code> interface.
25 */ 24 */
26 25
27 26
28 /** 27 /**
29 * @addtogroup Enums 28 * @addtogroup Enums
30 * @{ 29 * @{
31 */ 30 */
32 /** 31 /**
33 * PP_TextInput_Type is used to indicate the status of a plugin in regard to 32 * PP_TextInput_Type is used to indicate the status of a plugin in regard to
34 * text input. 33 * text input.
(...skipping 21 matching lines...) Expand all
56 PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_TextInput_Type, 4); 55 PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_TextInput_Type, 4);
57 /** 56 /**
58 * @} 57 * @}
59 */ 58 */
60 59
61 /** 60 /**
62 * @addtogroup Interfaces 61 * @addtogroup Interfaces
63 * @{ 62 * @{
64 */ 63 */
65 /** 64 /**
66 * <code>PPB_TextInput_Dev</code> provides a set of functions for giving hints 65 * <code>PPB_TextInput</code> provides a set of functions for giving hints
67 * to the browser about the text input status of plugins, and functions for 66 * to the browser about the text input status of plugins, and functions for
68 * controlling input method editors (IMEs). 67 * controlling input method editors (IMEs).
69 */ 68 */
70 struct PPB_TextInput_Dev_0_2 { 69 struct PPB_TextInput_1_0 {
71 /** 70 /**
72 * Informs the browser about the current text input mode of the plugin. 71 * Informs the browser about the current text input mode of the plugin.
73 * Typical use of this information in the browser is to properly 72 * Typical use of this information in the browser is to properly
74 * display/suppress tools for supporting text inputs (such as virtual 73 * display/suppress tools for supporting text inputs (such as virtual
75 * keyboards in touch screen based devices, or input method editors often 74 * keyboards in touch screen based devices, or input method editors often
76 * used for composing East Asian characters). 75 * used for composing East Asian characters).
77 */ 76 */
78 void (*SetTextInputType)(PP_Instance instance, PP_TextInput_Type type); 77 void (*SetTextInputType)(PP_Instance instance, PP_TextInput_Type type);
79 /** 78 /**
80 * Informs the browser about the coordinates of the text input caret and the 79 * Informs the browser about the coordinates of the text input caret and the
81 * bounding box of the text input area. Typical use of this information in 80 * bounding box of the text input area. Typical use of this information in
82 * the browser is to layout IME windows etc. 81 * the browser is to layout IME windows etc.
83 */ 82 */
84 void (*UpdateCaretPosition)(PP_Instance instance, 83 void (*UpdateCaretPosition)(PP_Instance instance,
85 const struct PP_Rect* caret, 84 const struct PP_Rect* caret,
86 const struct PP_Rect* bounding_box); 85 const struct PP_Rect* bounding_box);
87 /** 86 /**
88 * Cancels the current composition in IME. 87 * Cancels the current composition in IME.
89 */ 88 */
90 void (*CancelCompositionText)(PP_Instance instance); 89 void (*CancelCompositionText)(PP_Instance instance);
91 /** 90 /**
92 * In response to the <code>PPP_TextInput_Dev::RequestSurroundingText</code> 91 * In response to the <code>PPP_TextInput::RequestSurroundingText</code>
93 * call, informs the browser about the current text selection and surrounding 92 * call, informs the browser about the current text selection and surrounding
94 * text. <code>text</code> is a UTF-8 string that contains the current range 93 * text. <code>text</code> is a UTF-8 string that contains the current range
95 * of text selection in the plugin. <code>caret</code> is the byte-index of 94 * of text selection in the plugin. <code>caret</code> is the byte-index of
96 * the caret position within <code>text</code>. <code>anchor</code> is the 95 * the caret position within <code>text</code>. <code>anchor</code> is the
97 * byte-index of the anchor position (i.e., if a range of text is selected, 96 * byte-index of the anchor position (i.e., if a range of text is selected,
98 * it is the other edge of selection different from <code>caret</code>. If 97 * it is the other edge of selection different from <code>caret</code>. If
99 * there are no selection, <code>anchor</code> is equal to <code>caret</code>. 98 * there are no selection, <code>anchor</code> is equal to <code>caret</code>.
100 * 99 *
101 * Typical use of this information in the browser is to enable "reconversion" 100 * Typical use of this information in the browser is to enable "reconversion"
102 * features of IME that puts back the already committed text into the 101 * features of IME that puts back the already committed text into the
103 * pre-commit composition state. Another use is to improve the precision 102 * pre-commit composition state. Another use is to improve the precision
104 * of suggestion of IME by taking the context into account (e.g., if the caret 103 * of suggestion of IME by taking the context into account (e.g., if the caret
105 * looks to be on the beginning of a sentence, suggest capital letters in a 104 * looks to be on the beginning of a sentence, suggest capital letters in a
106 * virtual keyboard). 105 * virtual keyboard).
107 * 106 *
108 * When the focus is not on text, call this function setting <code>text</code> 107 * When the focus is not on text, call this function setting <code>text</code>
109 * to an empty string and <code>caret</code> and <code>anchor</code> to zero. 108 * to an empty string and <code>caret</code> and <code>anchor</code> to zero.
110 * Also, the plugin should send the empty text when it does not want to reveal 109 * Also, the plugin should send the empty text when it does not want to reveal
111 * the selection to IME (e.g., when the surrounding text is containing 110 * the selection to IME (e.g., when the surrounding text is containing
112 * password text). 111 * password text).
113 */ 112 */
114 void (*UpdateSurroundingText)(PP_Instance instance, 113 void (*UpdateSurroundingText)(PP_Instance instance,
115 const char* text, 114 const char* text,
116 uint32_t caret, 115 uint32_t caret,
117 uint32_t anchor); 116 uint32_t anchor);
118 /** 117 /**
119 * Informs the browser when a range of text selection is changed in a plugin. 118 * Informs the browser when a range of text selection is changed in a plugin.
120 * When the browser needs to know the content of the updated selection, it 119 * When the browser needs to know the content of the updated selection, it
121 * pings back by <code>PPP_TextInput_Dev::RequestSurroundingText</code>. The 120 * pings back by <code>PPP_TextInput::RequestSurroundingText</code>. The
122 * plugin then should send the information with 121 * plugin then should send the information with
123 * <code>UpdateSurroundingText</code>. 122 * <code>UpdateSurroundingText</code>.
124 */ 123 */
125 void (*SelectionChanged)(PP_Instance instance); 124 void (*SelectionChanged)(PP_Instance instance);
126 }; 125 };
127 126
128 typedef struct PPB_TextInput_Dev_0_2 PPB_TextInput_Dev; 127 typedef struct PPB_TextInput_1_0 PPB_TextInput;
129
130 struct PPB_TextInput_Dev_0_1 {
131 void (*SetTextInputType)(PP_Instance instance, PP_TextInput_Type type);
132 void (*UpdateCaretPosition)(PP_Instance instance,
133 const struct PP_Rect* caret,
134 const struct PP_Rect* bounding_box);
135 void (*CancelCompositionText)(PP_Instance instance);
136 };
137 /** 128 /**
138 * @} 129 * @}
139 */ 130 */
140 131
141 #endif /* PPAPI_C_DEV_PPB_TEXT_INPUT_DEV_H_ */ 132 #endif /* PPAPI_C_PPB_TEXT_INPUT_H_ */
142 133
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698