/usr/share/doc/geis/html/group__geis__v2__event__control.html is in libgeis-doc 2.2.16-1.
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 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 | <!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"/>
<title>GEIS: Event Control</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);
</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">GEIS
 <span id="projectnumber">2.0</span>
</div>
<div id="projectbrief">Gesture Engine Interface Support</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<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="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</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><!-- 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('group__geis__v2__event__control.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>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</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="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Event Control</div> </div>
<div class="ingroups"><a class="el" href="group__geis__v2.html">The Advanced GEIS Interface</a></div></div><!--header-->
<div class="contents">
<p>These functions are used to dispatch events generated from the various other GEIS components.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_geis_event.html">GeisEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A generic GEIS event. <a href="class_geis_event.html#details">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gae979f8a371c42e0d6b566775ef454292"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__event__control.html#gae979f8a371c42e0d6b566775ef454292">GEIS_DEFAULT_EVENT_CALLBACK</a></td></tr>
<tr class="memdesc:gae979f8a371c42e0d6b566775ef454292"><td class="mdescLeft"> </td><td class="mdescRight">A special constant indicating the use of the default event callback. <a href="#gae979f8a371c42e0d6b566775ef454292"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga74996ed8fa45d1720d471d26481bc879"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga74996ed8fa45d1720d471d26481bc879"></a>
typedef enum _GeisEventType </td><td class="memItemRight" valign="bottom"><b>GeisEventType</b></td></tr>
<tr class="memitem:ga84e1904f0d93dd0cdbf8e2cf6eed88ea"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__event__control.html#ga84e1904f0d93dd0cdbf8e2cf6eed88ea">GeisEventCallback</a> )(<a class="el" href="class_geis.html">Geis</a> geis, <a class="el" href="class_geis_event.html">GeisEvent</a> event, void *context)</td></tr>
<tr class="memdesc:ga84e1904f0d93dd0cdbf8e2cf6eed88ea"><td class="mdescLeft"> </td><td class="mdescRight">The application callback type for the event dispatcher. <a href="#ga84e1904f0d93dd0cdbf8e2cf6eed88ea"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga72ce27b0699305ddb045f5b9d3f22b2c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>_GeisEventType</b> { <br/>
  <b>GEIS_EVENT_DEVICE_AVAILABLE</b>,
<b>GEIS_EVENT_DEVICE_UNAVAILABLE</b>,
<b>GEIS_EVENT_CLASS_AVAILABLE</b>,
<b>GEIS_EVENT_CLASS_CHANGED</b>,
<br/>
  <b>GEIS_EVENT_CLASS_UNAVAILABLE</b>,
<b>GEIS_EVENT_GESTURE_BEGIN</b>,
<b>GEIS_EVENT_GESTURE_UPDATE</b>,
<b>GEIS_EVENT_GESTURE_END</b>,
<br/>
  <b>GEIS_EVENT_TENTATIVE_BEGIN</b>,
<b>GEIS_EVENT_TENTATIVE_UPDATE</b>,
<b>GEIS_EVENT_TENTATIVE_END</b>,
<b>GEIS_EVENT_INIT_COMPLETE</b>,
<br/>
  <b>GEIS_EVENT_USER_DEFINED</b>,
<b>GEIS_EVENT_ERROR</b>
<br/>
}</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga1fd90da8befac971f9840a9fe088952d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__event__control.html#ga1fd90da8befac971f9840a9fe088952d">geis_register_event_callback</a> (<a class="el" href="class_geis.html">Geis</a> geis, <a class="el" href="group__geis__v2__event__control.html#ga84e1904f0d93dd0cdbf8e2cf6eed88ea">GeisEventCallback</a> event_callback, void *context)</td></tr>
<tr class="memdesc:ga1fd90da8befac971f9840a9fe088952d"><td class="mdescLeft"> </td><td class="mdescRight">Registers an event-handler callback. <a href="#ga1fd90da8befac971f9840a9fe088952d"></a><br/></td></tr>
<tr class="memitem:ga599f3dbfbb9276ee05e199c7828791d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__geis__common.html#ga7fe40cb68bb7a98f5429284514872790">GeisStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__event__control.html#ga599f3dbfbb9276ee05e199c7828791d9">geis_dispatch_events</a> (<a class="el" href="class_geis.html">Geis</a> geis)</td></tr>
<tr class="memdesc:ga599f3dbfbb9276ee05e199c7828791d9"><td class="mdescLeft"> </td><td class="mdescRight">Pumps the GEIS event loop. <a href="#ga599f3dbfbb9276ee05e199c7828791d9"></a><br/></td></tr>
<tr class="memitem:ga608d4dec827545b6dc38a18a2c33b338"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__geis__common.html#ga7fe40cb68bb7a98f5429284514872790">GeisStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__event__control.html#ga608d4dec827545b6dc38a18a2c33b338">geis_next_event</a> (<a class="el" href="class_geis.html">Geis</a> geis, <a class="el" href="class_geis_event.html">GeisEvent</a> *event)</td></tr>
<tr class="memdesc:ga608d4dec827545b6dc38a18a2c33b338"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the next queued GEIS event. <a href="#ga608d4dec827545b6dc38a18a2c33b338"></a><br/></td></tr>
<tr class="memitem:ga6a145ff415ea4ab94636286fffd36398"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__event__control.html#ga6a145ff415ea4ab94636286fffd36398">geis_event_delete</a> (<a class="el" href="class_geis_event.html">GeisEvent</a> event)</td></tr>
<tr class="memdesc:ga6a145ff415ea4ab94636286fffd36398"><td class="mdescLeft"> </td><td class="mdescRight">Destroys a <a class="el" href="class_geis_event.html" title="A generic GEIS event.">GeisEvent</a>. <a href="#ga6a145ff415ea4ab94636286fffd36398"></a><br/></td></tr>
<tr class="memitem:gae54883e4bfedc254cd02ea2c7efaf21d"><td class="memItemLeft" align="right" valign="top">GeisEventType </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__event__control.html#gae54883e4bfedc254cd02ea2c7efaf21d">geis_event_type</a> (<a class="el" href="class_geis_event.html">GeisEvent</a> event)</td></tr>
<tr class="memdesc:gae54883e4bfedc254cd02ea2c7efaf21d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the type of the event. <a href="#gae54883e4bfedc254cd02ea2c7efaf21d"></a><br/></td></tr>
<tr class="memitem:gaa08c802d59fb72d0bd924b62206becc3"><td class="memItemLeft" align="right" valign="top">GeisSize </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__event__control.html#gaa08c802d59fb72d0bd924b62206becc3">geis_event_attr_count</a> (<a class="el" href="class_geis_event.html">GeisEvent</a> event)</td></tr>
<tr class="memdesc:gaa08c802d59fb72d0bd924b62206becc3"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of attributes in the event. <a href="#gaa08c802d59fb72d0bd924b62206becc3"></a><br/></td></tr>
<tr class="memitem:ga610e4f2e283cec68079131bdf6055e48"><td class="memItemLeft" align="right" valign="top">GeisAttr </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__event__control.html#ga610e4f2e283cec68079131bdf6055e48">geis_event_attr</a> (<a class="el" href="class_geis_event.html">GeisEvent</a> event, GeisSize index)</td></tr>
<tr class="memdesc:ga610e4f2e283cec68079131bdf6055e48"><td class="mdescLeft"> </td><td class="mdescRight">Gets an indicated attribute from the event. <a href="#ga610e4f2e283cec68079131bdf6055e48"></a><br/></td></tr>
<tr class="memitem:gabb751273c7c3297c692196bdd1b6fb45"><td class="memItemLeft" align="right" valign="top">GeisAttr </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__event__control.html#gabb751273c7c3297c692196bdd1b6fb45">geis_event_attr_by_name</a> (<a class="el" href="class_geis_event.html">GeisEvent</a> event, GeisString attr_name)</td></tr>
<tr class="memdesc:gabb751273c7c3297c692196bdd1b6fb45"><td class="mdescLeft"> </td><td class="mdescRight">Gets a named attribute from the event. <a href="#gabb751273c7c3297c692196bdd1b6fb45"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<p>These functions are used to dispatch events generated from the various other GEIS components. </p>
<p>Applications must invoke <a class="el" href="group__geis__v2__event__control.html#ga599f3dbfbb9276ee05e199c7828791d9" title="Pumps the GEIS event loop.">geis_dispatch_events()</a> from time to time to generate input device, gesture type, and gesture events. The GEIS events are then retrieved either from the internal event queue using the <a class="el" href="group__geis__v2__event__control.html#ga608d4dec827545b6dc38a18a2c33b338" title="Retrieves the next queued GEIS event.">geis_next_event()</a> call or through an application-supplied callback set through the <a class="el" href="group__geis__v2__event__control.html#ga1fd90da8befac971f9840a9fe088952d" title="Registers an event-handler callback.">geis_register_event_callback()</a> call. </p>
<h2>Macro Definition Documentation</h2>
<a class="anchor" id="gae979f8a371c42e0d6b566775ef454292"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GEIS_DEFAULT_EVENT_CALLBACK</td>
</tr>
</table>
</div><div class="memdoc">
<p>A special constant indicating the use of the default event callback. </p>
</div>
</div>
<h2>Typedef Documentation</h2>
<a class="anchor" id="ga84e1904f0d93dd0cdbf8e2cf6eed88ea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* GeisEventCallback)(<a class="el" href="class_geis.html">Geis</a> geis, <a class="el" href="class_geis_event.html">GeisEvent</a> event, void *context)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The application callback type for the event dispatcher. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">geis</td><td>the GEIS API instance </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>the opaque event pointer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>the application-supplied context value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2>Function Documentation</h2>
<a class="anchor" id="ga599f3dbfbb9276ee05e199c7828791d9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__geis__common.html#ga7fe40cb68bb7a98f5429284514872790">GeisStatus</a> geis_dispatch_events </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis.html">Geis</a> </td>
<td class="paramname"><em>geis</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pumps the GEIS event loop. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">geis</td><td>The GEIS API instance.</td></tr>
</table>
</dd>
</dl>
<p>Processes input events until there are no more input events to process and generates zero or more gesture events, reporting them via the user-supplied callback or pushing them on the internal event queue for retrieval via the <a class="el" href="group__geis__v2__event__control.html#ga608d4dec827545b6dc38a18a2c33b338" title="Retrieves the next queued GEIS event.">geis_next_event()</a> call.</p>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GEIS_STATUS_SUCCESS</td><td>The event loop was successfully pumped and no further events remain to be processed at this time.</td></tr>
<tr><td class="paramname">GEIS_STATUS_CONTINUE</td><td>The event loop was successfully pumped but the system detected there are events still remaining to be processed.</td></tr>
<tr><td class="paramname">GEIS_STATUS_UNKNOWN_ERROR</td><td>Some error occurred </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga610e4f2e283cec68079131bdf6055e48"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GeisAttr geis_event_attr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_event.html">GeisEvent</a> </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GeisSize </td>
<td class="paramname"><em>index</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets an indicated attribute from the event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>The <a class="el" href="class_geis_event.html" title="A generic GEIS event.">GeisEvent</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Indicates the attribute to retrieve. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gabb751273c7c3297c692196bdd1b6fb45"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GeisAttr geis_event_attr_by_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_event.html">GeisEvent</a> </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GeisString </td>
<td class="paramname"><em>attr_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a named attribute from the event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>The <a class="el" href="class_geis_event.html" title="A generic GEIS event.">GeisEvent</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">attr_name</td><td>The name of the attribute to retrieve. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaa08c802d59fb72d0bd924b62206becc3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GeisSize geis_event_attr_count </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_event.html">GeisEvent</a> </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the number of attributes in the event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>The <a class="el" href="class_geis_event.html" title="A generic GEIS event.">GeisEvent</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga6a145ff415ea4ab94636286fffd36398"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geis_event_delete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_event.html">GeisEvent</a> </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys a <a class="el" href="class_geis_event.html" title="A generic GEIS event.">GeisEvent</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>The <a class="el" href="class_geis_event.html" title="A generic GEIS event.">GeisEvent</a> to destroy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gae54883e4bfedc254cd02ea2c7efaf21d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GeisEventType geis_event_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_event.html">GeisEvent</a> </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the type of the event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">event</td><td>The <a class="el" href="class_geis_event.html" title="A generic GEIS event.">GeisEvent</a> to destroy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga608d4dec827545b6dc38a18a2c33b338"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__geis__common.html#ga7fe40cb68bb7a98f5429284514872790">GeisStatus</a> geis_next_event </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis.html">Geis</a> </td>
<td class="paramname"><em>geis</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_geis_event.html">GeisEvent</a> * </td>
<td class="paramname"><em>event</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the next queued GEIS event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">geis</td><td>The GEIS API instance. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>The <a class="el" href="class_geis_event.html" title="A generic GEIS event.">GeisEvent</a> retrieved, if any.</td></tr>
</table>
</dd>
</dl>
<p>Pulls the next available <a class="el" href="class_geis_event.html" title="A generic GEIS event.">GeisEvent</a> from the internal event queue, if any, and indicates whether there are more events left.</p>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GEIS_STATUS_SUCCESS</td><td>An event was successfully pulled from the queue and the queue is now empty.</td></tr>
<tr><td class="paramname">GEIS_STATUS_CONTINUE</td><td>An event was successfully pulled from the queue and one or more events remain in the queue.</td></tr>
<tr><td class="paramname">GEIS_STATUS_EMPTY</td><td>No event was pulled from the queue because it is empty. The value of *event remains unchanged.</td></tr>
<tr><td class="paramname">GEIS_STATUS_UNKNOWN_ERROR</td><td>Some error occurred </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga1fd90da8befac971f9840a9fe088952d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void geis_register_event_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis.html">Geis</a> </td>
<td class="paramname"><em>geis</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__geis__v2__event__control.html#ga84e1904f0d93dd0cdbf8e2cf6eed88ea">GeisEventCallback</a> </td>
<td class="paramname"><em>event_callback</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>context</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers an event-handler callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">geis</td><td>the GEIS API instance </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">event_callback</td><td>the callback to register </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">context</td><td>the caller context</td></tr>
</table>
</dd>
</dl>
<p>This function registers the callback to be executed whenever a new <a class="el" href="class_geis_event.html" title="A generic GEIS event.">GeisEvent</a> is generated. The default function pushes the <a class="el" href="class_geis_event.html" title="A generic GEIS event.">GeisEvent</a> onto an internal queue to be picked up by a call to <a class="el" href="group__geis__v2__event__control.html#ga608d4dec827545b6dc38a18a2c33b338" title="Retrieves the next queued GEIS event.">geis_next_event()</a>.</p>
<p>Calling <a class="el" href="group__geis__v2__event__control.html#ga1fd90da8befac971f9840a9fe088952d" title="Registers an event-handler callback.">geis_register_event_callback()</a> with a callback of GEIS_DEFAULT_EVENT_CALLBACK replaces any registered function wit hthe default function.</p>
<p>The callback is executed in the same thread context as the one <a class="el" href="group__geis__v2__event__control.html#ga599f3dbfbb9276ee05e199c7828791d9" title="Pumps the GEIS event loop.">geis_dispatch_events()</a> is called from. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Thu Jun 13 2013 06:13:23 for GEIS by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.2 </li>
</ul>
</div>
</body>
</html>
|