1 {{+bindTo:partials.standard_nacl_article}}
2 <h1>pp::TouchInputEvent Class Reference</h1>
4 {{- dummy div to appease doxygen -}}
6 <!-- Generated by Doxygen 1.7.6.1 -->
12 <div class="contents">
13 <!-- doxytag: class="pp::TouchInputEvent" --><!-- doxytag: inherits="pp::InputEvent" --><div class="dynheader">
14 Inheritance diagram for pp::TouchInputEvent:</div>
15 <div class="dyncontent">
16 <div class="center"><img src="classpp_1_1_touch_input_event__inherit__graph.png" border="0" usemap="#pp_1_1_touch_input_event_inherit__map" alt="Inheritance graph" /></div>
17 <map name="pp_1_1_touch_input_event_inherit__map" id="pp_1_1_touch_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="23,83,137,112"></area><area shape="rect" id="node4" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="28,5,132,35"></area></map>
19 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
20 <p><a href="classpp_1_1_touch_input_event-members.html">List of all members.</a></p>
22 Public Member Functions</h2><table class="memberdecls">
24 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">TouchInputEvent</a> ()</td></tr>
25 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_touch_input_event.html#a601fab40cbb3e8f2f1824f655192b541">TouchInputEvent</a> (const <a class="el" href="classpp_1_1_input_event.html">InputEvent</a> &event)</td></tr>
26 <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_touch_input_event.html#a4a14ab4999f452f368e61c815c976eb3">TouchInputEvent</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)</td></tr>
27 <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_touch_input_event.html#a0a323b8bd08e02d816b6fffa9b6299c0">AddTouchPoint</a> (PP_TouchListType list, PP_TouchPoint point)</td></tr>
28 <tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_touch_input_event.html#a5bdc7a4cd409586cab33e509dad43461">GetTouchCount</a> (PP_TouchListType list) const </td></tr>
29 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_touch_point.html">TouchPoint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_touch_input_event.html#ac68cc82bbf2fcc88d449c5430cc02505">GetTouchByIndex</a> (PP_TouchListType list, uint32_t index) const </td></tr>
30 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_touch_point.html">TouchPoint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_touch_input_event.html#a66228762dbdfbb3404853a87c37b1736">GetTouchById</a> (PP_TouchListType list, uint32_t id) const </td></tr>
32 <hr /><h2>Constructor & Destructor Documentation</h2>
33 <a class="anchor" id="a29020b28f060c5ce45ae5c3fc7512e43"></a><!-- doxytag: member="pp::TouchInputEvent::TouchInputEvent" ref="a29020b28f060c5ce45ae5c3fc7512e43" args="()" -->
35 <div class="memproto">
36 <table class="memname">
38 <td class="memname"><a class="el" href="classpp_1_1_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">pp::TouchInputEvent::TouchInputEvent</a> </td>
40 <td class="paramname"></td><td>)</td>
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> touch input event object. </p>
49 <a class="anchor" id="a601fab40cbb3e8f2f1824f655192b541"></a><!-- doxytag: member="pp::TouchInputEvent::TouchInputEvent" ref="a601fab40cbb3e8f2f1824f655192b541" args="(const InputEvent &event)" -->
51 <div class="memproto">
52 <table class="memname">
54 <td class="memname"><a class="el" href="classpp_1_1_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">pp::TouchInputEvent::TouchInputEvent</a> </td>
56 <td class="paramtype">const <a class="el" href="classpp_1_1_input_event.html">InputEvent</a> & </td>
57 <td class="paramname"><em>event</em></td><td>)</td>
58 <td><code> [explicit]</code></td>
63 <p>Constructs a touch input event object from the given 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 touch input event, the touch 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>
67 <a class="anchor" id="a4a14ab4999f452f368e61c815c976eb3"></a><!-- doxytag: member="pp::TouchInputEvent::TouchInputEvent" ref="a4a14ab4999f452f368e61c815c976eb3" args="(const InstanceHandle &instance, PP_InputEvent_Type type, PP_TimeTicks time_stamp, uint32_t modifiers)" -->
69 <div class="memproto">
70 <table class="memname">
72 <td class="memname"><a class="el" href="classpp_1_1_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">pp::TouchInputEvent::TouchInputEvent</a> </td>
74 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> & </td>
75 <td class="paramname"><em>instance</em>, </td>
78 <td class="paramkey"></td>
80 <td class="paramtype">PP_InputEvent_Type </td>
81 <td class="paramname"><em>type</em>, </td>
84 <td class="paramkey"></td>
86 <td class="paramtype">PP_TimeTicks </td>
87 <td class="paramname"><em>time_stamp</em>, </td>
90 <td class="paramkey"></td>
92 <td class="paramtype">uint32_t </td>
93 <td class="paramname"><em>modifiers</em> </td>
103 <p>Constructs a touch input even from the given parameters. </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">instance</td><td>The instance for which this event occurred.</td></tr>
107 <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>
108 <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>
109 <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>
115 <hr /><h2>Member Function Documentation</h2>
116 <a class="anchor" id="a0a323b8bd08e02d816b6fffa9b6299c0"></a><!-- doxytag: member="pp::TouchInputEvent::AddTouchPoint" ref="a0a323b8bd08e02d816b6fffa9b6299c0" args="(PP_TouchListType list, PP_TouchPoint point)" -->
117 <div class="memitem">
118 <div class="memproto">
119 <table class="memname">
121 <td class="memname">void <a class="el" href="classpp_1_1_touch_input_event.html#a0a323b8bd08e02d816b6fffa9b6299c0">pp::TouchInputEvent::AddTouchPoint</a> </td>
123 <td class="paramtype">PP_TouchListType </td>
124 <td class="paramname"><em>list</em>, </td>
127 <td class="paramkey"></td>
129 <td class="paramtype">PP_TouchPoint </td>
130 <td class="paramname"><em>point</em> </td>
140 <p>Adds the touch-point to the specified TouchList. </p>
143 <a class="anchor" id="a66228762dbdfbb3404853a87c37b1736"></a><!-- doxytag: member="pp::TouchInputEvent::GetTouchById" ref="a66228762dbdfbb3404853a87c37b1736" args="(PP_TouchListType list, uint32_t id) const " -->
144 <div class="memitem">
145 <div class="memproto">
146 <table class="memname">
148 <td class="memname"><a class="el" href="classpp_1_1_touch_point.html">TouchPoint</a> <a class="el" href="classpp_1_1_touch_input_event.html#a66228762dbdfbb3404853a87c37b1736">pp::TouchInputEvent::GetTouchById</a> </td>
150 <td class="paramtype">PP_TouchListType </td>
151 <td class="paramname"><em>list</em>, </td>
154 <td class="paramkey"></td>
156 <td class="paramtype">uint32_t </td>
157 <td class="paramname"><em>id</em> </td>
162 <td></td><td> const</td>
167 <dl class="return"><dt><b>Returns:</b></dt><dd>The <a class="el" href="classpp_1_1_touch_point.html" title="Wrapper class for PP_TouchPoint.">TouchPoint</a> in the given list with the given identifier, or an empty <a class="el" href="classpp_1_1_touch_point.html" title="Wrapper class for PP_TouchPoint.">TouchPoint</a> if the list does not contain a <a class="el" href="classpp_1_1_touch_point.html" title="Wrapper class for PP_TouchPoint.">TouchPoint</a> with that identifier. </dd></dl>
170 <a class="anchor" id="ac68cc82bbf2fcc88d449c5430cc02505"></a><!-- doxytag: member="pp::TouchInputEvent::GetTouchByIndex" ref="ac68cc82bbf2fcc88d449c5430cc02505" args="(PP_TouchListType list, uint32_t index) const " -->
171 <div class="memitem">
172 <div class="memproto">
173 <table class="memname">
175 <td class="memname"><a class="el" href="classpp_1_1_touch_point.html">TouchPoint</a> <a class="el" href="classpp_1_1_touch_input_event.html#ac68cc82bbf2fcc88d449c5430cc02505">pp::TouchInputEvent::GetTouchByIndex</a> </td>
177 <td class="paramtype">PP_TouchListType </td>
178 <td class="paramname"><em>list</em>, </td>
181 <td class="paramkey"></td>
183 <td class="paramtype">uint32_t </td>
184 <td class="paramname"><em>index</em> </td>
189 <td></td><td> const</td>
194 <dl class="return"><dt><b>Returns:</b></dt><dd>The <a class="el" href="classpp_1_1_touch_point.html" title="Wrapper class for PP_TouchPoint.">TouchPoint</a> at the given index of the given list, or an empty <a class="el" href="classpp_1_1_touch_point.html" title="Wrapper class for PP_TouchPoint.">TouchPoint</a> if the index is out of range. </dd></dl>
197 <a class="anchor" id="a5bdc7a4cd409586cab33e509dad43461"></a><!-- doxytag: member="pp::TouchInputEvent::GetTouchCount" ref="a5bdc7a4cd409586cab33e509dad43461" args="(PP_TouchListType list) const " -->
198 <div class="memitem">
199 <div class="memproto">
200 <table class="memname">
202 <td class="memname">uint32_t <a class="el" href="classpp_1_1_touch_input_event.html#a5bdc7a4cd409586cab33e509dad43461">pp::TouchInputEvent::GetTouchCount</a> </td>
204 <td class="paramtype">PP_TouchListType </td>
205 <td class="paramname"><em>list</em></td><td>)</td>
211 <dl class="return"><dt><b>Returns:</b></dt><dd>The number of TouchPoints in this TouchList. </dd></dl>
214 <hr />The documentation for this class was generated from the following file:<ul>
215 <li><a class="el" href="input__event_8h.html">input_event.h</a></li>
217 </div><!-- contents -->
219 {{/partials.standard_nacl_article}}