src/native_client_sdk/doc_generated/pepper_beta/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>
   4 <!-- Generated by Doxygen 1.7.6.1 -->
   5
   6
   7 </div>
   8 <!--header-->
   9 <div class="contents">
  10 <!-- doxytag: class="PPB_IMEInputEvent" --><h2>
  11 Data Fields</h2><table class="memberdecls">
  12
  13 <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>
  14 <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>
  15 <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>
  16 <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>
  17 <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>
  18 <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>
  19 <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>
  20 </table>
  21 <hr /><h2>Field Documentation</h2>
  22 <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)" -->
  23 <div class="memitem">
  24 <div class="memproto">
  25 <table class="memname">
  26 <tr>
  27 <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>
  28 </tr>
  29 </table>
  30 </div>
  31 <div class="memdoc">
  32 <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>
  33 <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>
  34 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  35 <table class="params">
  36 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance for which this event occurred.</td></tr>
  37 <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>
  38 <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>
  39 <tr><td class="paramdir">[in]</td><td class="paramname">text</td><td>The string returned by <code>GetText</code>.</td></tr>
  40 <tr><td class="paramdir">[in]</td><td class="paramname">segment_number</td><td>The number returned by <code>GetSegmentNumber</code>.</td></tr>
  41 <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>
  42 <tr><td class="paramdir">[in]</td><td class="paramname">target_segment</td><td>The number returned by <code>GetTargetSegment</code>.</td></tr>
  43 <tr><td class="paramdir">[in]</td><td class="paramname">selection_start</td><td>The start index returned by <code>GetSelection</code>.</td></tr>
  44 <tr><td class="paramdir">[in]</td><td class="paramname">selection_end</td><td>The end index returned by <code>GetSelection</code>.</td></tr>
  45 </table>
  46 </dd>
  47 </dl>
  48 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_Resource</code> containing the new IME input event. </dd></dl>
  49 </div>
  50 </div>
  51 <a class="anchor" id="a1b3d8e023aa9400dff5b3a32a49cc018"></a><!-- doxytag: member="PPB_IMEInputEvent::GetSegmentNumber" ref="a1b3d8e023aa9400dff5b3a32a49cc018" args=")(PP_Resource ime_event)" -->
  52 <div class="memitem">
  53 <div class="memproto">
  54 <table class="memname">
  55 <tr>
  56 <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>
  57 </tr>
  58 </table>
  59 </div>
  60 <div class="memdoc">
  61 <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>
  62 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  63 <table class="params">
  64 <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>
  65 </table>
  66 </dd>
  67 </dl>
  68 <dl class="return"><dt><b>Returns:</b></dt><dd>The number of segments. For events other than COMPOSITION_UPDATE, returns 0. </dd></dl>
  69 </div>
  70 </div>
  71 <a class="anchor" id="a5d469ddc9be36e60eda5ab74878da205"></a><!-- doxytag: member="PPB_IMEInputEvent::GetSegmentOffset" ref="a5d469ddc9be36e60eda5ab74878da205" args=")(PP_Resource ime_event, uint32_t index)" -->
  72 <div class="memitem">
  73 <div class="memproto">
  74 <table class="memname">
  75 <tr>
  76 <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>
  77 </tr>
  78 </table>
  79 </div>
  80 <div class="memdoc">
  81 <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>
  82 <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>
  83 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  84 <table class="params">
  85 <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>
  86 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>An integer indicating a segment.</td></tr>
  87 </table>
  88 </dd>
  89 </dl>
  90 <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>
  91 </div>
  92 </div>
  93 <a class="anchor" id="a42150bcee1b6416ec89780343ce2b30a"></a><!-- doxytag: member="PPB_IMEInputEvent::GetSelection" ref="a42150bcee1b6416ec89780343ce2b30a" args=")(PP_Resource ime_event, uint32_t *start, uint32_t *end)" -->
  94 <div class="memitem">
  95 <div class="memproto">
  96 <table class="memname">
  97 <tr>
  98 <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>
  99 </tr>
 100 </table>
 101 </div>
 102 <div class="memdoc">
 103 <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>
 104 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 105 <table class="params">
 106 <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>
 107 <tr><td class="paramdir">[out]</td><td class="paramname">start</td><td>The start position of the current selection.</td></tr>
 108 <tr><td class="paramdir">[out]</td><td class="paramname">end</td><td>The end position of the current selection. </td></tr>
 109 </table>
 110 </dd>
 111 </dl>
 112 </div>
 113 </div>
 114 <a class="anchor" id="ac4891be932c004cff409df47fe4627fa"></a><!-- doxytag: member="PPB_IMEInputEvent::GetTargetSegment" ref="ac4891be932c004cff409df47fe4627fa" args=")(PP_Resource ime_event)" -->
 115 <div class="memitem">
 116 <div class="memproto">
 117 <table class="memname">
 118 <tr>
 119 <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>
 120 </tr>
 121 </table>
 122 </div>
 123 <div class="memdoc">
 124 <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>
 125 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 126 <table class="params">
 127 <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>
 128 </table>
 129 </dd>
 130 </dl>
 131 <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>
 132 </div>
 133 </div>
 134 <a class="anchor" id="a107e031acc73b3c620b0d92245952e6e"></a><!-- doxytag: member="PPB_IMEInputEvent::GetText" ref="a107e031acc73b3c620b0d92245952e6e" args=")(PP_Resource ime_event)" -->
 135 <div class="memitem">
 136 <div class="memproto">
 137 <table class="memname">
 138 <tr>
 139 <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>
 140 </tr>
 141 </table>
 142 </div>
 143 <div class="memdoc">
 144 <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>
 145 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 146 <table class="params">
 147 <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>
 148 </table>
 149 </dd>
 150 </dl>
 151 <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>
 152 </div>
 153 </div>
 154 <a class="anchor" id="a73a886654b174d99af7f52c13272dce0"></a><!-- doxytag: member="PPB_IMEInputEvent::IsIMEInputEvent" ref="a73a886654b174d99af7f52c13272dce0" args=")(PP_Resource resource)" -->
 155 <div class="memitem">
 156 <div class="memproto">
 157 <table class="memname">
 158 <tr>
 159 <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>
 160 </tr>
 161 </table>
 162 </div>
 163 <div class="memdoc">
 164 <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>
 165 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 166 <table class="params">
 167 <tr><td class="paramdir">[in]</td><td class="paramname">resource</td><td>A <code>PP_Resource</code> corresponding to an event.</td></tr>
 168 </table>
 169 </dd>
 170 </dl>
 171 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_TRUE</code> if the given resource is a valid input event. </dd></dl>
 172 </div>
 173 </div>
 174 <hr />The documentation for this struct was generated from the following file:<ul>
 175 <li><a class="el" href="ppb__input__event_8h.html">ppb_input_event.h</a></li>
 176 </ul>
 177 </div><!-- contents -->
 178 {{/partials.standard_nacl_article}}