| Current File : //proc/thread-self/root/kunden/usr/share/gtk-doc/html/libatspi/libatspi-atspi-collection.html |
<!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: libatspi Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="AtspiApplication.html" title="AtspiApplication">
<link rel="next" href="libatspi-atspi-action.html" title="atspi-action">
<meta name="generator" content="GTK-Doc V1.33.1 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libatspi-atspi-collection.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#libatspi-atspi-collection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#libatspi-atspi-collection.implementations" class="shortcut">Known Implementations</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="AtspiApplication.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libatspi-atspi-action.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></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</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libatspi-atspi-collection.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GArray</span> *
</td>
<td class="function_name">
<a class="link" href="libatspi-atspi-collection.html#atspi-collection-get-matches" title="atspi_collection_get_matches ()">atspi_collection_get_matches</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GArray</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GArray</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="AtspiCollection"></a><div class="refsect1">
<a name="libatspi-atspi-collection.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libatspi-atspi-collection.html#AtspiCollection-struct" title="AtspiCollection">AtspiCollection</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libatspi-atspi-collection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> 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>
</div>
<div class="refsect1">
<a name="libatspi-atspi-collection.functions_details"></a><h2>Functions</h2>
<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="AtspiMatchRule"><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="refsect3">
<a name="atspi-collection-get-matches.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>collection</p></td>
<td class="parameter_description"><p>A pointer to the <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rule</p></td>
<td class="parameter_description"><p>An <a class="link" href="AtspiMatchRule.html" title="AtspiMatchRule"><span class="type">AtspiMatchRule</span></a> describing the match criteria.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sortby</p></td>
<td class="parameter_description"><p>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.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>count</p></td>
<td class="parameter_description"><p>The maximum number of results to return, or 0 for no limit.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>traverse</p></td>
<td class="parameter_description"><p>Not supported.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-collection-get-matches.returns"></a><h4>Returns</h4>
<p>All
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> objects matching the given match rule. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiAccessible*][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</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="AtspiMatchRule"><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="refsect3">
<a name="atspi-collection-get-matches-to.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>collection</p></td>
<td class="parameter_description"><p>A pointer to the <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>current_object</p></td>
<td class="parameter_description"><p>The object at which to start searching.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rule</p></td>
<td class="parameter_description"><p>An <a class="link" href="AtspiMatchRule.html" title="AtspiMatchRule"><span class="type">AtspiMatchRule</span></a> describing the match criteria.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sortby</p></td>
<td class="parameter_description"><p>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.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tree</p></td>
<td class="parameter_description"><p>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.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>limit_scope</p></td>
<td class="parameter_description"><p>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.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>count</p></td>
<td class="parameter_description"><p>The maximum number of results to return, or 0 for no limit.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>traverse</p></td>
<td class="parameter_description"><p>Not supported.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-collection-get-matches-to.returns"></a><h4>Returns</h4>
<p>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>
. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiAccessible*][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</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="AtspiMatchRule"><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="refsect3">
<a name="atspi-collection-get-matches-from.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>collection</p></td>
<td class="parameter_description"><p>A pointer to the <a class="link" href="libatspi-atspi-collection.html#AtspiCollection"><span class="type">AtspiCollection</span></a> to query.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>current_object</p></td>
<td class="parameter_description"><p>Upon reaching this object, searching should stop.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rule</p></td>
<td class="parameter_description"><p>An <a class="link" href="AtspiMatchRule.html" title="AtspiMatchRule"><span class="type">AtspiMatchRule</span></a> describing the match criteria.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sortby</p></td>
<td class="parameter_description"><p>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.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tree</p></td>
<td class="parameter_description"><p>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.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>count</p></td>
<td class="parameter_description"><p>The maximum number of results to return, or 0 for no limit.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>traverse</p></td>
<td class="parameter_description"><p>Not supported.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="atspi-collection-get-matches-from.returns"></a><h4>Returns</h4>
<p>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>
. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AtspiAccessible*][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</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>
<div class="refsect3">
<a name="atspi-collection-get-active-descendant.returns"></a><h4>Returns</h4>
<p>The active descendant of the given object.
Not yet implemented. </p>
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libatspi-atspi-collection.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AtspiCollection-struct"></a><h3>AtspiCollection</h3>
<pre class="programlisting">typedef struct _AtspiCollection AtspiCollection;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>