src/native_client_sdk/doc_generated/pepper_stable/cpp/classpp_1_1_touch_input_event.html

   1 {{+bindTo:partials.standard_nacl_article}}
   2 <h1>pp::TouchInputEvent Class Reference</h1>
   3 <div>
   4 <!-- Generated by Doxygen 1.7.6.1 -->
   5
   6
   7
   8 </div>
   9 <!--header-->
  10 <div class="contents">
  11 <!-- doxytag: class="pp::TouchInputEvent" --><!-- doxytag: inherits="pp::InputEvent" --><div class="dynheader">
  12 Inheritance diagram for pp::TouchInputEvent:</div>
  13 <div class="dyncontent">
  14 <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>
  15 <map name="pp_1_1_touch_input_event_inherit__map" id="pp_1_1_touch_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="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>
  17 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  18 <p><a href="classpp_1_1_touch_input_event-members.html">List of all members.</a></p>
  19 <h2>
  20 Public Member Functions</h2><table class="memberdecls">
  21
  22 <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>
  23 <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>
  24 <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>
  25 <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>
  26 <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>
  27 <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>
  28 <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>
  29 </table>
  30 <hr /><h2>Constructor &amp; Destructor Documentation</h2>
  31 <a class="anchor" id="a29020b28f060c5ce45ae5c3fc7512e43"></a><!-- doxytag: member="pp::TouchInputEvent::TouchInputEvent" ref="a29020b28f060c5ce45ae5c3fc7512e43" args="()" -->
  32 <div class="memitem">
  33 <div class="memproto">
  34 <table class="memname">
  35 <tr>
  36 <td class="memname"><a class="el" href="classpp_1_1_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">pp::TouchInputEvent::TouchInputEvent</a> </td>
  37 <td>(</td>
  38 <td class="paramname"></td><td>)</td>
  39 <td></td>
  40 </tr>
  41 </table>
  42 </div>
  43 <div class="memdoc">
  44 <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>
  45 </div>
  46 </div>
  47 <a class="anchor" id="a601fab40cbb3e8f2f1824f655192b541"></a><!-- doxytag: member="pp::TouchInputEvent::TouchInputEvent" ref="a601fab40cbb3e8f2f1824f655192b541" args="(const InputEvent &amp;event)" -->
  48 <div class="memitem">
  49 <div class="memproto">
  50 <table class="memname">
  51 <tr>
  52 <td class="memname"><a class="el" href="classpp_1_1_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">pp::TouchInputEvent::TouchInputEvent</a> </td>
  53 <td>(</td>
  54 <td class="paramtype">const <a class="el" href="classpp_1_1_input_event.html">InputEvent</a> &amp;&#160;</td>
  55 <td class="paramname"><em>event</em></td><td>)</td>
  56 <td><code> [explicit]</code></td>
  57 </tr>
  58 </table>
  59 </div>
  60 <div class="memdoc">
  61 <p>Constructs a touch input event object from the given generic input event. </p>
  62 <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>
  63 </div>
  64 </div>
  65 <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)" -->
  66 <div class="memitem">
  67 <div class="memproto">
  68 <table class="memname">
  69 <tr>
  70 <td class="memname"><a class="el" href="classpp_1_1_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">pp::TouchInputEvent::TouchInputEvent</a> </td>
  71 <td>(</td>
  72 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
  73 <td class="paramname"><em>instance</em>, </td>
  74 </tr>
  75 <tr>
  76 <td class="paramkey"></td>
  77 <td></td>
  78 <td class="paramtype">PP_InputEvent_Type&#160;</td>
  79 <td class="paramname"><em>type</em>, </td>
  80 </tr>
  81 <tr>
  82 <td class="paramkey"></td>
  83 <td></td>
  84 <td class="paramtype">PP_TimeTicks&#160;</td>
  85 <td class="paramname"><em>time_stamp</em>, </td>
  86 </tr>
  87 <tr>
  88 <td class="paramkey"></td>
  89 <td></td>
  90 <td class="paramtype">uint32_t&#160;</td>
  91 <td class="paramname"><em>modifiers</em>&#160;</td>
  92 </tr>
  93 <tr>
  94 <td></td>
  95 <td>)</td>
  96 <td></td><td></td>
  97 </tr>
  98 </table>
  99 </div>
 100 <div class="memdoc">
 101 <p>Constructs a touch input even from the given parameters. </p>
 102 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 103 <table class="params">
 104 <tr><td class="paramdir">[in]</td><td class="paramname">instance</td><td>The instance for which this event occurred.</td></tr>
 105 <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>
 106 <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>
 107 <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>
 108 </table>
 109 </dd>
 110 </dl>
 111 </div>
 112 </div>
 113 <hr /><h2>Member Function Documentation</h2>
 114 <a class="anchor" id="a0a323b8bd08e02d816b6fffa9b6299c0"></a><!-- doxytag: member="pp::TouchInputEvent::AddTouchPoint" ref="a0a323b8bd08e02d816b6fffa9b6299c0" args="(PP_TouchListType list, PP_TouchPoint point)" -->
 115 <div class="memitem">
 116 <div class="memproto">
 117 <table class="memname">
 118 <tr>
 119 <td class="memname">void <a class="el" href="classpp_1_1_touch_input_event.html#a0a323b8bd08e02d816b6fffa9b6299c0">pp::TouchInputEvent::AddTouchPoint</a> </td>
 120 <td>(</td>
 121 <td class="paramtype">PP_TouchListType&#160;</td>
 122 <td class="paramname"><em>list</em>, </td>
 123 </tr>
 124 <tr>
 125 <td class="paramkey"></td>
 126 <td></td>
 127 <td class="paramtype">PP_TouchPoint&#160;</td>
 128 <td class="paramname"><em>point</em>&#160;</td>
 129 </tr>
 130 <tr>
 131 <td></td>
 132 <td>)</td>
 133 <td></td><td></td>
 134 </tr>
 135 </table>
 136 </div>
 137 <div class="memdoc">
 138 <p>Adds the touch-point to the specified TouchList. </p>
 139 </div>
 140 </div>
 141 <a class="anchor" id="a66228762dbdfbb3404853a87c37b1736"></a><!-- doxytag: member="pp::TouchInputEvent::GetTouchById" ref="a66228762dbdfbb3404853a87c37b1736" args="(PP_TouchListType list, uint32_t id) const " -->
 142 <div class="memitem">
 143 <div class="memproto">
 144 <table class="memname">
 145 <tr>
 146 <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>
 147 <td>(</td>
 148 <td class="paramtype">PP_TouchListType&#160;</td>
 149 <td class="paramname"><em>list</em>, </td>
 150 </tr>
 151 <tr>
 152 <td class="paramkey"></td>
 153 <td></td>
 154 <td class="paramtype">uint32_t&#160;</td>
 155 <td class="paramname"><em>id</em>&#160;</td>
 156 </tr>
 157 <tr>
 158 <td></td>
 159 <td>)</td>
 160 <td></td><td> const</td>
 161 </tr>
 162 </table>
 163 </div>
 164 <div class="memdoc">
 165 <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>
 166 </div>
 167 </div>
 168 <a class="anchor" id="ac68cc82bbf2fcc88d449c5430cc02505"></a><!-- doxytag: member="pp::TouchInputEvent::GetTouchByIndex" ref="ac68cc82bbf2fcc88d449c5430cc02505" args="(PP_TouchListType list, uint32_t index) const " -->
 169 <div class="memitem">
 170 <div class="memproto">
 171 <table class="memname">
 172 <tr>
 173 <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>
 174 <td>(</td>
 175 <td class="paramtype">PP_TouchListType&#160;</td>
 176 <td class="paramname"><em>list</em>, </td>
 177 </tr>
 178 <tr>
 179 <td class="paramkey"></td>
 180 <td></td>
 181 <td class="paramtype">uint32_t&#160;</td>
 182 <td class="paramname"><em>index</em>&#160;</td>
 183 </tr>
 184 <tr>
 185 <td></td>
 186 <td>)</td>
 187 <td></td><td> const</td>
 188 </tr>
 189 </table>
 190 </div>
 191 <div class="memdoc">
 192 <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>
 193 </div>
 194 </div>
 195 <a class="anchor" id="a5bdc7a4cd409586cab33e509dad43461"></a><!-- doxytag: member="pp::TouchInputEvent::GetTouchCount" ref="a5bdc7a4cd409586cab33e509dad43461" args="(PP_TouchListType list) const " -->
 196 <div class="memitem">
 197 <div class="memproto">
 198 <table class="memname">
 199 <tr>
 200 <td class="memname">uint32_t <a class="el" href="classpp_1_1_touch_input_event.html#a5bdc7a4cd409586cab33e509dad43461">pp::TouchInputEvent::GetTouchCount</a> </td>
 201 <td>(</td>
 202 <td class="paramtype">PP_TouchListType&#160;</td>
 203 <td class="paramname"><em>list</em></td><td>)</td>
 204 <td> const</td>
 205 </tr>
 206 </table>
 207 </div>
 208 <div class="memdoc">
 209 <dl class="return"><dt><b>Returns:</b></dt><dd>The number of TouchPoints in this TouchList. </dd></dl>
 210 </div>
 211 </div>
 212 <hr />The documentation for this class was generated from the following file:<ul>
 213 <li><a class="el" href="input__event_8h.html">input_event.h</a></li>
 214 </ul>
 215 </div><!-- contents -->
 216 {{/partials.standard_nacl_article}}