/* 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 Aug 6 10:37:25 2013. */ #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 PPB_TextInput_Dev 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_DEV_NONE = 0, /** * Input caret is in a normal editable mode, any input method can be used. */ PP_TEXTINPUT_TYPE_DEV_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_DEV_PASSWORD = 2, PP_TEXTINPUT_TYPE_DEV_SEARCH = 3, PP_TEXTINPUT_TYPE_DEV_EMAIL = 4, PP_TEXTINPUT_TYPE_DEV_NUMBER = 5, PP_TEXTINPUT_TYPE_DEV_TELEPHONE = 6, PP_TEXTINPUT_TYPE_DEV_URL = 7 } PP_TextInput_Type_Dev; PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_TextInput_Type_Dev, 4); /** * @} */ /** * @addtogroup Interfaces * @{ */ /** * PPB_TextInput_Dev 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_Dev 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 PPP_TextInput_Dev::RequestSurroundingText * call, informs the browser about the current text selection and surrounding * text. text is a UTF-8 string that contains the current range * of text selection in the plugin. caret is the byte-index of * the caret position within text. anchor is the * byte-index of the anchor position (i.e., if a range of text is selected, * it is the other edge of selection different from caret. If * there are no selection, anchor is equal to caret. * * 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 beginning of a sentence, suggest capital letters in a * virtual keyboard). * * When the focus is not on text, call this function setting text * to an empty string and caret and anchor 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 PPP_TextInput_Dev::RequestSurroundingText. The * plugin then should send the information with * UpdateSurroundingText. */ 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_Dev 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_ */