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

   1 {{+bindTo:partials.standard_nacl_api}}
   2 <h1>pp::TouchInputEvent 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::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,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>
  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>
  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_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">TouchInputEvent</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_touch_input_event.html#a601fab40cbb3e8f2f1824f655192b541">TouchInputEvent</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_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>
  27 <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>
  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_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>&#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>
  30 <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>
  31 </table>
  32 <hr /><h2>Constructor &amp; Destructor Documentation</h2>
  33 <a class="anchor" id="a29020b28f060c5ce45ae5c3fc7512e43"></a><!-- doxytag: member="pp::TouchInputEvent::TouchInputEvent" ref="a29020b28f060c5ce45ae5c3fc7512e43" 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_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">pp::TouchInputEvent::TouchInputEvent</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> touch input event object. </p>
  47 </div>
  48 </div>
  49 <a class="anchor" id="a601fab40cbb3e8f2f1824f655192b541"></a><!-- doxytag: member="pp::TouchInputEvent::TouchInputEvent" ref="a601fab40cbb3e8f2f1824f655192b541" 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_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">pp::TouchInputEvent::TouchInputEvent</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 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>
  65 </div>
  66 </div>
  67 <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)" -->
  68 <div class="memitem">
  69 <div class="memproto">
  70 <table class="memname">
  71 <tr>
  72 <td class="memname"><a class="el" href="classpp_1_1_touch_input_event.html#a29020b28f060c5ce45ae5c3fc7512e43">pp::TouchInputEvent::TouchInputEvent</a> </td>
  73 <td>(</td>
  74 <td class="paramtype">const <a class="el" href="classpp_1_1_instance_handle.html">InstanceHandle</a> &amp;&#160;</td>
  75 <td class="paramname"><em>instance</em>, </td>
  76 </tr>
  77 <tr>
  78 <td class="paramkey"></td>
  79 <td></td>
  80 <td class="paramtype">PP_InputEvent_Type&#160;</td>
  81 <td class="paramname"><em>type</em>, </td>
  82 </tr>
  83 <tr>
  84 <td class="paramkey"></td>
  85 <td></td>
  86 <td class="paramtype">PP_TimeTicks&#160;</td>
  87 <td class="paramname"><em>time_stamp</em>, </td>
  88 </tr>
  89 <tr>
  90 <td class="paramkey"></td>
  91 <td></td>
  92 <td class="paramtype">uint32_t&#160;</td>
  93 <td class="paramname"><em>modifiers</em>&#160;</td>
  94 </tr>
  95 <tr>
  96 <td></td>
  97 <td>)</td>
  98 <td></td><td></td>
  99 </tr>
 100 </table>
 101 </div>
 102 <div class="memdoc">
 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>
 110 </table>
 111 </dd>
 112 </dl>
 113 </div>
 114 </div>
 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">
 120 <tr>
 121 <td class="memname">void <a class="el" href="classpp_1_1_touch_input_event.html#a0a323b8bd08e02d816b6fffa9b6299c0">pp::TouchInputEvent::AddTouchPoint</a> </td>
 122 <td>(</td>
 123 <td class="paramtype">PP_TouchListType&#160;</td>
 124 <td class="paramname"><em>list</em>, </td>
 125 </tr>
 126 <tr>
 127 <td class="paramkey"></td>
 128 <td></td>
 129 <td class="paramtype">PP_TouchPoint&#160;</td>
 130 <td class="paramname"><em>point</em>&#160;</td>
 131 </tr>
 132 <tr>
 133 <td></td>
 134 <td>)</td>
 135 <td></td><td></td>
 136 </tr>
 137 </table>
 138 </div>
 139 <div class="memdoc">
 140 <p>Adds the touch-point to the specified TouchList. </p>
 141 </div>
 142 </div>
 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">
 147 <tr>
 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>
 149 <td>(</td>
 150 <td class="paramtype">PP_TouchListType&#160;</td>
 151 <td class="paramname"><em>list</em>, </td>
 152 </tr>
 153 <tr>
 154 <td class="paramkey"></td>
 155 <td></td>
 156 <td class="paramtype">uint32_t&#160;</td>
 157 <td class="paramname"><em>id</em>&#160;</td>
 158 </tr>
 159 <tr>
 160 <td></td>
 161 <td>)</td>
 162 <td></td><td> const</td>
 163 </tr>
 164 </table>
 165 </div>
 166 <div class="memdoc">
 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>
 168 </div>
 169 </div>
 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">
 174 <tr>
 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>
 176 <td>(</td>
 177 <td class="paramtype">PP_TouchListType&#160;</td>
 178 <td class="paramname"><em>list</em>, </td>
 179 </tr>
 180 <tr>
 181 <td class="paramkey"></td>
 182 <td></td>
 183 <td class="paramtype">uint32_t&#160;</td>
 184 <td class="paramname"><em>index</em>&#160;</td>
 185 </tr>
 186 <tr>
 187 <td></td>
 188 <td>)</td>
 189 <td></td><td> const</td>
 190 </tr>
 191 </table>
 192 </div>
 193 <div class="memdoc">
 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>
 195 </div>
 196 </div>
 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">
 201 <tr>
 202 <td class="memname">uint32_t <a class="el" href="classpp_1_1_touch_input_event.html#a5bdc7a4cd409586cab33e509dad43461">pp::TouchInputEvent::GetTouchCount</a> </td>
 203 <td>(</td>
 204 <td class="paramtype">PP_TouchListType&#160;</td>
 205 <td class="paramname"><em>list</em></td><td>)</td>
 206 <td> const</td>
 207 </tr>
 208 </table>
 209 </div>
 210 <div class="memdoc">
 211 <dl class="return"><dt><b>Returns:</b></dt><dd>The number of TouchPoints in this TouchList. </dd></dl>
 212 </div>
 213 </div>
 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>
 216 </ul>
 217 </div><!-- contents -->
 218 </div>
 219 {{/partials.standard_nacl_api}}