1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>atspi-relation</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-atspi-action.html" title="atspi-action">
10 <link rel="next" href="libatspi-atspi-image.html" title="atspi-image">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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">
17 <td><a accesskey="p" href="libatspi-atspi-action.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-image.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#AtspiRelation.synopsis" class="shortcut">Top</a>
26 <a href="#AtspiRelation.description" class="shortcut">Description</a>
28 <a href="#AtspiRelation.object-hierarchy" class="shortcut">Object Hierarchy</a>
31 <div class="refentry">
32 <a name="AtspiRelation"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
35 <h2><span class="refentrytitle"><a name="AtspiRelation.top_of_page"></a>atspi-relation</span></h2>
36 <p>atspi-relation — An interface via which non-hierarchical relationships
39 <td valign="top" align="right"></td>
41 <div class="refsynopsisdiv">
42 <a name="AtspiRelation.synopsis"></a><h2>Synopsis</h2>
43 <pre class="synopsis">struct <a class="link" href="AtspiRelation.html#AtspiRelation-struct" title="struct AtspiRelation">AtspiRelation</a>;
44 struct <a class="link" href="AtspiRelation.html#AtspiRelationClass" title="struct AtspiRelationClass">AtspiRelationClass</a>;
45 <a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="returnvalue">AtspiRelationType</span></a> <a class="link" href="AtspiRelation.html#atspi-relation-get-relation-type" title="atspi_relation_get_relation_type ()">atspi_relation_get_relation_type</a> (<em class="parameter"><code><a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> *obj</code></em>);
46 <a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="AtspiRelation.html#atspi-relation-get-n-targets" title="atspi_relation_get_n_targets ()">atspi_relation_get_n_targets</a> (<em class="parameter"><code><a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> *obj</code></em>);
47 <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> * <a class="link" href="AtspiRelation.html#atspi-relation-get-target" title="atspi_relation_get_target ()">atspi_relation_get_target</a> (<em class="parameter"><code><a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> *obj</code></em>,
48 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);
51 <div class="refsect1">
52 <a name="AtspiRelation.object-hierarchy"></a><h2>Object Hierarchy</h2>
53 <pre class="synopsis">
54 <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
58 <div class="refsect1">
59 <a name="AtspiRelation.description"></a><h2>Description</h2>
61 An interface via which non-hierarchical relationships
62 are indicated. An instance of this interface represents
63 a "one-to-many" correspondance.
66 <div class="refsect1">
67 <a name="AtspiRelation.details"></a><h2>Details</h2>
68 <div class="refsect2">
69 <a name="AtspiRelation-struct"></a><h3>struct AtspiRelation</h3>
70 <pre class="programlisting">struct AtspiRelation;</pre>
75 <div class="refsect2">
76 <a name="AtspiRelationClass"></a><h3>struct AtspiRelationClass</h3>
77 <pre class="programlisting">struct AtspiRelationClass {
78 GObjectClass parent_class;
85 <div class="refsect2">
86 <a name="atspi-relation-get-relation-type"></a><h3>atspi_relation_get_relation_type ()</h3>
87 <pre class="programlisting"><a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="returnvalue">AtspiRelationType</span></a> atspi_relation_get_relation_type (<em class="parameter"><code><a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> *obj</code></em>);</pre>
89 Gets the type of relationship represented by an <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a>.
91 <div class="variablelist"><table border="0" class="variablelist">
93 <col align="left" valign="top">
98 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
99 <td>a pointer to the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object to query.</td>
102 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
103 <td>an <a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="type">AtspiRelationType</span></a> indicating the type of relation
104 encapsulated in this <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object.</td>
110 <div class="refsect2">
111 <a name="atspi-relation-get-n-targets"></a><h3>atspi_relation_get_n_targets ()</h3>
112 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> atspi_relation_get_n_targets (<em class="parameter"><code><a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> *obj</code></em>);</pre>
114 Gets the number of objects which this relationship has as its
115 target objects (the subject is the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> from which this
116 <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> originated).
118 <div class="variablelist"><table border="0" class="variablelist">
120 <col align="left" valign="top">
125 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
126 <td>a pointer to the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object to query.</td>
129 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
130 <td>a <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating how many target objects which the
131 originating <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> object has the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a>
132 relationship with.</td>
138 <div class="refsect2">
139 <a name="atspi-relation-get-target"></a><h3>atspi_relation_get_target ()</h3>
140 <pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> * atspi_relation_get_target (<em class="parameter"><code><a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> *obj</code></em>,
141 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> i</code></em>);</pre>
143 Gets the <em class="parameter"><code>i</code></em>-th target of a specified <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> relationship.
145 <div class="variablelist"><table border="0" class="variablelist">
147 <col align="left" valign="top">
152 <td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
153 <td>a pointer to the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object to query.</td>
156 <td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
157 <td>a (zero-index) <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> indicating which (of possibly several) target is requested.</td>
160 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
161 <td>an <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> which is the <em class="parameter"><code>i</code></em>-th object
162 with which the originating <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> has relationship
163 specified in the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
173 Generated by GTK-Doc V1.18.1</div>