src/native_client_sdk/doc_generated/pepper_dev/cpp/classpp_1_1_i_m_e_input_event.html

   1 {{+bindTo:partials.standard_nacl_api}}
   2 <h1>pp::IMEInputEvent Class Reference</h1>
   3 <div id="doxygen-ref">
   4 {{- dummy div to appease doxygen -}}
   5   <div>
   6 <!-- Generated by Doxygen 1.7.6.1 -->
   7
   8
   9
  10 </div>
  11 <!--header-->
  12 <div class="contents">
  13 <!-- doxytag: class="pp::IMEInputEvent" --><!-- doxytag: inherits="pp::InputEvent" --><div class="dynheader">
  14 Inheritance diagram for pp::IMEInputEvent:</div>
  15 <div class="dyncontent">
  16 <div class="center"><img src="classpp_1_1_i_m_e_input_event__inherit__graph.png" border="0" usemap="#pp_1_1_i_m_e_input_event_inherit__map" alt="Inheritance graph" /></div>
  17 <map name="pp_1_1_i_m_e_input_event_inherit__map" id="pp_1_1_i_m_e_input_event_inherit__map">
  18 <area shape="rect" id="node2" href="classpp_1_1_input_event.html" title="This class represents an input event resource." alt="" coords="15,80,129,107"></area><area shape="rect" id="node3" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="20,5,124,32"></area></map>
  19 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  20 <p><a href="classpp_1_1_i_m_e_input_event-members.html">List of all members.</a></p>
  21 <h2>
  22 Public Member Functions</h2><table class="memberdecls">
  23
  24 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_i_m_e_input_event.html#a44a2a4139e63a21757a50c731e17bacd">IMEInputEvent</a> ()</td></tr>
  25 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_i_m_e_input_event.html#aedfd74fe9ee6c1cbdbcc9f78b25a5621">IMEInputEvent</a> (const <a class="el" href="classpp_1_1_input_event.html">InputEvent</a> &amp;event)</td></tr>
  26 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_i_m_e_input_event.html#a9004ae92edc6bcb797dd3720acb290af">IMEInputEvent</a> (const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;instance, PP_InputEvent_Type type, PP_TimeTicks time_stamp, const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;text, const std::vector&lt; uint32_t &gt; &amp;segment_offsets, int32_t target_segment, const std::pair&lt; uint32_t, uint32_t &gt; &amp;selection)</td></tr>
  27 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_i_m_e_input_event.html#ae2b82f9465fa0847af7e0214fb43232f">GetText</a> () const </td></tr>
  28 <tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_i_m_e_input_event.html#aee5f2af391fd269f35271012247768ac">GetSegmentNumber</a> () const </td></tr>
  29 <tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_i_m_e_input_event.html#a3deeed9cfbc9f2cff0cb027b870e3ce6">GetSegmentOffset</a> (uint32_t index) const </td></tr>
  30 <tr><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_i_m_e_input_event.html#ada4e768c2aea31e443d8bc9d5e4a9f36">GetTargetSegment</a> () const </td></tr>
  31 <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_i_m_e_input_event.html#a94e9078036a3bdf0af6d5508d9115cf6">GetSelection</a> (uint32_t *start, uint32_t *end) const </td></tr>
  32 </table>
  33 <hr /><h2>Constructor &amp; Destructor Documentation</h2>
  34 <a class="anchor" id="a44a2a4139e63a21757a50c731e17bacd"></a><!-- doxytag: member="pp::IMEInputEvent::IMEInputEvent" ref="a44a2a4139e63a21757a50c731e17bacd" args="()" -->
  35 <div class="memitem">
  36 <div class="memproto">
  37 <table class="memname">
  38 <tr>
  39 <td class="memname"><a class="el" href="classpp_1_1_i_m_e_input_event.html#a44a2a4139e63a21757a50c731e17bacd">pp::IMEInputEvent::IMEInputEvent</a> </td>
  40 <td>(</td>
  41 <td class="paramname"></td><td>)</td>
  42 <td></td>
  43 </tr>
  44 </table>
  45 </div>
  46 <div class="memdoc">
  47 <p>Constructs an <a class="el" href="classpp_1_1_resource.html#a859068e34cdc2dc0b78754c255323aa9" title="This functions determines if this resource is invalid or uninitialized.">is_null()</a> IME input event object. </p>
  48 </div>
  49 </div>
  50 <a class="anchor" id="aedfd74fe9ee6c1cbdbcc9f78b25a5621"></a><!-- doxytag: member="pp::IMEInputEvent::IMEInputEvent" ref="aedfd74fe9ee6c1cbdbcc9f78b25a5621" args="(const InputEvent &amp;event)" -->
  51 <div class="memitem">
  52 <div class="memproto">
  53 <table class="memname">
  54 <tr>
  55 <td class="memname"><a class="el" href="classpp_1_1_i_m_e_input_event.html#a44a2a4139e63a21757a50c731e17bacd">pp::IMEInputEvent::IMEInputEvent</a> </td>
  56 <td>(</td>
  57 <td class="paramtype">const <a class="el" href="classpp_1_1_input_event.html">InputEvent</a> &amp;&#160;</td>
  58 <td class="paramname"><em>event</em></td><td>)</td>
  59 <td><code> [explicit]</code></td>
  60 </tr>
  61 </table>
  62 </div>
  63 <div class="memdoc">
  64 <p>Constructs an IME input event object from the provided generic input event. </p>
  65 <p>If the given event is itself <a class="el" href="classpp_1_1_resource.html#a859068e34cdc2dc0b78754c255323aa9" title="This functions determines if this resource is invalid or uninitialized.">is_null()</a> or is not an IME input event, the object will be <a class="el" href="classpp_1_1_resource.html#a859068e34cdc2dc0b78754c255323aa9" title="This functions determines if this resource is invalid or uninitialized.">is_null()</a>.</p>
  66 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  67 <table class="params">
  68 <tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>A generic input event. </td></tr>
  69 </table>
  70 </dd>
  71 </dl>
  72 </div>
  73 </div>
  74 <a class="anchor" id="a9004ae92edc6bcb797dd3720acb290af"></a><!-- doxytag: member="pp::IMEInputEvent::IMEInputEvent" ref="a9004ae92edc6bcb797dd3720acb290af" args="(const InstanceHandle &amp;instance, PP_InputEvent_Type type, PP_TimeTicks time_stamp, const Var &amp;text, const std::vector&lt; uint32_t &gt; &amp;segment_offsets, int32_t target_segment, const std::pair&lt; uint32_t, uint32_t &gt; &amp;selection)" -->
  75 <div class="memitem">
  76 <div class="memproto">
  77 <table class="memname">
  78 <tr>
  79 <td class="memname"><a class="el" href="classpp_1_1_i_m_e_input_event.html#a44a2a4139e63a21757a50c731e17bacd">pp::IMEInputEvent::IMEInputEvent</a> </td>
  80 <td>(</td>
  81 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
  82 <td class="paramname"><em>instance</em>, </td>
  83 </tr>
  84 <tr>
  85 <td class="paramkey"></td>
  86 <td></td>
  87 <td class="paramtype">PP_InputEvent_Type&#160;</td>
  88 <td class="paramname"><em>type</em>, </td>
  89 </tr>
  90 <tr>
  91 <td class="paramkey"></td>
  92 <td></td>
  93 <td class="paramtype">PP_TimeTicks&#160;</td>
  94 <td class="paramname"><em>time_stamp</em>, </td>
  95 </tr>
  96 <tr>
  97 <td class="paramkey"></td>
  98 <td></td>
  99 <td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
 100 <td class="paramname"><em>text</em>, </td>
 101 </tr>
 102 <tr>
 103 <td class="paramkey"></td>
 104 <td></td>
 105 <td class="paramtype">const std::vector&lt; uint32_t &gt; &amp;&#160;</td>
 106 <td class="paramname"><em>segment_offsets</em>, </td>
 107 </tr>
 108 <tr>
 109 <td class="paramkey"></td>
 110 <td></td>
 111 <td class="paramtype">int32_t&#160;</td>
 112 <td class="paramname"><em>target_segment</em>, </td>
 113 </tr>
 114 <tr>
 115 <td class="paramkey"></td>
 116 <td></td>
 117 <td class="paramtype">const std::pair&lt; uint32_t, uint32_t &gt; &amp;&#160;</td>
 118 <td class="paramname"><em>selection</em>&#160;</td>
 119 </tr>
 120 <tr>
 121 <td></td>
 122 <td>)</td>
 123 <td></td><td></td>
 124 </tr>
 125 </table>
 126 </div>
 127 <div class="memdoc">
 128 <p>This constructor manually constructs an IME event from the provided parameters. </p>
 129 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 130 <table class="params">
 131 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance for which this event occurred.</td></tr>
 132 <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>A <code>PP_InputEvent_Type</code> identifying the type of input event. The type must be one of the ime event types.</td></tr>
 133 <tr><td class="paramdir">[in]</td><td class="paramname">time_stamp</td><td>A <code>PP_TimeTicks</code> indicating the time when the event occurred.</td></tr>
 134 <tr><td class="paramdir">[in]</td><td class="paramname">text</td><td>The string returned by <code>GetText</code>.</td></tr>
 135 <tr><td class="paramdir">[in]</td><td class="paramname">segment_offsets</td><td>The array of numbers returned by <code>GetSegmentOffset</code>.</td></tr>
 136 <tr><td class="paramdir">[in]</td><td class="paramname">target_segment</td><td>The number returned by <code>GetTargetSegment</code>.</td></tr>
 137 <tr><td class="paramdir">[in]</td><td class="paramname">selection</td><td>The range returned by <code>GetSelection</code>. </td></tr>
 138 </table>
 139 </dd>
 140 </dl>
 141 </div>
 142 </div>
 143 <hr /><h2>Member Function Documentation</h2>
 144 <a class="anchor" id="aee5f2af391fd269f35271012247768ac"></a><!-- doxytag: member="pp::IMEInputEvent::GetSegmentNumber" ref="aee5f2af391fd269f35271012247768ac" args="() const " -->
 145 <div class="memitem">
 146 <div class="memproto">
 147 <table class="memname">
 148 <tr>
 149 <td class="memname">uint32_t <a class="el" href="classpp_1_1_i_m_e_input_event.html#aee5f2af391fd269f35271012247768ac">pp::IMEInputEvent::GetSegmentNumber</a> </td>
 150 <td>(</td>
 151 <td class="paramname"></td><td>)</td>
 152 <td> const</td>
 153 </tr>
 154 </table>
 155 </div>
 156 <div class="memdoc">
 157 <p>Returns the number of segments in the composition text. </p>
 158 <dl class="return"><dt><b>Returns:</b></dt><dd>The number of segments. For events other than COMPOSITION_UPDATE, returns 0. </dd></dl>
 159 </div>
 160 </div>
 161 <a class="anchor" id="a3deeed9cfbc9f2cff0cb027b870e3ce6"></a><!-- doxytag: member="pp::IMEInputEvent::GetSegmentOffset" ref="a3deeed9cfbc9f2cff0cb027b870e3ce6" args="(uint32_t index) const " -->
 162 <div class="memitem">
 163 <div class="memproto">
 164 <table class="memname">
 165 <tr>
 166 <td class="memname">uint32_t <a class="el" href="classpp_1_1_i_m_e_input_event.html#a3deeed9cfbc9f2cff0cb027b870e3ce6">pp::IMEInputEvent::GetSegmentOffset</a> </td>
 167 <td>(</td>
 168 <td class="paramtype">uint32_t&#160;</td>
 169 <td class="paramname"><em>index</em></td><td>)</td>
 170 <td> const</td>
 171 </tr>
 172 </table>
 173 </div>
 174 <div class="memdoc">
 175 <p>Returns the position of the index-th segmentation point in the composition text. </p>
 176 <p>The position is given by a byte-offset (not a character-offset) of the string returned by <a class="el" href="classpp_1_1_i_m_e_input_event.html#ae2b82f9465fa0847af7e0214fb43232f" title="Returns the composition text as a UTF-8 string for the given IME event.">GetText()</a>. It always satisfies 0=GetSegmentOffset(0) &lt; ... &lt; GetSegmentOffset(i) &lt; GetSegmentOffset(i+1) &lt; ... &lt; GetSegmentOffset(<a class="el" href="classpp_1_1_i_m_e_input_event.html#aee5f2af391fd269f35271012247768ac" title="Returns the number of segments in the composition text.">GetSegmentNumber()</a>)=(byte-length of <a class="el" href="classpp_1_1_i_m_e_input_event.html#ae2b82f9465fa0847af7e0214fb43232f" title="Returns the composition text as a UTF-8 string for the given IME event.">GetText()</a>). Note that [GetSegmentOffset(i), GetSegmentOffset(i+1)) represents the range of the i-th segment, and hence <a class="el" href="classpp_1_1_i_m_e_input_event.html#aee5f2af391fd269f35271012247768ac" title="Returns the number of segments in the composition text.">GetSegmentNumber()</a> can be a valid argument to this function instead of an off-by-1 error.</p>
 177 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 178 <table class="params">
 179 <tr><td class="paramdir">[in]</td><td class="paramname">ime_event</td><td>A <code>PP_Resource</code> corresponding to an IME event.</td></tr>
 180 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>An integer indicating a segment.</td></tr>
 181 </table>
 182 </dd>
 183 </dl>
 184 <dl class="return"><dt><b>Returns:</b></dt><dd>The byte-offset of the segmentation point. If the event is not COMPOSITION_UPDATE or index is out of range, returns 0. </dd></dl>
 185 </div>
 186 </div>
 187 <a class="anchor" id="a94e9078036a3bdf0af6d5508d9115cf6"></a><!-- doxytag: member="pp::IMEInputEvent::GetSelection" ref="a94e9078036a3bdf0af6d5508d9115cf6" args="(uint32_t *start, uint32_t *end) const " -->
 188 <div class="memitem">
 189 <div class="memproto">
 190 <table class="memname">
 191 <tr>
 192 <td class="memname">void <a class="el" href="classpp_1_1_i_m_e_input_event.html#a94e9078036a3bdf0af6d5508d9115cf6">pp::IMEInputEvent::GetSelection</a> </td>
 193 <td>(</td>
 194 <td class="paramtype">uint32_t *&#160;</td>
 195 <td class="paramname"><em>start</em>, </td>
 196 </tr>
 197 <tr>
 198 <td class="paramkey"></td>
 199 <td></td>
 200 <td class="paramtype">uint32_t *&#160;</td>
 201 <td class="paramname"><em>end</em>&#160;</td>
 202 </tr>
 203 <tr>
 204 <td></td>
 205 <td>)</td>
 206 <td></td><td> const</td>
 207 </tr>
 208 </table>
 209 </div>
 210 <div class="memdoc">
 211 <p>Obtains the range selected by caret in the composition text. </p>
 212 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 213 <table class="params">
 214 <tr><td class="paramdir">[out]</td><td class="paramname">start</td><td>An integer indicating a start offset of selection range.</td></tr>
 215 <tr><td class="paramdir">[out]</td><td class="paramname">end</td><td>An integer indicating an end offset of selection range. </td></tr>
 216 </table>
 217 </dd>
 218 </dl>
 219 </div>
 220 </div>
 221 <a class="anchor" id="ada4e768c2aea31e443d8bc9d5e4a9f36"></a><!-- doxytag: member="pp::IMEInputEvent::GetTargetSegment" ref="ada4e768c2aea31e443d8bc9d5e4a9f36" args="() const " -->
 222 <div class="memitem">
 223 <div class="memproto">
 224 <table class="memname">
 225 <tr>
 226 <td class="memname">int32_t <a class="el" href="classpp_1_1_i_m_e_input_event.html#ada4e768c2aea31e443d8bc9d5e4a9f36">pp::IMEInputEvent::GetTargetSegment</a> </td>
 227 <td>(</td>
 228 <td class="paramname"></td><td>)</td>
 229 <td> const</td>
 230 </tr>
 231 </table>
 232 </div>
 233 <div class="memdoc">
 234 <p>Returns the index of the current target segment of composition. </p>
 235 <dl class="return"><dt><b>Returns:</b></dt><dd>An integer indicating the index of the target segment. When there is no active target segment, or the event is not COMPOSITION_UPDATE, returns -1. </dd></dl>
 236 </div>
 237 </div>
 238 <a class="anchor" id="ae2b82f9465fa0847af7e0214fb43232f"></a><!-- doxytag: member="pp::IMEInputEvent::GetText" ref="ae2b82f9465fa0847af7e0214fb43232f" args="() const " -->
 239 <div class="memitem">
 240 <div class="memproto">
 241 <table class="memname">
 242 <tr>
 243 <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_i_m_e_input_event.html#ae2b82f9465fa0847af7e0214fb43232f">pp::IMEInputEvent::GetText</a> </td>
 244 <td>(</td>
 245 <td class="paramname"></td><td>)</td>
 246 <td> const</td>
 247 </tr>
 248 </table>
 249 </div>
 250 <div class="memdoc">
 251 <p>Returns the composition text as a UTF-8 string for the given IME event. </p>
 252 <dl class="return"><dt><b>Returns:</b></dt><dd>A string var representing the composition text. For non-IME input events the return value will be an undefined var. </dd></dl>
 253 </div>
 254 </div>
 255 <hr />The documentation for this class was generated from the following file:<ul>
 256 <li><a class="el" href="input__event_8h.html">input_event.h</a></li>
 257 </ul>
 258 </div><!-- contents -->
 259 </div>
 260 {{/partials.standard_nacl_api}}