native_client_sdk/doc_generated/pepper_stable/cpp/classpp_1_1_touch_input_event.html

{{+bindTo:partials.standard_nacl_api}}
<h1>pp::TouchInputEvent Class Reference</h1>
<div id="doxygen-ref">
{{- dummy div to appease doxygen -}}
  <div>
<!-- Generated by Doxygen 1.7.6.1 -->



</div>
<!--header-->
<div class="contents">
<!-- doxytag: class="pp::TouchInputEvent" --><!-- doxytag: inherits="pp::InputEvent" --><div class="dynheader">
Inheritance diagram for pp::TouchInputEvent:</div>
<div class="dyncontent">
<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>
<map name="pp_1_1_touch_input_event_inherit__map" id="pp_1_1_touch_input_event_inherit__map">
<area shape="rect" id="node2" href="classpp_1_1_input_event.html" title="This class represents an input event resource." alt="" coords="23,80,137,107"></area><area shape="rect" id="node3" href="classpp_1_1_resource.html" title="A reference counted module resource." alt="" coords="28,5,132,32"></area></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classpp_1_1_touch_input_event-members.html">List of all members.</a></p>
<h2>
Public Member Functions</h2><table class="memberdecls">

<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">TouchInputEvent</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;event)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;instance, PP_InputEvent_Type type, PP_TimeTicks time_stamp, uint32_t modifiers)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</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>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</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>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_touch_point.html">TouchPoint</a>&#160;</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>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_touch_point.html">TouchPoint</a>&#160;</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>
</table>
<hr /><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a29020b28f060c5ce45ae5c3fc7512e43"></a><!-- doxytag: member="pp::TouchInputEvent::TouchInputEvent" ref="a29020b28f060c5ce45ae5c3fc7512e43" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">pp::TouchInputEvent::TouchInputEvent</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
</div>
</div>
<a class="anchor" id="a601fab40cbb3e8f2f1824f655192b541"></a><!-- doxytag: member="pp::TouchInputEvent::TouchInputEvent" ref="a601fab40cbb3e8f2f1824f655192b541" args="(const InputEvent &amp;event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">pp::TouchInputEvent::TouchInputEvent</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_input_event.html">InputEvent</a> &amp;&#160;</td>
<td class="paramname"><em>event</em></td><td>)</td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a touch input event object from the given generic input event. </p>
<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>
</div>
</div>
<a class="anchor" id="a4a14ab4999f452f368e61c815c976eb3"></a><!-- doxytag: member="pp::TouchInputEvent::TouchInputEvent" ref="a4a14ab4999f452f368e61c815c976eb3" args="(const InstanceHandle &amp;instance, PP_InputEvent_Type type, PP_TimeTicks time_stamp, uint32_t modifiers)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpp_1_1_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">pp::TouchInputEvent::TouchInputEvent</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
<td class="paramname"><em>instance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PP_InputEvent_Type&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PP_TimeTicks&#160;</td>
<td class="paramname"><em>time_stamp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>modifiers</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a touch input even from the given parameters. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance for which this event occurred.</td></tr>
<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>
<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>
<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>
</table>
</dd>
</dl>
</div>
</div>
<hr /><h2>Member Function Documentation</h2>
<a class="anchor" id="a0a323b8bd08e02d816b6fffa9b6299c0"></a><!-- doxytag: member="pp::TouchInputEvent::AddTouchPoint" ref="a0a323b8bd08e02d816b6fffa9b6299c0" args="(PP_TouchListType list, PP_TouchPoint point)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classpp_1_1_touch_input_event.html#a0a323b8bd08e02d816b6fffa9b6299c0">pp::TouchInputEvent::AddTouchPoint</a> </td>
<td>(</td>
<td class="paramtype">PP_TouchListType&#160;</td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">PP_TouchPoint&#160;</td>
<td class="paramname"><em>point</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds the touch-point to the specified TouchList. </p>
</div>
</div>
<a class="anchor" id="a66228762dbdfbb3404853a87c37b1736"></a><!-- doxytag: member="pp::TouchInputEvent::GetTouchById" ref="a66228762dbdfbb3404853a87c37b1736" args="(PP_TouchListType list, uint32_t id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
<td>(</td>
<td class="paramtype">PP_TouchListType&#160;</td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>id</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
</div>
</div>
<a class="anchor" id="ac68cc82bbf2fcc88d449c5430cc02505"></a><!-- doxytag: member="pp::TouchInputEvent::GetTouchByIndex" ref="ac68cc82bbf2fcc88d449c5430cc02505" args="(PP_TouchListType list, uint32_t index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<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>
<td>(</td>
<td class="paramtype">PP_TouchListType&#160;</td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>index</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
</div>
</div>
<a class="anchor" id="a5bdc7a4cd409586cab33e509dad43461"></a><!-- doxytag: member="pp::TouchInputEvent::GetTouchCount" ref="a5bdc7a4cd409586cab33e509dad43461" args="(PP_TouchListType list) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="classpp_1_1_touch_input_event.html#a5bdc7a4cd409586cab33e509dad43461">pp::TouchInputEvent::GetTouchCount</a> </td>
<td>(</td>
<td class="paramtype">PP_TouchListType&#160;</td>
<td class="paramname"><em>list</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of TouchPoints in this TouchList. </dd></dl>
</div>
</div>
<hr />The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="input__event_8h.html">input_event.h</a></li>
</ul>
</div><!-- contents -->
</div>
{{/partials.standard_nacl_api}}