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

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>PPB_KeyboardInputEvent 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_KeyboardInputEvent" --><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___keyboard_input_event__1__0.html#a4363d350778229bf8651c14321fc218e">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, uint32_t modifiers, uint32_t key_code, struct <a class="el" href="struct_p_p___var.html">PP_Var</a> character_text)</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___keyboard_input_event__1__0.html#aa8adda758cb3b4fcaea97862eb8f5e4f">IsKeyboardInputEvent</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td></tr>
  15 <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___keyboard_input_event__1__0.html#a6fe1d45a20581608f1d8721e91130876">GetKeyCode</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> key_event)</td></tr>
  16 <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___keyboard_input_event__1__0.html#a8a03b57ca3bde680dc8065c1d4a2099a">GetCharacterText</a> )(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> character_event)</td></tr>
  17 </table>
  18 <hr /><a name="details" id="details"></a><h2>Detailed Description</h2>
  19 <div class="textblock"><p>The <code>PPB_KeyboardInputEvent</code> interface contains pointers to several functions related to keyboard input events. </p>
  20 </div><hr /><h2>Field Documentation</h2>
  21 <a class="anchor" id="a4363d350778229bf8651c14321fc218e"></a><!-- doxytag: member="PPB_KeyboardInputEvent::Create" ref="a4363d350778229bf8651c14321fc218e" args=")(PP_Instance instance, PP_InputEvent_Type type, PP_TimeTicks time_stamp, uint32_t modifiers, uint32_t key_code, struct PP_Var character_text)" -->
  22 <div class="memitem">
  23 <div class="memproto">
  24 <table class="memname">
  25 <tr>
  26 <td class="memname"><a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a>(* <a class="el" href="struct_p_p_b___keyboard_input_event__1__0.html#a4363d350778229bf8651c14321fc218e">PPB_KeyboardInputEvent::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, uint32_t modifiers, uint32_t key_code, struct <a class="el" href="struct_p_p___var.html">PP_Var</a> character_text)</td>
  27 </tr>
  28 </table>
  29 </div>
  30 <div class="memdoc">
  31 <p>Creates a keyboard input event with the given parameters. </p>
  32 <p>Normally you will get a keyboard event passed through the HandleInputEvent and will not need to create them, but some applications may want to create their own for internal use. The type must be one of the keyboard event types.</p>
  33 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  34 <table class="params">
  35 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance for which this event occurred.</td></tr>
  36 <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>A <code>PP_InputEvent_Type</code> identifying the type of input event.</td></tr>
  37 <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>
  38 <tr><td class="paramdir">[in]</td><td class="paramname">modifiers</td><td>A bit field combination of the <code>PP_InputEvent_Modifier</code> flags.</td></tr>
  39 <tr><td class="paramdir">[in]</td><td class="paramname">key_code</td><td>This value reflects the DOM KeyboardEvent <code>keyCode</code> field. Chrome populates this with the Windows-style Virtual Key code of the key.</td></tr>
  40 <tr><td class="paramdir">[in]</td><td class="paramname">character_text</td><td>This value represents the typed character as a UTF-8 string.</td></tr>
  41 </table>
  42 </dd>
  43 </dl>
  44 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>PP_Resource</code> containing the new keyboard input event. </dd></dl>
  45 </div>
  46 </div>
  47 <a class="anchor" id="a8a03b57ca3bde680dc8065c1d4a2099a"></a><!-- doxytag: member="PPB_KeyboardInputEvent::GetCharacterText" ref="a8a03b57ca3bde680dc8065c1d4a2099a" args=")(PP_Resource character_event)" -->
  48 <div class="memitem">
  49 <div class="memproto">
  50 <table class="memname">
  51 <tr>
  52 <td class="memname">struct <a class="el" href="struct_p_p___var.html">PP_Var</a>(* <a class="el" href="struct_p_p_b___keyboard_input_event__1__0.html#a8a03b57ca3bde680dc8065c1d4a2099a">PPB_KeyboardInputEvent::GetCharacterText</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> character_event)<code> [read]</code></td>
  53 </tr>
  54 </table>
  55 </div>
  56 <div class="memdoc">
  57 <p><a class="el" href="struct_p_p_b___keyboard_input_event__1__0.html#a8a03b57ca3bde680dc8065c1d4a2099a" title="GetCharacterText() returns the typed character as a UTF-8 string for the given character event...">GetCharacterText()</a> returns the typed character as a UTF-8 string for the given character event. </p>
  58 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  59 <table class="params">
  60 <tr><td class="paramdir">[in]</td><td class="paramname">character_event</td><td>A <code>PP_Resource</code> corresponding to a keyboard event.</td></tr>
  61 </table>
  62 </dd>
  63 </dl>
  64 <dl class="return"><dt><b>Returns:</b></dt><dd>A string var representing a single typed character for character input events. For non-character input events the return value will be an undefined var. </dd></dl>
  65 </div>
  66 </div>
  67 <a class="anchor" id="a6fe1d45a20581608f1d8721e91130876"></a><!-- doxytag: member="PPB_KeyboardInputEvent::GetKeyCode" ref="a6fe1d45a20581608f1d8721e91130876" args=")(PP_Resource key_event)" -->
  68 <div class="memitem">
  69 <div class="memproto">
  70 <table class="memname">
  71 <tr>
  72 <td class="memname">uint32_t(* <a class="el" href="struct_p_p_b___keyboard_input_event__1__0.html#a6fe1d45a20581608f1d8721e91130876">PPB_KeyboardInputEvent::GetKeyCode</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> key_event)</td>
  73 </tr>
  74 </table>
  75 </div>
  76 <div class="memdoc">
  77 <p><a class="el" href="struct_p_p_b___keyboard_input_event__1__0.html#a6fe1d45a20581608f1d8721e91130876" title="GetKeyCode() returns the DOM keyCode field for the keyboard event.">GetKeyCode()</a> returns the DOM keyCode field for the keyboard event. </p>
  78 <p>Chrome populates this with the Windows-style Virtual Key code of the key.</p>
  79 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  80 <table class="params">
  81 <tr><td class="paramdir">[in]</td><td class="paramname">key_event</td><td>A <code>PP_Resource</code> corresponding to a keyboard event.</td></tr>
  82 </table>
  83 </dd>
  84 </dl>
  85 <dl class="return"><dt><b>Returns:</b></dt><dd>The DOM keyCode field for the keyboard event. </dd></dl>
  86 </div>
  87 </div>
  88 <a class="anchor" id="aa8adda758cb3b4fcaea97862eb8f5e4f"></a><!-- doxytag: member="PPB_KeyboardInputEvent::IsKeyboardInputEvent" ref="aa8adda758cb3b4fcaea97862eb8f5e4f" args=")(PP_Resource resource)" -->
  89 <div class="memitem">
  90 <div class="memproto">
  91 <table class="memname">
  92 <tr>
  93 <td class="memname"><a class="el" href="group___enums.html#ga4f272d99be14aacafe08dfd4ef830918">PP_Bool</a>(* <a class="el" href="struct_p_p_b___keyboard_input_event__1__0.html#aa8adda758cb3b4fcaea97862eb8f5e4f">PPB_KeyboardInputEvent::IsKeyboardInputEvent</a>)(<a class="el" href="group___typedefs.html#gafdc3895ee80f4750d0d95ae1b677e9b7">PP_Resource</a> resource)</td>
  94 </tr>
  95 </table>
  96 </div>
  97 <div class="memdoc">
  98 <p><a class="el" href="struct_p_p_b___keyboard_input_event__1__0.html#aa8adda758cb3b4fcaea97862eb8f5e4f" title="IsKeyboardInputEvent() determines if a resource is a keyboard event.">IsKeyboardInputEvent()</a> determines if a resource is a keyboard event. </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">resource</td><td>A <code>PP_Resource</code> corresponding to an event.</td></tr>
 102 </table>
 103 </dd>
 104 </dl>
 105 <dl class="return"><dt><b>Returns:</b></dt><dd><code>PP_TRUE</code> if the given resource is a valid input event. </dd></dl>
 106 </div>
 107 </div>
 108 <hr />The documentation for this struct was generated from the following file:<ul>
 109 <li><a class="el" href="ppb__input__event_8h.html">ppb_input_event.h</a></li>
 110 </ul>
 111 </div><!-- contents -->
 112 {{/partials.standard_nacl_article}}