/usr/share/doc/geis/html/group__geis__v2__subscription.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 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 | <!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: Gesture Subscription</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__subscription.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="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Gesture Subscription</div> </div>
<div class="ingroups"><a class="el" href="group__geis__v2.html">The Advanced GEIS Interface</a></div></div><!--header-->
<div class="contents">
<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_subscription.html">GeisSubscription</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A gesture recognition subscription. <a href="class_geis_subscription.html#details">More...</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:ga0f712984092d32944022a3063ebbbb44"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0f712984092d32944022a3063ebbbb44"></a>
typedef int </td><td class="memItemRight" valign="bottom"><b>GeisSubscriptionFlags</b></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:ga06fc87d81c62e9abb8790b6e5713c55b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <a class="el" href="group__geis__v2__subscription.html#gga06fc87d81c62e9abb8790b6e5713c55ba4140e4dacd1e6fb74f9ed47e135d2083">GEIS_SUBSCRIPTION_NONE</a>,
<a class="el" href="group__geis__v2__subscription.html#gga06fc87d81c62e9abb8790b6e5713c55ba4f421e1bf39c48ca9fb592d67a6c8bda">GEIS_SUBSCRIPTION_GRAB</a>,
<a class="el" href="group__geis__v2__subscription.html#gga06fc87d81c62e9abb8790b6e5713c55ba4c153fec6eee04183371ac4022dab5dd">GEIS_SUBSCRIPTION_CONT</a>
}</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:gacbc60258a7546df3abe5db5fc3194b57"><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__subscription.html#gacbc60258a7546df3abe5db5fc3194b57">geis_subscription_get_configuration</a> (<a class="el" href="class_geis_subscription.html">GeisSubscription</a> subscription, GeisString config_item_name, GeisPointer config_item_value)</td></tr>
<tr class="memdesc:gacbc60258a7546df3abe5db5fc3194b57"><td class="mdescLeft"> </td><td class="mdescRight">Gets a subscription-level configuration item. <a href="#gacbc60258a7546df3abe5db5fc3194b57"></a><br/></td></tr>
<tr class="memitem:ga39b4a25c5036f29952e450668e0f2da1"><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__subscription.html#ga39b4a25c5036f29952e450668e0f2da1">geis_subscription_set_configuration</a> (<a class="el" href="class_geis_subscription.html">GeisSubscription</a> subscription, GeisString config_item_name, GeisPointer config_item_value)</td></tr>
<tr class="memdesc:ga39b4a25c5036f29952e450668e0f2da1"><td class="mdescLeft"> </td><td class="mdescRight">Sets a subscription-level configuration item. <a href="#ga39b4a25c5036f29952e450668e0f2da1"></a><br/></td></tr>
<tr class="memitem:ga35a50b739ff2807107dc8a43296ca020"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_geis_subscription.html">GeisSubscription</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__subscription.html#ga35a50b739ff2807107dc8a43296ca020">geis_subscription_new</a> (<a class="el" href="class_geis.html">Geis</a> geis, GeisString name, GeisSubscriptionFlags flags)</td></tr>
<tr class="memdesc:ga35a50b739ff2807107dc8a43296ca020"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new subscription. <a href="#ga35a50b739ff2807107dc8a43296ca020"></a><br/></td></tr>
<tr class="memitem:ga4ceccde5ea4fd59171bd0d33b7d50d53"><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__subscription.html#ga4ceccde5ea4fd59171bd0d33b7d50d53">geis_subscription_delete</a> (<a class="el" href="class_geis_subscription.html">GeisSubscription</a> subscription)</td></tr>
<tr class="memdesc:ga4ceccde5ea4fd59171bd0d33b7d50d53"><td class="mdescLeft"> </td><td class="mdescRight">Destroys a GEIS v2.0 subscription object. <a href="#ga4ceccde5ea4fd59171bd0d33b7d50d53"></a><br/></td></tr>
<tr class="memitem:gaf9ab0c59c1848d502fa0041cbe90d8b3"><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__subscription.html#gaf9ab0c59c1848d502fa0041cbe90d8b3">geis_subscription_activate</a> (<a class="el" href="class_geis_subscription.html">GeisSubscription</a> subscription)</td></tr>
<tr class="memdesc:gaf9ab0c59c1848d502fa0041cbe90d8b3"><td class="mdescLeft"> </td><td class="mdescRight">Activates a subscription. <a href="#gaf9ab0c59c1848d502fa0041cbe90d8b3"></a><br/></td></tr>
<tr class="memitem:gae3a0957ff2ffc23ab78f1d7a46a706c2"><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__subscription.html#gae3a0957ff2ffc23ab78f1d7a46a706c2">geis_subscription_deactivate</a> (<a class="el" href="class_geis_subscription.html">GeisSubscription</a> subscription)</td></tr>
<tr class="memdesc:gae3a0957ff2ffc23ab78f1d7a46a706c2"><td class="mdescLeft"> </td><td class="mdescRight">Deactivates a subscription. <a href="#gae3a0957ff2ffc23ab78f1d7a46a706c2"></a><br/></td></tr>
<tr class="memitem:ga4cde6a370b64eb6825a1f9578c750825"><td class="memItemLeft" align="right" valign="top">GeisString </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__subscription.html#ga4cde6a370b64eb6825a1f9578c750825">geis_subscription_name</a> (<a class="el" href="class_geis_subscription.html">GeisSubscription</a> subscription)</td></tr>
<tr class="memdesc:ga4cde6a370b64eb6825a1f9578c750825"><td class="mdescLeft"> </td><td class="mdescRight">Gets the name given to a subscription when it was created. <a href="#ga4cde6a370b64eb6825a1f9578c750825"></a><br/></td></tr>
<tr class="memitem:ga7c8e4df074c2eab90a13d62e4f6f4731"><td class="memItemLeft" align="right" valign="top">GeisInteger </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__subscription.html#ga7c8e4df074c2eab90a13d62e4f6f4731">geis_subscription_id</a> (<a class="el" href="class_geis_subscription.html">GeisSubscription</a> subscription)</td></tr>
<tr class="memdesc:ga7c8e4df074c2eab90a13d62e4f6f4731"><td class="mdescLeft"> </td><td class="mdescRight">Gets the ID assigned to a subscription when it was created. <a href="#ga7c8e4df074c2eab90a13d62e4f6f4731"></a><br/></td></tr>
<tr class="memitem:ga2dbffb51db39ea96ae4b789920dd5a4c"><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__subscription.html#ga2dbffb51db39ea96ae4b789920dd5a4c">geis_subscription_add_filter</a> (<a class="el" href="class_geis_subscription.html">GeisSubscription</a> subscription, <a class="el" href="class_geis_filter.html">GeisFilter</a> filter)</td></tr>
<tr class="memdesc:ga2dbffb51db39ea96ae4b789920dd5a4c"><td class="mdescLeft"> </td><td class="mdescRight">Adds a filter to a subscription. <a href="#ga2dbffb51db39ea96ae4b789920dd5a4c"></a><br/></td></tr>
<tr class="memitem:ga491a8666daf059ade167331106109bc7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_geis_filter.html">GeisFilter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v2__subscription.html#ga491a8666daf059ade167331106109bc7">geis_subscription_filter_by_name</a> (<a class="el" href="class_geis_subscription.html">GeisSubscription</a> sub, GeisString name)</td></tr>
<tr class="memdesc:ga491a8666daf059ade167331106109bc7"><td class="mdescLeft"> </td><td class="mdescRight">Gets an named filter from a subscription. <a href="#ga491a8666daf059ade167331106109bc7"></a><br/></td></tr>
<tr class="memitem:ga0af874b4e93bb6a2996befdfa683d03b"><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__subscription.html#ga0af874b4e93bb6a2996befdfa683d03b">geis_subscription_remove_filter</a> (<a class="el" href="class_geis_subscription.html">GeisSubscription</a> subscription, <a class="el" href="class_geis_filter.html">GeisFilter</a> filter)</td></tr>
<tr class="memdesc:ga0af874b4e93bb6a2996befdfa683d03b"><td class="mdescLeft"> </td><td class="mdescRight">Removes a filter from a subscription. <a href="#ga0af874b4e93bb6a2996befdfa683d03b"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ga06fc87d81c62e9abb8790b6e5713c55b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="gga06fc87d81c62e9abb8790b6e5713c55ba4140e4dacd1e6fb74f9ed47e135d2083"></a>GEIS_SUBSCRIPTION_NONE</em> </td><td>
<p>No special subscription processing: this is the default. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga06fc87d81c62e9abb8790b6e5713c55ba4f421e1bf39c48ca9fb592d67a6c8bda"></a>GEIS_SUBSCRIPTION_GRAB</em> </td><td>
<p>The subscription will "grab" all filtered gestures from subwindows. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="gga06fc87d81c62e9abb8790b6e5713c55ba4c153fec6eee04183371ac4022dab5dd"></a>GEIS_SUBSCRIPTION_CONT</em> </td><td>
<p>The gesture engine will return <em>gesture continuations</em>, in which the class of a recognized gestire may change over the lifetime of the gesture. </p>
<p>If this flag is not set, a new gesture will be identified for each change in gesture class. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2>Function Documentation</h2>
<a class="anchor" id="gaf9ab0c59c1848d502fa0041cbe90d8b3"></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_subscription_activate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_subscription.html">GeisSubscription</a> </td>
<td class="paramname"><em>subscription</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Activates a subscription. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">subscription</td><td>The subscription.</td></tr>
</table>
</dd>
</dl>
<p>Puts the subscription into the active state. Gesture events will be delivered for this subscription. </p>
</div>
</div>
<a class="anchor" id="ga2dbffb51db39ea96ae4b789920dd5a4c"></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_subscription_add_filter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_subscription.html">GeisSubscription</a> </td>
<td class="paramname"><em>subscription</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_geis_filter.html">GeisFilter</a> </td>
<td class="paramname"><em>filter</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a filter to a subscription. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">subscription</td><td>The subscription. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">filter</td><td>The filter to be added to the subscription.</td></tr>
</table>
</dd>
</dl>
<p>The effect of filters are ORed together so that, for example, a subscription that has a filter for 3-finger drag gestures and another for 2-finger pinch gestures will produce events for both 3-finger drag gestures and 2-finger pinch gestures.</p>
<p>The default is no filters: that is, all possible gesture events will be reported.</p>
<p>The subscription will take ownership of the filter. </p>
</div>
</div>
<a class="anchor" id="gae3a0957ff2ffc23ab78f1d7a46a706c2"></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_subscription_deactivate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_subscription.html">GeisSubscription</a> </td>
<td class="paramname"><em>subscription</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deactivates a subscription. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">subscription</td><td>The subscription.</td></tr>
</table>
</dd>
</dl>
<p>Puts the subscription into the inactive state. Gesture events will not be delivered for this subscription. </p>
</div>
</div>
<a class="anchor" id="ga4ceccde5ea4fd59171bd0d33b7d50d53"></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_subscription_delete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_subscription.html">GeisSubscription</a> </td>
<td class="paramname"><em>subscription</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys a GEIS v2.0 subscription object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">subscription</td><td>The subscription. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga491a8666daf059ade167331106109bc7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_geis_filter.html">GeisFilter</a> geis_subscription_filter_by_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_subscription.html">GeisSubscription</a> </td>
<td class="paramname"><em>sub</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GeisString </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets an named filter from a subscription. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sub</td><td>The subscription. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Names the filter to retrieve.</td></tr>
</table>
</dd>
</dl>
<p>Returns the first filter with the given name or NULL if no such named filter is found. </p>
</div>
</div>
<a class="anchor" id="gacbc60258a7546df3abe5db5fc3194b57"></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_subscription_get_configuration </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_subscription.html">GeisSubscription</a> </td>
<td class="paramname"><em>subscription</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GeisString </td>
<td class="paramname"><em>config_item_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GeisPointer </td>
<td class="paramname"><em>config_item_value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a subscription-level configuration item. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">subscription</td><td>The subscription from which the configuration item will be retrieved. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">config_item_name</td><td>The name of the configuration item. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">config_item_value</td><td>A pointer to an appropriate variable to hold the retrieved config item value.</td></tr>
</table>
</dd>
</dl>
<p>Not all back ends support all configuration items.</p>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GEIS_STATUS_BAD_ARGUMENT</td><td>an invalid argument value was passed </td></tr>
<tr><td class="paramname">GEIS_STATUS_NOT_SUPPORTED</td><td>the configuration value is not supported </td></tr>
<tr><td class="paramname">GEIS_STATUS_SUCCESS</td><td>normal successful completion </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga7c8e4df074c2eab90a13d62e4f6f4731"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GeisInteger geis_subscription_id </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_subscription.html">GeisSubscription</a> </td>
<td class="paramname"><em>subscription</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the ID assigned to a subscription when it was created. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">subscription</td><td>The subscription. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga4cde6a370b64eb6825a1f9578c750825"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GeisString geis_subscription_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_subscription.html">GeisSubscription</a> </td>
<td class="paramname"><em>subscription</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the name given to a subscription when it was created. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">subscription</td><td>The subscription. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga35a50b739ff2807107dc8a43296ca020"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_geis_subscription.html">GeisSubscription</a> geis_subscription_new </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">GeisString </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GeisSubscriptionFlags </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new subscription. </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">name</td><td>A name. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Some flags.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a <a class="el" href="class_geis_subscription.html" title="A gesture recognition subscription.">GeisSubscription</a> object or NULL on failure.</dd></dl>
<p>A gesture subscription is required for any gesture events to be delivered from the GEIS API. </p>
</div>
</div>
<a class="anchor" id="ga0af874b4e93bb6a2996befdfa683d03b"></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_subscription_remove_filter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_subscription.html">GeisSubscription</a> </td>
<td class="paramname"><em>subscription</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_geis_filter.html">GeisFilter</a> </td>
<td class="paramname"><em>filter</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a filter from a subscription. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">subscription</td><td>The subscription. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">filter</td><td>The filter to be removed from the subscription.</td></tr>
</table>
</dd>
</dl>
<p>Ownership of the filter is passed to the caller. </p>
</div>
</div>
<a class="anchor" id="ga39b4a25c5036f29952e450668e0f2da1"></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_subscription_set_configuration </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_subscription.html">GeisSubscription</a> </td>
<td class="paramname"><em>subscription</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GeisString </td>
<td class="paramname"><em>config_item_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GeisPointer </td>
<td class="paramname"><em>config_item_value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a subscription-level configuration item. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">subscription</td><td>The subscription from which the configuration item will be retrieved. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">config_item_name</td><td>The name of the configuration item. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">config_item_value</td><td>A pointer to an appropriate variable holding the config item value.</td></tr>
</table>
</dd>
</dl>
<p>Not all back ends support all configuration items.</p>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">GEIS_STATUS_BAD_ARGUMENT</td><td>an invalid argument value was passed </td></tr>
<tr><td class="paramname">GEIS_STATUS_NOT_SUPPORTED</td><td>the configuration value is not supported </td></tr>
<tr><td class="paramname">GEIS_STATUS_SUCCESS</td><td>normal successful completion </td></tr>
</table>
</dd>
</dl>
</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>
|