← Back to branch summary

~elementary-os/elementaryos/os-patch-at-spi2-core-xenial

« back to all changes in this revision

Viewing changes to doc/libatspi/html/AtspiRelation.html

  • Committer: RabbitBot
  • Date: 2016-11-16 09:38:52 UTC
  • Revision ID: rabbitbot@elementary.io-20161116093852-xn6hcgpg5y25xooo
Initial import, version 2.18.3-4ubuntu1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/libatspi/html/AtspiRelation.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-relation: libatspi Reference Manual</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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.24.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="5"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
 
18
                  <a href="#AtspiRelation.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
 
19
                  <a href="#AtspiRelation.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
 
20
</td>
 
21
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
22
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
23
<td><a accesskey="p" href="libatspi-atspi-action.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="n" href="libatspi-atspi-image.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
25
</tr></table>
 
26
<div class="refentry">
 
27
<a name="AtspiRelation"></a><div class="titlepage"></div>
 
28
<div class="refnamediv"><table width="100%"><tr>
 
29
<td valign="top">
 
30
<h2><span class="refentrytitle"><a name="AtspiRelation.top_of_page"></a>atspi-relation</span></h2>
 
31
<p>atspi-relation —  An interface via which non-hierarchical relationships
 
32
 are indicated.</p>
 
33
</td>
 
34
<td class="gallery_image" valign="top" align="right"></td>
 
35
</tr></table></div>
 
36
<div class="refsect1">
 
37
<a name="AtspiRelation.functions"></a><h2>Functions</h2>
 
38
<div class="informaltable"><table width="100%" border="0">
 
39
<colgroup>
 
40
<col width="150px" class="functions_return">
 
41
<col class="functions_name">
 
42
</colgroup>
 
43
<tbody>
 
44
<tr>
 
45
<td class="function_type">
 
46
<a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="returnvalue">AtspiRelationType</span></a>
 
47
</td>
 
48
<td class="function_name">
 
49
<a class="link" href="AtspiRelation.html#atspi-relation-get-relation-type" title="atspi_relation_get_relation_type ()">atspi_relation_get_relation_type</a> <span class="c_punctuation">()</span>
 
50
</td>
 
51
</tr>
 
52
<tr>
 
53
<td class="function_type">
 
54
<span class="returnvalue">gint</span>
 
55
</td>
 
56
<td class="function_name">
 
57
<a class="link" href="AtspiRelation.html#atspi-relation-get-n-targets" title="atspi_relation_get_n_targets ()">atspi_relation_get_n_targets</a> <span class="c_punctuation">()</span>
 
58
</td>
 
59
</tr>
 
60
<tr>
 
61
<td class="function_type">
 
62
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
 
63
</td>
 
64
<td class="function_name">
 
65
<a class="link" href="AtspiRelation.html#atspi-relation-get-target" title="atspi_relation_get_target ()">atspi_relation_get_target</a> <span class="c_punctuation">()</span>
 
66
</td>
 
67
</tr>
 
68
</tbody>
 
69
</table></div>
 
70
</div>
 
71
<div class="refsect1">
 
72
<a name="AtspiRelation.other"></a><h2>Types and Values</h2>
 
73
<div class="informaltable"><table width="100%" border="0">
 
74
<colgroup>
 
75
<col width="150px" class="name">
 
76
<col class="description">
 
77
</colgroup>
 
78
<tbody>
 
79
<tr>
 
80
<td class="datatype_keyword">struct</td>
 
81
<td class="function_name"><a class="link" href="AtspiRelation.html#AtspiRelation-struct" title="struct AtspiRelation">AtspiRelation</a></td>
 
82
</tr>
 
83
<tr>
 
84
<td class="datatype_keyword">struct</td>
 
85
<td class="function_name"><a class="link" href="AtspiRelation.html#AtspiRelationClass" title="struct AtspiRelationClass">AtspiRelationClass</a></td>
 
86
</tr>
 
87
</tbody>
 
88
</table></div>
 
89
</div>
 
90
<div class="refsect1">
 
91
<a name="AtspiRelation.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
92
<pre class="screen">    GObject
 
93
    <span class="lineart">╰──</span> AtspiRelation
 
94
</pre>
 
95
</div>
 
96
<div class="refsect1">
 
97
<a name="AtspiRelation.description"></a><h2>Description</h2>
 
98
<p>
 
99
 An interface via which non-hierarchical relationships
 
100
 are indicated. An instance of this interface represents
 
101
 a "one-to-many" correspondance.
 
102
</p>
 
103
</div>
 
104
<div class="refsect1">
 
105
<a name="AtspiRelation.functions_details"></a><h2>Functions</h2>
 
106
<div class="refsect2">
 
107
<a name="atspi-relation-get-relation-type"></a><h3>atspi_relation_get_relation_type ()</h3>
 
108
<pre class="programlisting"><a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="returnvalue">AtspiRelationType</span></a>
 
109
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>
 
110
<p>Gets the type of relationship represented by an <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a>.</p>
 
111
<div class="refsect3">
 
112
<a name="id-1.2.7.7.2.5"></a><h4>Parameters</h4>
 
113
<div class="informaltable"><table width="100%" border="0">
 
114
<colgroup>
 
115
<col width="150px" class="parameters_name">
 
