1 {{+bindTo:partials.standard_nacl_api}}
2 <h1>pp::TextInputController Class Reference</h1>
4 {{- dummy div to appease doxygen -}}
6 <!-- Generated by Doxygen 1.7.6.1 -->
12 <div class="contents">
13 <!-- doxytag: class="pp::TextInputController" -->
14 <p><a href="classpp_1_1_text_input_controller-members.html">List of all members.</a></p>
16 Public Member Functions</h2><table class="memberdecls">
18 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_text_input_controller.html#a6fe3648b0322ad724f0d103b61cbaee9">TextInputController</a> (const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &instance)</td></tr>
19 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_text_input_controller.html#a19e3cd5588f61113d4037cbf15069a96">~TextInputController</a> ()</td></tr>
20 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_text_input_controller.html#acef9638552ba5254401ea3330140e67f">SetTextInputType</a> (PP_TextInput_Type type)</td></tr>
21 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_text_input_controller.html#a884a00a9d265d812424874542c2ee34c">UpdateCaretPosition</a> (const <a class="el" href="classpp_1_1_rect.html">Rect</a> &caret)</td></tr>
22 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_text_input_controller.html#a19329ad0e0ca3e7a7d31cf51462643cb">CancelCompositionText</a> ()</td></tr>
23 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_text_input_controller.html#a59fc139f69ed425f632c16313e69ceca">UpdateSurroundingText</a> (const <a class="el" href="classpp_1_1_var.html">Var</a> &text, uint32_t caret, uint32_t anchor)</td></tr>
25 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
26 <div class="textblock"><p>This class can be used for giving hints to the browser about the text input status of plugins. </p>
27 </div><hr /><h2>Constructor & Destructor Documentation</h2>
28 <a class="anchor" id="a6fe3648b0322ad724f0d103b61cbaee9"></a><!-- doxytag: member="pp::TextInputController::TextInputController" ref="a6fe3648b0322ad724f0d103b61cbaee9" args="(const InstanceHandle &instance)" -->
30 <div class="memproto">
31 <table class="memname">
33 <td class="memname"><a class="el" href="classpp_1_1_text_input_controller.html#a6fe3648b0322ad724f0d103b61cbaee9">pp::TextInputController::TextInputController</a> </td>
35 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> & </td>
36 <td class="paramname"><em>instance</em></td><td>)</td>
37 <td><code> [explicit]</code></td>
42 <p>A constructor for creating a <code><a class="el" href="classpp_1_1_text_input_controller.html" title="This class can be used for giving hints to the browser about the text input status of plugins...">TextInputController</a></code>. </p>
43 <dl class="params"><dt><b>Parameters:</b></dt><dd>
44 <table class="params">
45 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance with which this resource will be associated. </td></tr>
51 <a class="anchor" id="a19e3cd5588f61113d4037cbf15069a96"></a><!-- doxytag: member="pp::TextInputController::~TextInputController" ref="a19e3cd5588f61113d4037cbf15069a96" args="()" -->
53 <div class="memproto">
54 <table class="memname">
56 <td class="memname"><a class="el" href="classpp_1_1_text_input_controller.html#a19e3cd5588f61113d4037cbf15069a96">pp::TextInputController::~TextInputController</a> </td>
58 <td class="paramname"></td><td>)</td>
67 <hr /><h2>Member Function Documentation</h2>
68 <a class="anchor" id="a19329ad0e0ca3e7a7d31cf51462643cb"></a><!-- doxytag: member="pp::TextInputController::CancelCompositionText" ref="a19329ad0e0ca3e7a7d31cf51462643cb" args="()" -->
70 <div class="memproto">
71 <table class="memname">
73 <td class="memname">void <a class="el" href="classpp_1_1_text_input_controller.html#a19329ad0e0ca3e7a7d31cf51462643cb">pp::TextInputController::CancelCompositionText</a> </td>
75 <td class="paramname"></td><td>)</td>
81 <p><a class="el" href="classpp_1_1_text_input_controller.html#a19329ad0e0ca3e7a7d31cf51462643cb" title="CancelCompositionText() informs the browser that the current composition text is cancelled by the plu...">CancelCompositionText()</a> informs the browser that the current composition text is cancelled by the plugin. </p>
84 <a class="anchor" id="acef9638552ba5254401ea3330140e67f"></a><!-- doxytag: member="pp::TextInputController::SetTextInputType" ref="acef9638552ba5254401ea3330140e67f" args="(PP_TextInput_Type type)" -->
86 <div class="memproto">
87 <table class="memname">
89 <td class="memname">void <a class="el" href="classpp_1_1_text_input_controller.html#acef9638552ba5254401ea3330140e67f">pp::TextInputController::SetTextInputType</a> </td>
91 <td class="paramtype">PP_TextInput_Type </td>
92 <td class="paramname"><em>type</em></td><td>)</td>
98 <p><a class="el" href="classpp_1_1_text_input_controller.html#acef9638552ba5254401ea3330140e67f" title="SetTextInputType() informs the browser about the current text input mode of the plugin.">SetTextInputType()</a> informs the browser about the current text input mode of the plugin. </p>
99 <dl class="params"><dt><b>Parameters:</b></dt><dd>
100 <table class="params">
101 <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of text input type. </td></tr>
107 <a class="anchor" id="a884a00a9d265d812424874542c2ee34c"></a><!-- doxytag: member="pp::TextInputController::UpdateCaretPosition" ref="a884a00a9d265d812424874542c2ee34c" args="(const Rect &caret)" -->
108 <div class="memitem">
109 <div class="memproto">
110 <table class="memname">
112 <td class="memname">void <a class="el" href="classpp_1_1_text_input_controller.html#a884a00a9d265d812424874542c2ee34c">pp::TextInputController::UpdateCaretPosition</a> </td>
114 <td class="paramtype">const <a class="el" href="classpp_1_1_rect.html">Rect</a> & </td>
115 <td class="paramname"><em>caret</em></td><td>)</td>
121 <p><a class="el" href="classpp_1_1_text_input_controller.html#a884a00a9d265d812424874542c2ee34c" title="UpdateCaretPosition() informs the browser about the coordinates of the text input caret area...">UpdateCaretPosition()</a> informs the browser about the coordinates of the text input caret area. </p>
122 <dl class="params"><dt><b>Parameters:</b></dt><dd>
123 <table class="params">
124 <tr><td class="paramdir">[in]</td><td class="paramname">caret</td><td>A rectangle indicating the caret area. </td></tr>
130 <a class="anchor" id="a59fc139f69ed425f632c16313e69ceca"></a><!-- doxytag: member="pp::TextInputController::UpdateSurroundingText" ref="a59fc139f69ed425f632c16313e69ceca" args="(const Var &text, uint32_t caret, uint32_t anchor)" -->
131 <div class="memitem">
132 <div class="memproto">
133 <table class="memname">
135 <td class="memname">void <a class="el" href="classpp_1_1_text_input_controller.html#a59fc139f69ed425f632c16313e69ceca">pp::TextInputController::UpdateSurroundingText</a> </td>
137 <td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> & </td>
138 <td class="paramname"><em>text</em>, </td>
141 <td class="paramkey"></td>
143 <td class="paramtype">uint32_t </td>
144 <td class="paramname"><em>caret</em>, </td>
147 <td class="paramkey"></td>
149 <td class="paramtype">uint32_t </td>
150 <td class="paramname"><em>anchor</em> </td>
160 <p><a class="el" href="classpp_1_1_text_input_controller.html#a59fc139f69ed425f632c16313e69ceca" title="UpdateSurroundingText() informs the browser about the current text selection and surrounding text...">UpdateSurroundingText()</a> informs the browser about the current text selection and surrounding text. </p>
161 <dl class="params"><dt><b>Parameters:</b></dt><dd>
162 <table class="params">
163 <tr><td class="paramdir">[in]</td><td class="paramname">text</td><td>A UTF-8 sting indicating string buffer of current input context.</td></tr>
164 <tr><td class="paramdir">[in]</td><td class="paramname">caret</td><td>A integer indicating the byte index of caret location in <code>text</code>.</td></tr>
165 <tr><td class="paramdir">[in]</td><td class="paramname">caret</td><td>A integer indicating the byte index of anchor location in <code>text</code>. If there is no selection, this value should be equal to <code>caret</code>. </td></tr>
171 <hr />The documentation for this class was generated from the following file:<ul>
172 <li><a class="el" href="text__input__controller_8h.html">text_input_controller.h</a></li>
174 </div><!-- contents -->
176 {{/partials.standard_nacl_api}}