/usr/share/gtk-doc/html/libatspi/libatspi-atspi-collection.html is in at-spi2-doc 2.10.2.is.2.10.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>atspi-collection</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="libatspi-AtspiApplication.html" title="atspi-application">
<link rel="next" href="libatspi-atspi-action.html" title="atspi-action">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libatspi-AtspiApplication.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libatspi Reference Manual</th>
<td><a accesskey="n" href="libatspi-atspi-action.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libatspi-atspi-collection.synopsis" class="shortcut">Top</a>
|
<a href="#libatspi-atspi-collection.description" class="shortcut">Description</a>
|
<a href="#libatspi-atspi-collection.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#libatspi-atspi-collection.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="libatspi-atspi-collection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-collection.top_of_page"></a>atspi-collection</span></h2>
<p>atspi-collection — An interface designed to allow accessibles which satisfy a set of
criteria to be returned.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libatspi-atspi-collection.synopsis"></a><h2>Synopsis</h2>
<a name="AtspiCollection"></a><pre class="synopsis"> <a class="link" href="libatspi-atspi-collection.html#AtspiCollection-struct" title="AtspiCollection">AtspiCollection</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-collection.html#atspi-collection-is-ancestor-of" title="atspi_collection_is_ancestor_of ()">atspi_collection_is_ancestor_of</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> *collection</code></em>,
<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *test</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">GArray</span> * <a class="link" href="libatspi-atspi-collection.html#atspi-collection-get-matches" title="atspi_collection_get_matches ()">atspi_collection_get_matches</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> *collection</code></em>,
<em class="parameter"><code><a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a> *rule</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder"><span class="type">AtspiCollectionSortOrder</span></a> sortby</code></em>,
<em class="parameter"><code><span class="type">gint</span> count</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> traverse</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">GArray</span> * <a class="link" href="libatspi-atspi-collection.html#atspi-collection-get-matches-to" title="atspi_collection_get_matches_to ()">atspi_collection_get_matches_to</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> *collection</code></em>,
<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *current_object</code></em>,
<em class="parameter"><code><a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a> *rule</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder"><span class="type">AtspiCollectionSortOrder</span></a> sortby</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionTreeTraversalType" title="enum AtspiCollectionTreeTraversalType"><span class="type">AtspiCollectionTreeTraversalType</span></a> tree</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> limit_scope</code></em>,
<em class="parameter"><code><span class="type">gint</span> count</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> traverse</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">GArray</span> * <a class="link" href="libatspi-atspi-collection.html#atspi-collection-get-matches-from" title="atspi_collection_get_matches_from ()">atspi_collection_get_matches_from</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> *collection</code></em>,
<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *current_object</code></em>,
<em class="parameter"><code><a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a> *rule</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder"><span class="type">AtspiCollectionSortOrder</span></a> sortby</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionTreeTraversalType" title="enum AtspiCollectionTreeTraversalType"><span class="type">AtspiCollectionTreeTraversalType</span></a> tree</code></em>,
<em class="parameter"><code><span class="type">gint</span> count</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> traverse</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> * <a class="link" href="libatspi-atspi-collection.html#atspi-collection-get-active-descendant" title="atspi_collection_get_active_descendant ()">atspi_collection_get_active_descendant</a>
(<em class="parameter"><code><a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> *collection</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-collection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----AtspiCollection
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-collection.implementations"></a><h2>Known Implementations</h2>
<p>
AtspiCollection is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-collection.description"></a><h2>Description</h2>
<p>
An interface designed to allow accessibles which satisfy a set of
criteria to be returned. This interface can be used to avoid iteration
or client-side search of the object tree.
</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-collection.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiCollection-struct"></a><h3>AtspiCollection</h3>
<pre class="programlisting">typedef struct _AtspiCollection AtspiCollection;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-collection-is-ancestor-of"></a><h3>atspi_collection_is_ancestor_of ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_collection_is_ancestor_of (<em class="parameter"><code><a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> *collection</code></em>,
<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *test</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Not yet implemented.
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-collection-get-matches"></a><h3>atspi_collection_get_matches ()</h3>
<pre class="programlisting"><span class="returnvalue">GArray</span> * atspi_collection_get_matches (<em class="parameter"><code><a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> *collection</code></em>,
<em class="parameter"><code><a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a> *rule</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder"><span class="type">AtspiCollectionSortOrder</span></a> sortby</code></em>,
<em class="parameter"><code><span class="type">gint</span> count</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> traverse</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets all <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> objects from the <em class="parameter"><code>collection</code></em> matching a given
<em class="parameter"><code>rule</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>collection</code></em> :</span></p></td>
<td>A pointer to the <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rule</code></em> :</span></p></td>
<td>An <a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a> describing the match criteria.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sortby</code></em> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder"><span class="type">AtspiCollectionSortOrder</span></a> specifying the way the results are to
be sorted.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
<td>The maximum number of results to return, or 0 for no limit.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>traverse</code></em> :</span></p></td>
<td>Not supported.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>All
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> objects matching the given match rule. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiAccessible*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-collection-get-matches-to"></a><h3>atspi_collection_get_matches_to ()</h3>
<pre class="programlisting"><span class="returnvalue">GArray</span> * atspi_collection_get_matches_to (<em class="parameter"><code><a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> *collection</code></em>,
<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *current_object</code></em>,
<em class="parameter"><code><a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a> *rule</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder"><span class="type">AtspiCollectionSortOrder</span></a> sortby</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionTreeTraversalType" title="enum AtspiCollectionTreeTraversalType"><span class="type">AtspiCollectionTreeTraversalType</span></a> tree</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> limit_scope</code></em>,
<em class="parameter"><code><span class="type">gint</span> count</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> traverse</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets all <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> objects from the <em class="parameter"><code>collection</code></em>, after
<em class="parameter"><code>current_object</code></em>, matching a given <em class="parameter"><code>rule</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>collection</code></em> :</span></p></td>
<td>A pointer to the <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>current_object</code></em> :</span></p></td>
<td>The object at which to start searching.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rule</code></em> :</span></p></td>
<td>An <a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a> describing the match criteria.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sortby</code></em> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder"><span class="type">AtspiCollectionSortOrder</span></a> specifying the way the results are to
be sorted.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tree</code></em> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionTreeTraversalType" title="enum AtspiCollectionTreeTraversalType"><span class="type">AtspiCollectionTreeTraversalType</span></a> specifying restrictions on
the objects to be traversed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>limit_scope</code></em> :</span></p></td>
<td>If <span class="type">TRUE</span>, only descendants of <em class="parameter"><code>current_object</code></em>'s parent
will be returned. Otherwise (if <span class="type">FALSE</span>), any accessible may be
returned if it would preceed <em class="parameter"><code>current_object</code></em> in a flattened
hierarchy.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
<td>The maximum number of results to return, or 0 for no limit.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>traverse</code></em> :</span></p></td>
<td>Not supported.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>All
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> objects matching the given match rule after
<em class="parameter"><code>current_object</code></em>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiAccessible*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-collection-get-matches-from"></a><h3>atspi_collection_get_matches_from ()</h3>
<pre class="programlisting"><span class="returnvalue">GArray</span> * atspi_collection_get_matches_from (<em class="parameter"><code><a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> *collection</code></em>,
<em class="parameter"><code><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> *current_object</code></em>,
<em class="parameter"><code><a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a> *rule</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder"><span class="type">AtspiCollectionSortOrder</span></a> sortby</code></em>,
<em class="parameter"><code><a class="link" href="libatspi-atspi-constants.html#AtspiCollectionTreeTraversalType" title="enum AtspiCollectionTreeTraversalType"><span class="type">AtspiCollectionTreeTraversalType</span></a> tree</code></em>,
<em class="parameter"><code><span class="type">gint</span> count</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> traverse</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets all <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> objects from the <em class="parameter"><code>collection</code></em>, before
<em class="parameter"><code>current_object</code></em>, matching a given <em class="parameter"><code>rule</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>collection</code></em> :</span></p></td>
<td>A pointer to the <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> to query.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>current_object</code></em> :</span></p></td>
<td>Upon reaching this object, searching should stop.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rule</code></em> :</span></p></td>
<td>An <a class="link" href="AtspiMatchRule.html" title="atspi-matchrule"><span class="type">AtspiMatchRule</span></a> describing the match criteria.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sortby</code></em> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionSortOrder" title="enum AtspiCollectionSortOrder"><span class="type">AtspiCollectionSortOrder</span></a> specifying the way the results are to
be sorted.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tree</code></em> :</span></p></td>
<td>An <a class="link" href="libatspi-atspi-constants.html#AtspiCollectionTreeTraversalType" title="enum AtspiCollectionTreeTraversalType"><span class="type">AtspiCollectionTreeTraversalType</span></a> specifying restrictions on
the objects to be traversed.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
<td>The maximum number of results to return, or 0 for no limit.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>traverse</code></em> :</span></p></td>
<td>Not supported.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>All
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> objects matching the given match rule that preceed
<em class="parameter"><code>current_object</code></em>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiAccessible*][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-collection-get-active-descendant"></a><h3>atspi_collection_get_active_descendant ()</h3>
<pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> * atspi_collection_get_active_descendant
(<em class="parameter"><code><a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> *collection</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Not yet implemented.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|