src/native_client_sdk/doc_generated/pepper_dev/c/struct_p_p_b___i_m_e_input_event__1__0.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>PPB_IMEInputEvent Struct 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 </div>
  10 <!--header-->
  11 <div class="contents">
  12 <!-- doxytag: class="PPB_IMEInputEvent" --><h2>
  13 Data Fields</h2><table class="memberdecls">
  14
  15 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#ad4bd2c64c71c9af07c110e47d64d94c4">Create</a> )(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance, <a class="el" href="group___enums.html#gaca7296cfec99fcb6646b7144d1d6a0c5">PP_InputEvent_Type</a> type, <a class="el" href="group___typedefs.html#ga71cb1042cdeb38d7881b121f3b09ce94">PP_TimeTicks</a> time_stamp, struct <a class="el" href="struct_p_p___var.html">PP_Var</a> text, uint32_t segment_number, const uint32_t segment_offsets[], int32_t target_segment, uint32_t selection_start, uint32_t selection_end)</td></tr>
  16 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a73a886654b174d99af7f52c13272dce0">IsIMEInputEvent</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td></tr>
  17 <tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a107e031acc73b3c620b0d92245952e6e">GetText</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> ime_event)</td></tr>
  18 <tr><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a1b3d8e023aa9400dff5b3a32a49cc018">GetSegmentNumber</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> ime_event)</td></tr>
  19 <tr><td class="memItemLeft" align="right" valign="top">uint32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a5d469ddc9be36e60eda5ab74878da205">GetSegmentOffset</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> ime_event, uint32_t index)</td></tr>
  20 <tr><td class="memItemLeft" align="right" valign="top">int32_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#ac4891be932c004cff409df47fe4627fa">GetTargetSegment</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> ime_event)</td></tr>
  21 <tr><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a42150bcee1b6416ec89780343ce2b30a">GetSelection</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> ime_event, uint32_t *start, uint32_t *end)</td></tr>
  22 </table>
  23 <hr /><h2>Field Documentation</h2>
  24 <a class="anchor" id="ad4bd2c64c71c9af07c110e47d64d94c4"></a><!-- doxytag: member="PPB_IMEInputEvent::Create" ref="ad4bd2c64c71c9af07c110e47d64d94c4" args=")(PP_Instance instance, PP_InputEvent_Type type, PP_TimeTicks time_stamp, struct PP_Var text, uint32_t segment_number, const uint32_t segment_offsets[], int32_t target_segment, uint32_t selection_start, uint32_t selection_end)" -->
  25 <div class="memitem">
  26 <div class="memproto">
  27 <table class="memname">
  28 <tr>
  29 <td class="memname"><a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a>(* <a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#ad4bd2c64c71c9af07c110e47d64d94c4">PPB_IMEInputEvent::Create</a>)(<a class="el" href="group___typedefs.html#ga89b662403e6a687bb914b80114c0d19d">PP_Instance</a> instance, <a class="el" href="group___enums.html#gaca7296cfec99fcb6646b7144d1d6a0c5">PP_InputEvent_Type</a> type, <a class="el" href="group___typedefs.html#ga71cb1042cdeb38d7881b121f3b09ce94">PP_TimeTicks</a> time_stamp, struct <a class="el" href="struct_p_p___var.html">PP_Var</a> text, uint32_t segment_number, const uint32_t segment_offsets[], int32_t target_segment, uint32_t selection_start, uint32_t selection_end)</td>
  30 </tr>
  31 </table>
  32 </div>
  33 <div class="memdoc">
  34 <p><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#ad4bd2c64c71c9af07c110e47d64d94c4" title="Create() creates an IME input event with the given parameters.">Create()</a> creates an IME input event with the given parameters. </p>
  35 <p>Normally you will get an IME event passed through the <code>HandleInputEvent</code> and will not need to create them, but some applications may want to create their own for internal use.</p>
  36 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  37 <table class="params">
  38 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance for which this event occurred.</td></tr>
  39 <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>
  40 <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>
  41 <tr><td class="paramdir">[in]</td><td class="paramname">text</td><td>The string returned by <code>GetText</code>.</td></tr>
  42 <tr><td class="paramdir">[in]</td><td class="paramname">segment_number</td><td>The number returned by <code>GetSegmentNumber</code>.</td></tr>
  43 <tr><td class="paramdir">[in]</td><td class="paramname">segment_offsets</td><td>The array of numbers returned by <code>GetSegmentOffset</code>. If <code>segment_number</code> is zero, the number of elements of the array should be zero. If <code>segment_number</code> is non-zero, the length of the array must be <code>segment_number</code> + 1.</td></tr>
  44 <tr><td class="paramdir">[in]</td><td class="paramname">target_segment</td><td>The number returned by <code>GetTargetSegment</code>.</td></tr>
  45 <tr><td class="paramdir">[in]</td><td class="paramname">selection_start</td><td>The start index returned by <code>GetSelection</code>.</td></tr>
  46 <tr><td class="paramdir">[in]</td><td class="paramname">selection_end</td><td>The end index returned by <code>GetSelection</code>.</td></tr>
  47 </table>
  48 </dd>
  49 </dl>
  50 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_Resource</code> containing the new IME input event. </dd></dl>
  51 </div>
  52 </div>
  53 <a class="anchor" id="a1b3d8e023aa9400dff5b3a32a49cc018"></a><!-- doxytag: member="PPB_IMEInputEvent::GetSegmentNumber" ref="a1b3d8e023aa9400dff5b3a32a49cc018" args=")(PP_Resource ime_event)" -->
  54 <div class="memitem">
  55 <div class="memproto">
  56 <table class="memname">
  57 <tr>
  58 <td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a1b3d8e023aa9400dff5b3a32a49cc018">PPB_IMEInputEvent::GetSegmentNumber</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> ime_event)</td>
  59 </tr>
  60 </table>
  61 </div>
  62 <div class="memdoc">
  63 <p><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a1b3d8e023aa9400dff5b3a32a49cc018" title="GetSegmentNumber() returns the number of segments in the composition text.">GetSegmentNumber()</a> returns the number of segments in the composition text. </p>
  64 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  65 <table class="params">
  66 <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>
  67 </table>
  68 </dd>
  69 </dl>
  70 <dl class="return"><dt><b>Returns:</b></dt><dd>The number of segments. For events other than COMPOSITION_UPDATE, returns 0. </dd></dl>
  71 </div>
  72 </div>
  73 <a class="anchor" id="a5d469ddc9be36e60eda5ab74878da205"></a><!-- doxytag: member="PPB_IMEInputEvent::GetSegmentOffset" ref="a5d469ddc9be36e60eda5ab74878da205" args=")(PP_Resource ime_event, uint32_t index)" -->
  74 <div class="memitem">
  75 <div class="memproto">
  76 <table class="memname">
  77 <tr>
  78 <td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a5d469ddc9be36e60eda5ab74878da205">PPB_IMEInputEvent::GetSegmentOffset</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> ime_event, uint32_t index)</td>
  79 </tr>
  80 </table>
  81 </div>
  82 <div class="memdoc">
  83 <p><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a5d469ddc9be36e60eda5ab74878da205" title="GetSegmentOffset() returns the position of the index-th segmentation point in the composition text...">GetSegmentOffset()</a> returns the position of the index-th segmentation point in the composition text. </p>
  84 <p>The position is given by a byte-offset (not a character-offset) of the string returned by <a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a107e031acc73b3c620b0d92245952e6e" title="GetText() 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="struct_p_p_b___i_m_e_input_event__1__0.html#a1b3d8e023aa9400dff5b3a32a49cc018" title="GetSegmentNumber() returns the number of segments in the composition text.">GetSegmentNumber()</a>)=(byte-length of <a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a107e031acc73b3c620b0d92245952e6e" title="GetText() 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="struct_p_p_b___i_m_e_input_event__1__0.html#a1b3d8e023aa9400dff5b3a32a49cc018" title="GetSegmentNumber() 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>
  85 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  86 <table class="params">
  87 <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>
  88 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>An integer indicating a segment.</td></tr>
  89 </table>
  90 </dd>
  91 </dl>
  92 <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>
  93 </div>
  94 </div>
  95 <a class="anchor" id="a42150bcee1b6416ec89780343ce2b30a"></a><!-- doxytag: member="PPB_IMEInputEvent::GetSelection" ref="a42150bcee1b6416ec89780343ce2b30a" args=")(PP_Resource ime_event, uint32_t *start, uint32_t *end)" -->
  96 <div class="memitem">
  97 <div class="memproto">
  98 <table class="memname">
  99 <tr>
 100 <td class="memname">void(* <a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a42150bcee1b6416ec89780343ce2b30a">PPB_IMEInputEvent::GetSelection</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> ime_event, uint32_t *start, uint32_t *end)</td>
 101 </tr>
 102 </table>
 103 </div>
 104 <div class="memdoc">
 105 <p><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a42150bcee1b6416ec89780343ce2b30a" title="GetSelection() returns the range selected by caret in the composition text.">GetSelection()</a> returns the range selected by caret in the composition text. </p>
 106 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 107 <table class="params">
 108 <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>
 109 <tr><td class="paramdir">[out]</td><td class="paramname">start</td><td>The start position of the current selection.</td></tr>
 110 <tr><td class="paramdir">[out]</td><td class="paramname">end</td><td>The end position of the current selection. </td></tr>
 111 </table>
 112 </dd>
 113 </dl>
 114 </div>
 115 </div>
 116 <a class="anchor" id="ac4891be932c004cff409df47fe4627fa"></a><!-- doxytag: member="PPB_IMEInputEvent::GetTargetSegment" ref="ac4891be932c004cff409df47fe4627fa" args=")(PP_Resource ime_event)" -->
 117 <div class="memitem">
 118 <div class="memproto">
 119 <table class="memname">
 120 <tr>
 121 <td class="memname">int32_t(* <a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#ac4891be932c004cff409df47fe4627fa">PPB_IMEInputEvent::GetTargetSegment</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> ime_event)</td>
 122 </tr>
 123 </table>
 124 </div>
 125 <div class="memdoc">
 126 <p><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#ac4891be932c004cff409df47fe4627fa" title="GetTargetSegment() returns the index of the current target segment of composition.">GetTargetSegment()</a> returns the index of the current target segment of composition. </p>
 127 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 128 <table class="params">
 129 <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>
 130 </table>
 131 </dd>
 132 </dl>
 133 <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>
 134 </div>
 135 </div>
 136 <a class="anchor" id="a107e031acc73b3c620b0d92245952e6e"></a><!-- doxytag: member="PPB_IMEInputEvent::GetText" ref="a107e031acc73b3c620b0d92245952e6e" args=")(PP_Resource ime_event)" -->
 137 <div class="memitem">
 138 <div class="memproto">
 139 <table class="memname">
 140 <tr>
 141 <td class="memname">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(* <a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a107e031acc73b3c620b0d92245952e6e">PPB_IMEInputEvent::GetText</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> ime_event)<code> [read]</code></td>
 142 </tr>
 143 </table>
 144 </div>
 145 <div class="memdoc">
 146 <p><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a107e031acc73b3c620b0d92245952e6e" title="GetText() returns the composition text as a UTF-8 string for the given IME event.">GetText()</a> returns the composition text as a UTF-8 string for the given IME event. </p>
 147 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 148 <table class="params">
 149 <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>
 150 </table>
 151 </dd>
 152 </dl>
 153 <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>
 154 </div>
 155 </div>
 156 <a class="anchor" id="a73a886654b174d99af7f52c13272dce0"></a><!-- doxytag: member="PPB_IMEInputEvent::IsIMEInputEvent" ref="a73a886654b174d99af7f52c13272dce0" args=")(PP_Resource resource)" -->
 157 <div class="memitem">
 158 <div class="memproto">
 159 <table class="memname">
 160 <tr>
 161 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a73a886654b174d99af7f52c13272dce0">PPB_IMEInputEvent::IsIMEInputEvent</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td>
 162 </tr>
 163 </table>
 164 </div>
 165 <div class="memdoc">
 166 <p><a class="el" href="struct_p_p_b___i_m_e_input_event__1__0.html#a73a886654b174d99af7f52c13272dce0" title="IsIMEInputEvent() determines if a resource is an IME event.">IsIMEInputEvent()</a> determines if a resource is an IME event. </p>
 167 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 168 <table class="params">
 169 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to an event.</td></tr>
 170 </table>
 171 </dd>
 172 </dl>
 173 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_TRUE</code> if the given resource is a valid input event. </dd></dl>
 174 </div>
 175 </div>
 176 <hr />The documentation for this struct was generated from the following file:<ul>
 177 <li><a class="el" href="ppb__input__event_8h.html">ppb_input_event.h</a></li>
 178 </ul>
 179 </div><!-- contents -->
 180 </div>
 181 {{/partials.standard_nacl_article}}