libgeis-doc 2.2.16-1 / usr / share / doc / geis / html / group__geis__v1__config.html

This file is indexed.

/usr/share/doc/geis/html/group__geis__v1__config.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
<!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: Configuration and 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
   &#160;<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&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;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__v1__config.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Configuration and Control</div>  </div>
<div class="ingroups"><a class="el" href="group__geis__v1.html">The Simplified GEIS Interface</a></div></div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaac9b2b7387cd2cc1b624f59ed157c780"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v1__config.html#gaac9b2b7387cd2cc1b624f59ed157c780">GEIS_CONFIG_UNIX_FD</a></td></tr>
<tr class="memdesc:gaac9b2b7387cd2cc1b624f59ed157c780"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the Unix file descriptor for GEIS events.  <a href="#gaac9b2b7387cd2cc1b624f59ed157c780"></a><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:ga6d9cf18921db439441db04ba7617390a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__geis__common.html#ga7fe40cb68bb7a98f5429284514872790">GeisStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v1__config.html#ga6d9cf18921db439441db04ba7617390a">geis_configuration_supported</a> (<a class="el" href="class_geis_instance.html">GeisInstance</a> geis_instance, int configuration_item)</td></tr>
<tr class="memdesc:ga6d9cf18921db439441db04ba7617390a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates if a particular feaure is supported.  <a href="#ga6d9cf18921db439441db04ba7617390a"></a><br/></td></tr>
<tr class="memitem:gabd96bce7eff2f6dca83de46be69813a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__geis__common.html#ga7fe40cb68bb7a98f5429284514872790">GeisStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v1__config.html#gabd96bce7eff2f6dca83de46be69813a1">geis_configuration_get_value</a> (<a class="el" href="class_geis_instance.html">GeisInstance</a> geis_instance, int configuration_item, void *value)</td></tr>
<tr class="memdesc:gabd96bce7eff2f6dca83de46be69813a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a feature configuration value.  <a href="#gabd96bce7eff2f6dca83de46be69813a1"></a><br/></td></tr>
<tr class="memitem:ga3f4d7437a661444776469497c3cb2a93"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__geis__common.html#ga7fe40cb68bb7a98f5429284514872790">GeisStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v1__config.html#ga3f4d7437a661444776469497c3cb2a93">geis_configuration_set_value</a> (<a class="el" href="class_geis_instance.html">GeisInstance</a> geis_instance, int configuration_item, void *value)</td></tr>
<tr class="memdesc:ga3f4d7437a661444776469497c3cb2a93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets a feature configuration value.  <a href="#ga3f4d7437a661444776469497c3cb2a93"></a><br/></td></tr>
<tr class="memitem:ga67cb56b33f1503573a87872ab80c439e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__geis__common.html#ga7fe40cb68bb7a98f5429284514872790">GeisStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__geis__v1__config.html#ga67cb56b33f1503573a87872ab80c439e">geis_event_dispatch</a> (<a class="el" href="class_geis_instance.html">GeisInstance</a> geis_instance)</td></tr>
<tr class="memdesc:ga67cb56b33f1503573a87872ab80c439e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatches geis events until there are no further events available.  <a href="#ga67cb56b33f1503573a87872ab80c439e"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<h2>Macro Definition Documentation</h2>
<a class="anchor" id="gaac9b2b7387cd2cc1b624f59ed157c780"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define GEIS_CONFIG_UNIX_FD</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the Unix file descriptor for GEIS events. </p>
<p>Applications or toolkits can use this file descriptor to intgerate geis event handling into their main event dispatch loop. When a GEIS event is available for processing, the fd will have a read-available state indicated in select(), poll(), epoll(), etc. </p>

</div>
</div>
<h2>Function Documentation</h2>
<a class="anchor" id="gabd96bce7eff2f6dca83de46be69813a1"></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_configuration_get_value </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_geis_instance.html">GeisInstance</a>&#160;</td>
          <td class="paramname"><em>geis_instance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>configuration_item</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets a feature configuration value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">geis_instance</td><td>An opaque pointer to a geis gesture subscription instance. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">configuration_item</td><td>Indicates which configuration item will be get. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>A pointer to where the retrieved value will be stored.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">GEIS_BAD_ARGUMENT</td><td>an invalid argument value was passed </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="ga3f4d7437a661444776469497c3cb2a93"></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_configuration_set_value </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_geis_instance.html">GeisInstance</a>&#160;</td>
          <td class="paramname"><em>geis_instance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>configuration_item</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>value</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets a feature configuration value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">geis_instance</td><td>An opaque pointer to a geis gesture subscription instance. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">configuration_item</td><td>Indicates which configuration item will be set. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>A pointer to where the value to be set will be read.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">GEIS_BAD_ARGUMENT</td><td>an invalid argument value was passed </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="ga6d9cf18921db439441db04ba7617390a"></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_configuration_supported </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_geis_instance.html">GeisInstance</a>&#160;</td>
          <td class="paramname"><em>geis_instance</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>configuration_item</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Indicates if a particular feaure is supported. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">geis_instance</td><td>An opaque pointer to a geis gesture subscription instance. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">configuration_item</td><td>Indicates which configuration item will be checked for support.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">GEIS_BAD_ARGUMENT</td><td>an invalid argument value was passed </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="ga67cb56b33f1503573a87872ab80c439e"></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_event_dispatch </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_geis_instance.html">GeisInstance</a>&#160;</td>
          <td class="paramname"><em>geis_instance</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Dispatches geis events until there are no further events available. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">geis_instance</td><td>an opaque pointer to a geis gesture subscription instance</td></tr>
  </table>
  </dd>
</dl>
<p>This function is used to integrate geis even dispatch into the main event loop of an application or toolkit.</p>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">GEIS_BAD_ARGUMENT</td><td>an invalid <a class="el" href="class_geis_instance.html" title="A geis gesture subscription instance.">GeisInstance</a> was passed </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>

APT Browse - Built by Thomas Orozco.