/usr/share/doc/xorg-gtest/html/classxorg_1_1testing_1_1evemu_1_1_device.html is in libxorg-gtest-doc 0.7.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>xorg-gtest: xorg::testing::evemu::Device Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">xorg-gtest
 <span id="projectnumber">0.1</span>
</div>
<div id="projectbrief">Xorg testing extension to Google Test</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classxorg_1_1testing_1_1evemu_1_1_device.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classxorg_1_1testing_1_1evemu_1_1_device-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">xorg::testing::evemu::Device Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>evemu input device for replaying events through the Linux uinput evdev subsystem.
<a href="classxorg_1_1testing_1_1evemu_1_1_device.html#details">More...</a></p>
<p><code>#include <xorg/gtest/evemu/xorg-gtest-device.h></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a12e79530cb9724306a663d87917d30e1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxorg_1_1testing_1_1evemu_1_1_device.html#a12e79530cb9724306a663d87917d30e1">Device</a> (const std::string &path)</td></tr>
<tr class="memdesc:a12e79530cb9724306a663d87917d30e1"><td class="mdescLeft"> </td><td class="mdescRight">Create a new device context. <a href="#a12e79530cb9724306a663d87917d30e1">More...</a><br/></td></tr>
<tr class="separator:a12e79530cb9724306a663d87917d30e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d6731901aae165f8702f982da5248a3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxorg_1_1testing_1_1evemu_1_1_device.html#a1d6731901aae165f8702f982da5248a3">Play</a> (const std::string &path) const </td></tr>
<tr class="memdesc:a1d6731901aae165f8702f982da5248a3"><td class="mdescLeft"> </td><td class="mdescRight">Play a evemu recording through the device. <a href="#a1d6731901aae165f8702f982da5248a3">More...</a><br/></td></tr>
<tr class="separator:a1d6731901aae165f8702f982da5248a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b9c0e45160c89793f8c0f40013df3b9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxorg_1_1testing_1_1evemu_1_1_device.html#a7b9c0e45160c89793f8c0f40013df3b9">PlayOne</a> (int type, int code, int value, bool sync=false)</td></tr>
<tr class="memdesc:a7b9c0e45160c89793f8c0f40013df3b9"><td class="mdescLeft"> </td><td class="mdescRight">Play a single event through the device. <a href="#a7b9c0e45160c89793f8c0f40013df3b9">More...</a><br/></td></tr>
<tr class="separator:a7b9c0e45160c89793f8c0f40013df3b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a90c2cfca681cae2bebd0d303d3c4df"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classxorg_1_1testing_1_1evemu_1_1_device.html#a4a90c2cfca681cae2bebd0d303d3c4df">GetDeviceNode</a> (void)</td></tr>
<tr class="memdesc:a4a90c2cfca681cae2bebd0d303d3c4df"><td class="mdescLeft"> </td><td class="mdescRight">Return the /dev/input/eventX device node for this device. <a href="#a4a90c2cfca681cae2bebd0d303d3c4df">More...</a><br/></td></tr>
<tr class="separator:a4a90c2cfca681cae2bebd0d303d3c4df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a193178268e34cda502881b753c673026"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxorg_1_1testing_1_1evemu_1_1_device.html#a193178268e34cda502881b753c673026">HasEvent</a> (int type, int code)</td></tr>
<tr class="memdesc:a193178268e34cda502881b753c673026"><td class="mdescLeft"> </td><td class="mdescRight">Check if a device supports a specific event. <a href="#a193178268e34cda502881b753c673026">More...</a><br/></td></tr>
<tr class="separator:a193178268e34cda502881b753c673026"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7325d939b84df080a82c1e64cf1957c5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classxorg_1_1testing_1_1evemu_1_1_device.html#a7325d939b84df080a82c1e64cf1957c5">GetAbsData</a> (int code, int *min, int *max, int *fuzz=NULL, int *flat=NULL, int *resolution=NULL)</td></tr>
<tr class="memdesc:a7325d939b84df080a82c1e64cf1957c5"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve data about an absolute axis on this device. <a href="#a7325d939b84df080a82c1e64cf1957c5">More...</a><br/></td></tr>
<tr class="separator:a7325d939b84df080a82c1e64cf1957c5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>evemu input device for replaying events through the Linux uinput evdev subsystem. </p>
<p>Use the Recording class to play back a specific recording. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a12e79530cb9724306a663d87917d30e1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">xorg::testing::evemu::Device::Device </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em>)</td><td></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new device context. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path to evemu device property file.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td>if the device property file could not be found or the device could not be created. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7325d939b84df080a82c1e64cf1957c5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool xorg::testing::evemu::Device::GetAbsData </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>max</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>fuzz</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>flat</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>resolution</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve data about an absolute axis on this device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>The axis to query (e.g. ABS_X) </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">min</td><td>Min value for this axis </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">max</td><td>Max value for this axis </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">fuzz</td><td>Fuzz value for this axis </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">flat</td><td>Flat value for this axis </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">resolution</td><td>Resolution of this axis</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>false if this device doesn't have this axis, or true on success </dd></dl>
</div>
</div>
<a class="anchor" id="a4a90c2cfca681cae2bebd0d303d3c4df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& xorg::testing::evemu::Device::GetDeviceNode </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the /dev/input/eventX device node for this device. </p>
<p>Note that evemu doesn't know the device node, so we traverse the file system looking for it. There is a tiny chance of the device node being wrong, or the device disappearing before we find it. If the device node cannot be found, an empty string is returned.</p>
<dl class="section return"><dt>Returns</dt><dd>The string representing the device node </dd></dl>
</div>
</div>
<a class="anchor" id="a193178268e34cda502881b753c673026"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool xorg::testing::evemu::Device::HasEvent </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>code</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a device supports a specific event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Type of the event (EV_REL, EV_ABS, ...) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>Event code (ABS_X, REL_Y, ...)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this device supports this event or false otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a1d6731901aae165f8702f982da5248a3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xorg::testing::evemu::Device::Play </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em>)</td><td></td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Play a evemu recording through the device. </p>
<p>Plays the recording from the beginning through the end. This call will block until the recording has finished.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Path to evemu recording file.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td>if playback failed for any reason. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7b9c0e45160c89793f8c0f40013df3b9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xorg::testing::evemu::Device::PlayOne </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>sync</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Play a single event through the device. </p>
<p>Plays an event with the given type, code and value through the device.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Evdev interface event type, e.g. EV_ABS, EV_REL, EV_KEY. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">code</td><td>Evdev interface event code, e.g. ABS_X, REL_Y, BTN_LEFT </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Event value </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">sync</td><td>If true, submit an EV_SYN event after this event</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::runtime_error</td><td>if playback failed for any reason. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/build/buildd/xorg-gtest-0.7.1/include/xorg/gtest/evemu/xorg-gtest-device.h</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><b>xorg</b></li><li class="navelem"><b>testing</b></li><li class="navelem"><b>evemu</b></li><li class="navelem"><a class="el" href="classxorg_1_1testing_1_1evemu_1_1_device.html">Device</a></li>
<li class="footer">Generated on Tue Jul 16 2013 08:55:12 for xorg-gtest by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.4 </li>
</ul>
</div>
</body>
</html>
|