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

   1 {{+bindTo:partials.standard_nacl_api}}
   2 <h1>pp::KeyboardInputEvent 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::KeyboardInputEvent" --><!-- doxytag: inherits="pp::InputEvent" --><div class="dynheader">
  14 Inheritance diagram for pp::KeyboardInputEvent:</div>
  15 <div class="dyncontent">
  16 <div class="center"><img src="classpp_1_1_keyboard_input_event__inherit__graph.png" border="0" usemap="#pp_1_1_keyboard_input_event_inherit__map" alt="Inheritance graph" /></div>
  17 <map name="pp_1_1_keyboard_input_event_inherit__map" id="pp_1_1_keyboard_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="35,80,149,107"></area><area shape="rect" id="node3" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="40,5,144,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_keyboard_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_keyboard_input_event.html#a07197d3bf22df18ab201dd593ec14b46">KeyboardInputEvent</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_keyboard_input_event.html#ae0817f051306805db56dbbf837da57bb">KeyboardInputEvent</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_keyboard_input_event.html#a3adab90fc81122554ec878ab2fb8d506">KeyboardInputEvent</a> (const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;instance, PP_InputEvent_Type type, PP_TimeTicks time_stamp, uint32_t modifiers, uint32_t key_code, const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;character_text)</td></tr>
  27 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_keyboard_input_event.html#a95f16a4bee09b84cb38614f457038dca">KeyboardInputEvent</a> (const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;instance, PP_InputEvent_Type type, PP_TimeTicks time_stamp, uint32_t modifiers, uint32_t key_code, const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;character_text, const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;code)</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_keyboard_input_event.html#a5d6c799091a2adce32d3e20fd1a63017">GetKeyCode</a> () const </td></tr>
  29 <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_keyboard_input_event.html#a343bd835af56bd7875b0d82361680e4a">GetCharacterText</a> () const </td></tr>
  30 <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_keyboard_input_event.html#ad65274e6cb38165fa7bb5d03f2a76b93">GetCode</a> () const </td></tr>
  31 </table>
  32 <hr /><h2>Constructor &amp; Destructor Documentation</h2>
  33 <a class="anchor" id="a07197d3bf22df18ab201dd593ec14b46"></a><!-- doxytag: member="pp::KeyboardInputEvent::KeyboardInputEvent" ref="a07197d3bf22df18ab201dd593ec14b46" args="()" -->
  34 <div class="memitem">
  35 <div class="memproto">
  36 <table class="memname">
  37 <tr>
  38 <td class="memname"><a class="el" href="classpp_1_1_keyboard_input_event.html#a07197d3bf22df18ab201dd593ec14b46">pp::KeyboardInputEvent::KeyboardInputEvent</a> </td>
  39 <td>(</td>
  40 <td class="paramname"></td><td>)</td>
  41 <td></td>
  42 </tr>
  43 </table>
  44 </div>
  45 <div class="memdoc">
  46 <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> keyboard input event object. </p>
  47 </div>
  48 </div>
  49 <a class="anchor" id="ae0817f051306805db56dbbf837da57bb"></a><!-- doxytag: member="pp::KeyboardInputEvent::KeyboardInputEvent" ref="ae0817f051306805db56dbbf837da57bb" args="(const InputEvent &amp;event)" -->
  50 <div class="memitem">
  51 <div class="memproto">
  52 <table class="memname">
  53 <tr>
  54 <td class="memname"><a class="el" href="classpp_1_1_keyboard_input_event.html#a07197d3bf22df18ab201dd593ec14b46">pp::KeyboardInputEvent::KeyboardInputEvent</a> </td>
  55 <td>(</td>
  56 <td class="paramtype">const <a class="el" href="classpp_1_1_input_event.html">InputEvent</a> &amp;&#160;</td>
  57 <td class="paramname"><em>event</em></td><td>)</td>
  58 <td><code> [explicit]</code></td>
  59 </tr>
  60 </table>
  61 </div>
  62 <div class="memdoc">
  63 <p>Constructs a keyboard input event object from the provided generic input event. </p>
  64 <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 a keyboard input event, the keybaord 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>
  65 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  66 <table class="params">
  67 <tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>A generic input event. </td></tr>
  68 </table>
  69 </dd>
  70 </dl>
  71 </div>
  72 </div>
  73 <a class="anchor" id="a3adab90fc81122554ec878ab2fb8d506"></a><!-- doxytag: member="pp::KeyboardInputEvent::KeyboardInputEvent" ref="a3adab90fc81122554ec878ab2fb8d506" args="(const InstanceHandle &amp;instance, PP_InputEvent_Type type, PP_TimeTicks time_stamp, uint32_t modifiers, uint32_t key_code, const Var &amp;character_text)" -->
  74 <div class="memitem">
  75 <div class="memproto">
  76 <table class="memname">
  77 <tr>
  78 <td class="memname"><a class="el" href="classpp_1_1_keyboard_input_event.html#a07197d3bf22df18ab201dd593ec14b46">pp::KeyboardInputEvent::KeyboardInputEvent</a> </td>
  79 <td>(</td>
  80 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
  81 <td class="paramname"><em>instance</em>, </td>
  82 </tr>
  83 <tr>
  84 <td class="paramkey"></td>
  85 <td></td>
  86 <td class="paramtype">PP_InputEvent_Type&#160;</td>
  87 <td class="paramname"><em>type</em>, </td>
  88 </tr>
  89 <tr>
  90 <td class="paramkey"></td>
  91 <td></td>
  92 <td class="paramtype">PP_TimeTicks&#160;</td>
  93 <td class="paramname"><em>time_stamp</em>, </td>
  94 </tr>
  95 <tr>
  96 <td class="paramkey"></td>
  97 <td></td>
  98 <td class="paramtype">uint32_t&#160;</td>
  99 <td class="paramname"><em>modifiers</em>, </td>
 100 </tr>
 101 <tr>
 102 <td class="paramkey"></td>
 103 <td></td>
 104 <td class="paramtype">uint32_t&#160;</td>
 105 <td class="paramname"><em>key_code</em>, </td>
 106 </tr>
 107 <tr>
 108 <td class="paramkey"></td>
 109 <td></td>
 110 <td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
 111 <td class="paramname"><em>character_text</em>&#160;</td>
 112 </tr>
 113 <tr>
 114 <td></td>
 115 <td>)</td>
 116 <td></td><td></td>
 117 </tr>
 118 </table>
 119 </div>
 120 <div class="memdoc">
 121 <p>Constructs a keyboard input even from the given parameters. </p>
 122 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 123 <table class="params">
 124 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance for which this event occurred.</td></tr>
 125 <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>
 126 <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>
 127 <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>
 128 <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>
 129 <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>
 130 </table>
 131 </dd>
 132 </dl>
 133 </div>
 134 </div>
 135 <a class="anchor" id="a95f16a4bee09b84cb38614f457038dca"></a><!-- doxytag: member="pp::KeyboardInputEvent::KeyboardInputEvent" ref="a95f16a4bee09b84cb38614f457038dca" args="(const InstanceHandle &amp;instance, PP_InputEvent_Type type, PP_TimeTicks time_stamp, uint32_t modifiers, uint32_t key_code, const Var &amp;character_text, const Var &amp;code)" -->
 136 <div class="memitem">
 137 <div class="memproto">
 138 <table class="memname">
 139 <tr>
 140 <td class="memname"><a class="el" href="classpp_1_1_keyboard_input_event.html#a07197d3bf22df18ab201dd593ec14b46">pp::KeyboardInputEvent::KeyboardInputEvent</a> </td>
 141 <td>(</td>
 142 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
 143 <td class="paramname"><em>instance</em>, </td>
 144 </tr>
 145 <tr>
 146 <td class="paramkey"></td>
 147 <td></td>
 148 <td class="paramtype">PP_InputEvent_Type&#160;</td>
 149 <td class="paramname"><em>type</em>, </td>
 150 </tr>
 151 <tr>
 152 <td class="paramkey"></td>
 153 <td></td>
 154 <td class="paramtype">PP_TimeTicks&#160;</td>
 155 <td class="paramname"><em>time_stamp</em>, </td>
 156 </tr>
 157 <tr>
 158 <td class="paramkey"></td>
 159 <td></td>
 160 <td class="paramtype">uint32_t&#160;</td>
 161 <td class="paramname"><em>modifiers</em>, </td>
 162 </tr>
 163 <tr>
 164 <td class="paramkey"></td>
 165 <td></td>
 166 <td class="paramtype">uint32_t&#160;</td>
 167 <td class="paramname"><em>key_code</em>, </td>
 168 </tr>
 169 <tr>
 170 <td class="paramkey"></td>
 171 <td></td>
 172 <td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
 173 <td class="paramname"><em>character_text</em>, </td>
 174 </tr>
 175 <tr>
 176 <td class="paramkey"></td>
 177 <td></td>
 178 <td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
 179 <td class="paramname"><em>code</em>&#160;</td>
 180 </tr>
 181 <tr>
 182 <td></td>
 183 <td>)</td>
 184 <td></td><td></td>
 185 </tr>
 186 </table>
 187 </div>
 188 <div class="memdoc">
 189 <p>Constructs a keyboard input even from the given parameters. </p>
 190 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 191 <table class="params">
 192 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance for which this event occurred.</td></tr>
 193 <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>
 194 <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>
 195 <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>
 196 <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>
 197 <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>
 198 <tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>This value reflects the DOM KeyboardEvent <code>code</code> field, which identifies the physical key associated with the event. </td></tr>
 199 </table>
 200 </dd>
 201 </dl>
 202 </div>
 203 </div>
 204 <hr /><h2>Member Function Documentation</h2>
 205 <a class="anchor" id="a343bd835af56bd7875b0d82361680e4a"></a><!-- doxytag: member="pp::KeyboardInputEvent::GetCharacterText" ref="a343bd835af56bd7875b0d82361680e4a" args="() const " -->
 206 <div class="memitem">
 207 <div class="memproto">
 208 <table class="memname">
 209 <tr>
 210 <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_keyboard_input_event.html#a343bd835af56bd7875b0d82361680e4a">pp::KeyboardInputEvent::GetCharacterText</a> </td>
 211 <td>(</td>
 212 <td class="paramname"></td><td>)</td>
 213 <td> const</td>
 214 </tr>
 215 </table>
 216 </div>
 217 <div class="memdoc">
 218 <p>Returns the typed character for the given character event. </p>
 219 <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>
 220 </div>
 221 </div>
 222 <a class="anchor" id="ad65274e6cb38165fa7bb5d03f2a76b93"></a><!-- doxytag: member="pp::KeyboardInputEvent::GetCode" ref="ad65274e6cb38165fa7bb5d03f2a76b93" args="() const " -->
 223 <div class="memitem">
 224 <div class="memproto">
 225 <table class="memname">
 226 <tr>
 227 <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_keyboard_input_event.html#ad65274e6cb38165fa7bb5d03f2a76b93">pp::KeyboardInputEvent::GetCode</a> </td>
 228 <td>(</td>
 229 <td class="paramname"></td><td>)</td>
 230 <td> const</td>
 231 </tr>
 232 </table>
 233 </div>
 234 <div class="memdoc">
 235 <p>Returns the DOM |code| for the keyboard event. </p>
 236 <dl class="return"><dt><b>Returns:</b></dt><dd>A string var representing a physical key that was pressed to generate this event. </dd></dl>
 237 </div>
 238 </div>
 239 <a class="anchor" id="a5d6c799091a2adce32d3e20fd1a63017"></a><!-- doxytag: member="pp::KeyboardInputEvent::GetKeyCode" ref="a5d6c799091a2adce32d3e20fd1a63017" args="() const " -->
 240 <div class="memitem">
 241 <div class="memproto">
 242 <table class="memname">
 243 <tr>
 244 <td class="memname">uint32_t <a class="el" href="classpp_1_1_keyboard_input_event.html#a5d6c799091a2adce32d3e20fd1a63017">pp::KeyboardInputEvent::GetKeyCode</a> </td>
 245 <td>(</td>
 246 <td class="paramname"></td><td>)</td>
 247 <td> const</td>
 248 </tr>
 249 </table>
 250 </div>
 251 <div class="memdoc">
 252 <p>Returns the DOM keyCode field for the keyboard event. </p>
 253 <p>Chrome populates this with the Windows-style Virtual Key code of the key. </p>
 254 </div>
 255 </div>
 256 <hr />The documentation for this class was generated from the following file:<ul>
 257 <li><a class="el" href="input__event_8h.html">input_event.h</a></li>
 258 </ul>
 259 </div><!-- contents -->
 260 </div>
 261 {{/partials.standard_nacl_api}}