/usr/share/doc/geis/html/group__geis__meta.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 | <!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: Initialization and Cleanup</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__meta.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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Initialization and Cleanup</div> </div>
<div class="ingroups"><a class="el" href="group__geis__v1.html">The Simplified GEIS Interface</a></div></div><!--header-->
<div class="contents">
<p>Each instance of a gesture subscription must be created using the <a class="el" href="group__geis__meta.html#gab4b13d4579249103e8b0be407e414aa3" title="Initializes a geis subscription instance for a display region.">geis_init()</a> call and destroyed using the <a class="el" href="group__geis__meta.html#gabad0f6bc988ae45627d0a29d4e516948" title="Cleans up a geis subscription instance for a display region.">geis_finish()</a> call.
<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="struct_geis_win_info.html">GeisWinInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Generic display region description block. <a href="struct_geis_win_info.html#details">More...</a><br/></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_instance.html">GeisInstance</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A geis gesture subscription instance. <a href="class_geis_instance.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:gaabe64d627c4493cefe241b4b052f5f1c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaabe64d627c4493cefe241b4b052f5f1c"></a>
typedef struct <a class="el" href="struct_geis_win_info.html">GeisWinInfo</a> </td><td class="memItemRight" valign="bottom"><b>GeisWinInfo</b></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:gab4b13d4579249103e8b0be407e414aa3"><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__meta.html#gab4b13d4579249103e8b0be407e414aa3">geis_init</a> (<a class="el" href="struct_geis_win_info.html">GeisWinInfo</a> *win_info, <a class="el" href="class_geis_instance.html">GeisInstance</a> *geis_instance)</td></tr>
<tr class="memdesc:gab4b13d4579249103e8b0be407e414aa3"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a geis subscription instance for a display region. <a href="#gab4b13d4579249103e8b0be407e414aa3"></a><br/></td></tr>
<tr class="memitem:gabad0f6bc988ae45627d0a29d4e516948"><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__meta.html#gabad0f6bc988ae45627d0a29d4e516948">geis_finish</a> (<a class="el" href="class_geis_instance.html">GeisInstance</a> geis_instance)</td></tr>
<tr class="memdesc:gabad0f6bc988ae45627d0a29d4e516948"><td class="mdescLeft"> </td><td class="mdescRight">Cleans up a geis subscription instance for a display region. <a href="#gabad0f6bc988ae45627d0a29d4e516948"></a><br/></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Each instance of a gesture subscription must be created using the <a class="el" href="group__geis__meta.html#gab4b13d4579249103e8b0be407e414aa3" title="Initializes a geis subscription instance for a display region.">geis_init()</a> call and destroyed using the <a class="el" href="group__geis__meta.html#gabad0f6bc988ae45627d0a29d4e516948" title="Cleans up a geis subscription instance for a display region.">geis_finish()</a> call. </p>
<p>A particular subscription instance is associated with a display region. The nature of the display region depends on the underlying display technology. For example, an X11 window or even a subregion of an X11 window could be an associated display region when geis is layered over X11 technology.</p>
<p>The nature of the display desciption information depends on the actual underlyinggeis implementation and is documented separately. The implementation-specific description must be passed to geis_init using a <a class="el" href="struct_geis_win_info.html" title="Generic display region description block.">GeisWinInfo</a> structure. </p>
<h2>Function Documentation</h2>
<a class="anchor" id="gabad0f6bc988ae45627d0a29d4e516948"></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_finish </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_geis_instance.html">GeisInstance</a> </td>
<td class="paramname"><em>geis_instance</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Cleans up a geis subscription instance for a display region. </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>
<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>
<a class="anchor" id="gab4b13d4579249103e8b0be407e414aa3"></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_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_geis_win_info.html">GeisWinInfo</a> * </td>
<td class="paramname"><em>win_info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_geis_instance.html">GeisInstance</a> * </td>
<td class="paramname"><em>geis_instance</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes a geis subscription instance for a display region. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">win_info</td><td>a display region description block – see geis implementtaion documentation </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">geis_instance</td><td>an opaque pointer to a geis gesture subscription instance</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 <a class="el" href="struct_geis_win_info.html" title="Generic display region description block.">GeisWinInfo</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>
|