116
<col class="parameters_description">
 
117
<col width="200px" class="parameters_annotations">
 
118
</colgroup>
 
119
<tbody><tr>
 
120
<td class="parameter_name"><p>obj</p></td>
 
121
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object to query.</p></td>
 
122
<td class="parameter_annotations"> </td>
 
123
</tr></tbody>
 
124
</table></div>
 
125
</div>
 
126
<div class="refsect3">
 
127
<a name="id-1.2.7.7.2.6"></a><h4>Returns</h4>
 
128
<p> an <a class="link" href="libatspi-atspi-constants.html#AtspiRelationType" title="enum AtspiRelationType"><span class="type">AtspiRelationType</span></a> indicating the type of relation
 
129
encapsulated in this <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object.</p>
 
130
</div>
 
131
</div>
 
132
<hr>
 
133
<div class="refsect2">
 
134
<a name="atspi-relation-get-n-targets"></a><h3>atspi_relation_get_n_targets ()</h3>
 
135
<pre class="programlisting"><span class="returnvalue">gint</span>
 
136
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>
 
137
<p>Gets the number of objects which this relationship has as its
 
138
      target objects (the subject is the <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> from which this
 
139
      <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> originated).</p>
 
140
<div class="refsect3">
 
141
<a name="id-1.2.7.7.3.5"></a><h4>Parameters</h4>
 
142
<div class="informaltable"><table width="100%" border="0">
 
143
<colgroup>
 
144
<col width="150px" class="parameters_name">
 
145
<col class="parameters_description">
 
146
<col width="200px" class="parameters_annotations">
 
147
</colgroup>
 
148
<tbody><tr>
 
149
<td class="parameter_name"><p>obj</p></td>
 
150
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object to query.</p></td>
 
151
<td class="parameter_annotations"> </td>
 
152
</tr></tbody>
 
153
</table></div>
 
154
</div>
 
155
<div class="refsect3">
 
156
<a name="id-1.2.7.7.3.6"></a><h4>Returns</h4>
 
157
<p> a <span class="type">gint</span> indicating how many target objects which the
 
158
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>
 
159
relationship with.</p>
 
160
</div>
 
161
</div>
 
162
<hr>
 
163
<div class="refsect2">
 
164
<a name="atspi-relation-get-target"></a><h3>atspi_relation_get_target ()</h3>
 
165
<pre class="programlisting"><a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="returnvalue">AtspiAccessible</span></a> *
 
166
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>,
 
167
                           <em class="parameter"><code><span class="type">gint</span> i</code></em>);</pre>
 
168
<p>Gets the <em class="parameter"><code>i</code></em>
 
169
-th target of a specified <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> relationship.</p>
 
170
<div class="refsect3">
 
171
<a name="id-1.2.7.7.4.5"></a><h4>Parameters</h4>
 
172
<div class="informaltable"><table width="100%" border="0">
 
173
<colgroup>
 
174
<col width="150px" class="parameters_name">
 
175
<col class="parameters_description">
 
176
<col width="200px" class="parameters_annotations">
 
177
</colgroup>
 
178
<tbody>
 
179
<tr>
 
180
<td class="parameter_name"><p>obj</p></td>
 
181
<td class="parameter_description"><p>a pointer to the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object to query.</p></td>
 
182
<td class="parameter_annotations"> </td>
 
183
</tr>
 
184
<tr>
 
185
<td class="parameter_name"><p>i</p></td>
 
186
<td class="parameter_description"><p>a (zero-index) <span class="type">gint</span> indicating which (of possibly several) target is requested.</p></td>
 
187
<td class="parameter_annotations"> </td>
 
188
</tr>
 
189
</tbody>
 
190
</table></div>
 
191
</div>
 
192
<div class="refsect3">
 
193
<a name="id-1.2.7.7.4.6"></a><h4>Returns</h4>
 
194
<p> 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>
 
195
-th object
 
196
with which the originating <a class="link" href="AtspiAccessible.html" title="AtspiAccessible"><span class="type">AtspiAccessible</span></a> has relationship
 
197
specified in the <a class="link" href="AtspiRelation.html" title="atspi-relation"><span class="type">AtspiRelation</span></a> object. </p>
 
198
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
199
</div>
 
200
</div>
 
201
</div>
 
202
<div class="refsect1">
 
203
<a name="AtspiRelation.other_details"></a><h2>Types and Values</h2>
 
204
<div class="refsect2">
 
205
<a name="AtspiRelation-struct"></a><h3>struct AtspiRelation</h3>
 
206
<pre class="programlisting">struct AtspiRelation;</pre>
 
207
<p>
 
208
</p>
 
209
</div>
 
210
<hr>
 
211
<div class="refsect2">
 
212
<a name="AtspiRelationClass"></a><h3>struct AtspiRelationClass</h3>
 
213
<pre class="programlisting">struct AtspiRelationClass {
 
214
  GObjectClass parent_class;
 
215
};
 
216
</pre>
 
217
<p>
 
218
</p>
 
219
</div>
 
220
</div>
 
221
</div>
 
222
<div class="footer">
 
223
<hr>Generated by GTK-Doc V1.24.1</div>
 
224
</body>
 
225
</html>
 
 
b'\\ No newline at end of file'