1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/* Copyright (c) 2012 The Chromium Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/* From dev/ppb_text_input_dev.idl modified Tue Mar 13 21:18:47 2012. */
#ifndef PPAPI_C_DEV_PPB_TEXT_INPUT_DEV_H_
#define PPAPI_C_DEV_PPB_TEXT_INPUT_DEV_H_
#include "ppapi/c/pp_instance.h"
#include "ppapi/c/pp_macros.h"
#include "ppapi/c/pp_point.h"
#include "ppapi/c/pp_rect.h"
#include "ppapi/c/pp_size.h"
#include "ppapi/c/pp_stdint.h"
#define PPB_TEXTINPUT_DEV_INTERFACE_0_1 "PPB_TextInput(Dev);0.1"
#define PPB_TEXTINPUT_DEV_INTERFACE_0_2 "PPB_TextInput(Dev);0.2"
#define PPB_TEXTINPUT_DEV_INTERFACE PPB_TEXTINPUT_DEV_INTERFACE_0_2
/**
* @file
* This file defines the <code>PPB_TextInput_Dev</code> interface.
*/
/**
* @addtogroup Enums
* @{
*/
/**
* PP_TextInput_Type is used to indicate the status of a plugin in regard to
* text input.
*/
typedef enum {
/**
* Input caret is not in an editable mode, no input method shall be used.
*/
PP_TEXTINPUT_TYPE_NONE = 0,
/**
* Input caret is in a normal editable mode, any input method can be used.
*/
PP_TEXTINPUT_TYPE_TEXT = 1,
/**
* Input caret is in a password box, an input method may be used only if
* it's suitable for password input.
*/
PP_TEXTINPUT_TYPE_PASSWORD = 2,
PP_TEXTINPUT_TYPE_SEARCH = 3,
PP_TEXTINPUT_TYPE_EMAIL = 4,
PP_TEXTINPUT_TYPE_NUMBER = 5,
PP_TEXTINPUT_TYPE_TELEPHONE = 6,
PP_TEXTINPUT_TYPE_URL = 7
} PP_TextInput_Type;
PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_TextInput_Type, 4);
/**
* @}
*/
/**
* @addtogroup Interfaces
* @{
*/
/**
* <code>PPB_TextInput_Dev</code> provides a set of functions for giving hints
* to the browser about the text input status of plugins, and functions for
* controlling input method editors (IMEs).
*/
struct PPB_TextInput_Dev_0_2 {
/**
* Informs the browser about the current text input mode of the plugin.
* Typical use of this information in the browser is to properly
* display/suppress tools for supporting text inputs (such as virtual
* keyboards in touch screen based devices, or input method editors often
* used for composing East Asian characters).
*/
void (*SetTextInputType)(PP_Instance instance, PP_TextInput_Type type);
/**
* Informs the browser about the coordinates of the text input caret and the
* bounding box of the text input area. Typical use of this information in
* the browser is to layout IME windows etc.
*/
void (*UpdateCaretPosition)(PP_Instance instance,
const struct PP_Rect* caret,
const struct PP_Rect* bounding_box);
/**
* Cancels the current composition in IME.
*/
void (*CancelCompositionText)(PP_Instance instance);
/**
* In response to the <code>PPP_TextInput_Dev::RequestSurroundingText</code>
* call, informs the browser about the current text selection and surrounding
* text. <code>text</code> is a UTF-8 string that contains the current range
* of text selection in the plugin. <code>caret</code> is the byte-index of
* the caret poisition within <code>text</code>. <code>anchor</code> is the
* byte-index of the anchor position (i.e., if a range of text is selected,
* it is the other edge of selection diffrent from <code>caret</code>. If
* there are no selection, <code>anchor</code> is equal to <code>caret</code>.
*
* Typical use of this information in the browser is to enable "reconversion"
* features of IME that puts back the already committed text into the
* pre-commit composition state. Another use is to improve the precision
* of suggestion of IME by taking the context into account (e.g., if the caret
* looks to be on the begining of a sentense, suggest capital letters in a
* virtual keyboard).
*
* When the focus is not on text, call this function setting <code>text</code>
* to an empty string and <code>caret</code> and <code>anchor</code> to zero.
* Also, the plugin should send the empty text when it does not want to reveal
* the selection to IME (e.g., when the surrounding text is containing
* password text).
*/
void (*UpdateSurroundingText)(PP_Instance instance,
const char* text,
uint32_t caret,
uint32_t anchor);
/**
* Informs the browser when a range of text selection is changed in a plugin.
* When the browser needs to know the content of the updated selection, it
* pings back by <code>PPP_TextInput_Dev::RequestSurroundingText</code>. The
* plugin then should send the information with
* <code>UpdateSurroundingText</code>.
*/
void (*SelectionChanged)(PP_Instance instance);
};
typedef struct PPB_TextInput_Dev_0_2 PPB_TextInput_Dev;
struct PPB_TextInput_Dev_0_1 {
void (*SetTextInputType)(PP_Instance instance, PP_TextInput_Type type);
void (*UpdateCaretPosition)(PP_Instance instance,
const struct PP_Rect* caret,
const struct PP_Rect* bounding_box);
void (*CancelCompositionText)(PP_Instance instance);
};
/**
* @}
*/
#endif /* PPAPI_C_DEV_PPB_TEXT_INPUT_DEV_H_ */
|
