1 {{+bindTo:partials.standard_nacl_article}}
2 <h1>pp::KeyboardInputEvent Class Reference</h1>
4 <!-- Generated by Doxygen 1.7.6.1 -->
10 <div class="contents">
11 <!-- doxytag: class="pp::KeyboardInputEvent" --><!-- doxytag: inherits="pp::InputEvent" --><div class="dynheader">
12 Inheritance diagram for pp::KeyboardInputEvent:</div>
13 <div class="dyncontent">
14 <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>
15 <map name="pp_1_1_keyboard_input_event_inherit__map" id="pp_1_1_keyboard_input_event_inherit__map">
16 <area shape="rect" id="node2" href="classpp_1_1_input_event.html" title="This class represents an input event resource." alt="" coords="35,83,149,112"></area><area shape="rect" id="node4" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="40,5,144,35"></area></map>
17 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
18 <p><a href="classpp_1_1_keyboard_input_event-members.html">List of all members.</a></p>
20 Public Member Functions</h2><table class="memberdecls">
22 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_keyboard_input_event.html#a07197d3bf22df18ab201dd593ec14b46">KeyboardInputEvent</a> ()</td></tr>
23 <tr><td class="memItemLeft" align="right" valign="top"> </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> &event)</td></tr>
24 <tr><td class="memItemLeft" align="right" valign="top"> </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> &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> &character_text)</td></tr>
25 <tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_keyboard_input_event.html#a5d6c799091a2adce32d3e20fd1a63017">GetKeyCode</a> () const </td></tr>
26 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_keyboard_input_event.html#a343bd835af56bd7875b0d82361680e4a">GetCharacterText</a> () const </td></tr>
28 <hr /><h2>Constructor & Destructor Documentation</h2>
29 <a class="anchor" id="a07197d3bf22df18ab201dd593ec14b46"></a><!-- doxytag: member="pp::KeyboardInputEvent::KeyboardInputEvent" ref="a07197d3bf22df18ab201dd593ec14b46" args="()" -->
31 <div class="memproto">
32 <table class="memname">
34 <td class="memname"><a class="el" href="classpp_1_1_keyboard_input_event.html#a07197d3bf22df18ab201dd593ec14b46">pp::KeyboardInputEvent::KeyboardInputEvent</a> </td>
36 <td class="paramname"></td><td>)</td>
42 <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>
45 <a class="anchor" id="ae0817f051306805db56dbbf837da57bb"></a><!-- doxytag: member="pp::KeyboardInputEvent::KeyboardInputEvent" ref="ae0817f051306805db56dbbf837da57bb" args="(const InputEvent &event)" -->
47 <div class="memproto">
48 <table class="memname">
50 <td class="memname"><a class="el" href="classpp_1_1_keyboard_input_event.html#a07197d3bf22df18ab201dd593ec14b46">pp::KeyboardInputEvent::KeyboardInputEvent</a> </td>
52 <td class="paramtype">const <a class="el" href="classpp_1_1_input_event.html">InputEvent</a> & </td>
53 <td class="paramname"><em>event</em></td><td>)</td>
54 <td><code> [explicit]</code></td>
59 <p>Constructs a keyboard input event object from the provided generic input event. </p>
60 <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>
61 <dl class="params"><dt><b>Parameters:</b></dt><dd>
62 <table class="params">
63 <tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>A generic input event. </td></tr>
69 <a class="anchor" id="a3adab90fc81122554ec878ab2fb8d506"></a><!-- doxytag: member="pp::KeyboardInputEvent::KeyboardInputEvent" ref="a3adab90fc81122554ec878ab2fb8d506" args="(const InstanceHandle &instance, PP_InputEvent_Type type, PP_TimeTicks time_stamp, uint32_t modifiers, uint32_t key_code, const Var &character_text)" -->
71 <div class="memproto">
72 <table class="memname">
74 <td class="memname"><a class="el" href="classpp_1_1_keyboard_input_event.html#a07197d3bf22df18ab201dd593ec14b46">pp::KeyboardInputEvent::KeyboardInputEvent</a> </td>
76 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> & </td>
77 <td class="paramname"><em>instance</em>, </td>
80 <td class="paramkey"></td>
82 <td class="paramtype">PP_InputEvent_Type </td>
83 <td class="paramname"><em>type</em>, </td>
86 <td class="paramkey"></td>
88 <td class="paramtype">PP_TimeTicks </td>
89 <td class="paramname"><em>time_stamp</em>, </td>
92 <td class="paramkey"></td>
94 <td class="paramtype">uint32_t </td>
95 <td class="paramname"><em>modifiers</em>, </td>
98 <td class="paramkey"></td>
100 <td class="paramtype">uint32_t </td>
101 <td class="paramname"><em>key_code</em>, </td>
104 <td class="paramkey"></td>
106 <td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> & </td>
107 <td class="paramname"><em>character_text</em> </td>
117 <p>Constructs a keyboard input even from the given parameters. </p>
118 <dl class="params"><dt><b>Parameters:</b></dt><dd>
119 <table class="params">
120 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance for which this event occurred.</td></tr>
121 <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>
122 <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>
123 <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>
124 <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>
125 <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>
131 <hr /><h2>Member Function Documentation</h2>
132 <a class="anchor" id="a343bd835af56bd7875b0d82361680e4a"></a><!-- doxytag: member="pp::KeyboardInputEvent::GetCharacterText" ref="a343bd835af56bd7875b0d82361680e4a" args="() const " -->
133 <div class="memitem">
134 <div class="memproto">
135 <table class="memname">
137 <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>
139 <td class="paramname"></td><td>)</td>
145 <p>Returns the typed character for the given character event. </p>
146 <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>
149 <a class="anchor" id="a5d6c799091a2adce32d3e20fd1a63017"></a><!-- doxytag: member="pp::KeyboardInputEvent::GetKeyCode" ref="a5d6c799091a2adce32d3e20fd1a63017" args="() const " -->
150 <div class="memitem">
151 <div class="memproto">
152 <table class="memname">
154 <td class="memname">uint32_t <a class="el" href="classpp_1_1_keyboard_input_event.html#a5d6c799091a2adce32d3e20fd1a63017">pp::KeyboardInputEvent::GetKeyCode</a> </td>
156 <td class="paramname"></td><td>)</td>
162 <p>Returns the DOM keyCode field for the keyboard event. </p>
163 <p>Chrome populates this with the Windows-style Virtual Key code of the key. </p>
166 <hr />The documentation for this class was generated from the following file:<ul>
167 <li><a class="el" href="input__event_8h.html">input_event.h</a></li>
169 </div><!-- contents -->
170 {{/partials.standard_nacl_article}}