doc/libatspi/html/libatspi-atspi-collection.html

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