chromium/native_client_sdk/doc_generated/pepper_stable/cpp/classpp_1_1_text_input_controller.html

{{+bindTo:partials.standard_nacl_api}}
<h1>pp::TextInputController Class Reference</h1>
<div id="doxygen-ref">
{{- dummy div to appease doxygen -}}
  <div>
<!-- Generated by Doxygen 1.7.6.1 -->



</div>
<!--header-->
<div class="contents">
<!-- doxytag: class="pp::TextInputController" -->
<p><a href="classpp_1_1_text_input_controller-members.html">List of all members.</a></p>
<h2>
Public Member Functions</h2><table class="memberdecls">

<tr><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;instance)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_text_input_controller.html#a19e3cd5588f61113d4037cbf15069a96">~TextInputController</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</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>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</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> &amp;caret)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_text_input_controller.html#a19329ad0e0ca3e7a7d31cf51462643cb">CancelCompositionText</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</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> &amp;text, uint32_t caret, uint32_t anchor)</td></tr>
</table>
<hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class can be used for giving hints to the browser about the text input status of plugins. </p>
</div><hr /><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a6fe3648b0322ad724f0d103b61cbaee9"></a><!-- doxytag: member="pp::TextInputController::TextInputController" ref="a6fe3648b0322ad724f0d103b61cbaee9" args="(const InstanceHandle &amp;instance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_text_input_controller.html#a6fe3648b0322ad724f0d103b61cbaee9">pp::TextInputController::TextInputController</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
<td class="paramname"><em>instance</em></td><td>)</td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance with which this resource will be associated. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a19e3cd5588f61113d4037cbf15069a96"></a><!-- doxytag: member="pp::TextInputController::~TextInputController" ref="a19e3cd5588f61113d4037cbf15069a96" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_text_input_controller.html#a19e3cd5588f61113d4037cbf15069a96">pp::TextInputController::~TextInputController</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr /><h2>Member Function Documentation</h2>
<a class="anchor" id="a19329ad0e0ca3e7a7d31cf51462643cb"></a><!-- doxytag: member="pp::TextInputController::CancelCompositionText" ref="a19329ad0e0ca3e7a7d31cf51462643cb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_text_input_controller.html#a19329ad0e0ca3e7a7d31cf51462643cb">pp::TextInputController::CancelCompositionText</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
</div>
</div>
<a class="anchor" id="acef9638552ba5254401ea3330140e67f"></a><!-- doxytag: member="pp::TextInputController::SetTextInputType" ref="acef9638552ba5254401ea3330140e67f" args="(PP_TextInput_Type type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_text_input_controller.html#acef9638552ba5254401ea3330140e67f">pp::TextInputController::SetTextInputType</a> </td>
<td>(</td>
<td class="paramtype">PP_TextInput_Type&#160;</td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of text input type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a884a00a9d265d812424874542c2ee34c"></a><!-- doxytag: member="pp::TextInputController::UpdateCaretPosition" ref="a884a00a9d265d812424874542c2ee34c" args="(const Rect &amp;caret)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_text_input_controller.html#a884a00a9d265d812424874542c2ee34c">pp::TextInputController::UpdateCaretPosition</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_rect.html">Rect</a> &amp;&#160;</td>
<td class="paramname"><em>caret</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">caret</td><td>A rectangle indicating the caret area. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a59fc139f69ed425f632c16313e69ceca"></a><!-- doxytag: member="pp::TextInputController::UpdateSurroundingText" ref="a59fc139f69ed425f632c16313e69ceca" args="(const Var &amp;text, uint32_t caret, uint32_t anchor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_text_input_controller.html#a59fc139f69ed425f632c16313e69ceca">pp::TextInputController::UpdateSurroundingText</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>caret</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>anchor</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<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>
<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>
<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>
</table>
</dd>
</dl>
</div>
</div>
<hr />The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="text__input__controller_8h.html">text_input_controller.h</a></li>
</ul>
</div><!-- contents -->
</div>
{{/partials.standard_nacl_api}}