/usr/share/gtk-doc/html/atk/AtkRelation.html is in libatk1.0-doc 2.4.0-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 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AtkRelation</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atk.html" title="ATK Library">
<link rel="prev" href="AtkRegistry.html" title="AtkRegistry">
<link rel="next" href="AtkRelationSet.html" title="AtkRelationSet">
<meta name="generator" content="GTK-Doc V1.18 (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="AtkRegistry.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="atk.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">ATK - Accessibility Toolkit</th>
<td><a accesskey="n" href="AtkRelationSet.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#AtkRelation.synopsis" class="shortcut">Top</a>
|
<a href="#AtkRelation.description" class="shortcut">Description</a>
|
<a href="#AtkRelation.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#AtkRelation.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="AtkRelation"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtkRelation.top_of_page"></a>AtkRelation</span></h2>
<p>AtkRelation — An object used to describe a relation between a object and one or more
other objects.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="AtkRelation.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="AtkRelation.html#AtkRelation-struct" title="struct AtkRelation">AtkRelation</a>;
enum <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType">AtkRelationType</a>;
<a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a> <a class="link" href="AtkRelation.html#atk-relation-type-register" title="atk_relation_type_register ()">atk_relation_type_register</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="AtkRelation.html#atk-relation-type-get-name" title="atk_relation_type_get_name ()">atk_relation_type_get_name</a> (<em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> type</code></em>);
<a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a> <a class="link" href="AtkRelation.html#atk-relation-type-for-name" title="atk_relation_type_for_name ()">atk_relation_type_for_name</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
<a class="link" href="AtkRelation.html" title="AtkRelation"><span class="returnvalue">AtkRelation</span></a> * <a class="link" href="AtkRelation.html#atk-relation-new" title="atk_relation_new ()">atk_relation_new</a> (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> **targets</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_targets</code></em>,
<em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> relationship</code></em>);
<a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a> <a class="link" href="AtkRelation.html#atk-relation-get-relation-type" title="atk_relation_get_relation_type ()">atk_relation_get_relation_type</a> (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * <a class="link" href="AtkRelation.html#atk-relation-get-target" title="atk_relation_get_target ()">atk_relation_get_target</a> (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>);
<span class="returnvalue">void</span> <a class="link" href="AtkRelation.html#atk-relation-add-target" title="atk_relation_add_target ()">atk_relation_add_target</a> (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>,
<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *target</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="AtkRelation.html#atk-relation-remove-target" title="atk_relation_remove_target ()">atk_relation_remove_target</a> (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>,
<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *target</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="AtkRelation.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----AtkRelation
</pre>
</div>
<div class="refsect1">
<a name="AtkRelation.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="AtkRelation.html#AtkRelation--relation-type" title='The "relation-type" property'>relation-type</a>" <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> : Read / Write
"<a class="link" href="AtkRelation.html#AtkRelation--target" title='The "target" property'>target</a>" <a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArray</span></a>* : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="AtkRelation.description"></a><h2>Description</h2>
<p>
An AtkRelation describes a relation between an object and one or more
other objects. The actual relations that an object has with other objects
are defined as an AtkRelationSet, which is a set of AtkRelations.
</p>
</div>
<div class="refsect1">
<a name="AtkRelation.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtkRelation-struct"></a><h3>struct AtkRelation</h3>
<pre class="programlisting">struct AtkRelation;</pre>
<p>
The AtkRelation structure should not be accessed directly.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkRelationType"></a><h3>enum AtkRelationType</h3>
<pre class="programlisting">typedef enum {
ATK_RELATION_NULL = 0,
ATK_RELATION_CONTROLLED_BY,
ATK_RELATION_CONTROLLER_FOR,
ATK_RELATION_LABEL_FOR,
ATK_RELATION_LABELLED_BY,
ATK_RELATION_MEMBER_OF,
ATK_RELATION_NODE_CHILD_OF,
ATK_RELATION_FLOWS_TO,
ATK_RELATION_FLOWS_FROM,
ATK_RELATION_SUBWINDOW_OF,
ATK_RELATION_EMBEDS,
ATK_RELATION_EMBEDDED_BY,
ATK_RELATION_POPUP_FOR,
ATK_RELATION_PARENT_WINDOW_OF,
ATK_RELATION_DESCRIBED_BY,
ATK_RELATION_DESCRIPTION_FOR,
ATK_RELATION_NODE_PARENT_OF,
ATK_RELATION_LAST_DEFINED
} AtkRelationType;
</pre>
<p>
Describes the type of the relation
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="ATK-RELATION-NULL:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_NULL</code></span></p></td>
<td>Not used, represens "no relationship" or an error condition.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-CONTROLLED-BY:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_CONTROLLED_BY</code></span></p></td>
<td>Indicates an object controlled by one or more target objects.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-CONTROLLER-FOR:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_CONTROLLER_FOR</code></span></p></td>
<td>Indicates an object is an controller for one or more target objects.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-LABEL-FOR:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_LABEL_FOR</code></span></p></td>
<td>Indicates an object is a label for one or more target objects.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-LABELLED-BY:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_LABELLED_BY</code></span></p></td>
<td>Indicates an object is labelled by one or more target objects.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-MEMBER-OF:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_MEMBER_OF</code></span></p></td>
<td>Indicates an object is a member of a group of one or more target objects.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-NODE-CHILD-OF:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_NODE_CHILD_OF</code></span></p></td>
<td>Indicates an object is a cell in a treetable which is displayed because a cell in the same column is expanded and identifies that cell.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-FLOWS-TO:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_FLOWS_TO</code></span></p></td>
<td>Indicates that the object has content that flows logically to another
AtkObject in a sequential way, (for instance text-flow).
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-FLOWS-FROM:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_FLOWS_FROM</code></span></p></td>
<td>Indicates that the object has content that flows logically from
another AtkObject in a sequential way, (for instance text-flow).
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-SUBWINDOW-OF:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_SUBWINDOW_OF</code></span></p></td>
<td>Indicates a subwindow attached to a component but otherwise has no connection in the UI heirarchy to that component.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-EMBEDS:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_EMBEDS</code></span></p></td>
<td>Indicates that the object visually embeds
another object's content, i.e. this object's content flows around
another's content.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-EMBEDDED-BY:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_EMBEDDED_BY</code></span></p></td>
<td>Inverse of <a class="link" href="AtkRelation.html#ATK-RELATION-EMBEDS:CAPS"><code class="literal">ATK_RELATION_EMBEDS</code></a>, indicates that
this object's content is visualy embedded in another object.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-POPUP-FOR:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_POPUP_FOR</code></span></p></td>
<td>Indicates that an object is a popup for another object.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-PARENT-WINDOW-OF:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_PARENT_WINDOW_OF</code></span></p></td>
<td>Indicates that an object is a parent window of another object.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-DESCRIBED-BY:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_DESCRIBED_BY</code></span></p></td>
<td>Indicates that another object provides descriptive information about this object; more verbose than ATK_RELATION_LABELLED_BY.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-DESCRIPTION-FOR:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_DESCRIPTION_FOR</code></span></p></td>
<td>Indicates that an object provides descriptive information about another object; more verbose than ATK_RELATION_LABEL_FOR.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-NODE-PARENT-OF:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_NODE_PARENT_OF</code></span></p></td>
<td>Indicates an object is a cell in a treetable and is expanded to display other cells in the same column.
</td>
</tr>
<tr>
<td><p><a name="ATK-RELATION-LAST-DEFINED:CAPS"></a><span class="term"><code class="literal">ATK_RELATION_LAST_DEFINED</code></span></p></td>
<td>Not used, this value indicates the end of the enumeration.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-relation-type-register"></a><h3>atk_relation_type_register ()</h3>
<pre class="programlisting"><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a> atk_relation_type_register (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Associate <em class="parameter"><code>name</code></em> with a new <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>a name string</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> associated with <em class="parameter"><code>name</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-relation-type-get-name"></a><h3>atk_relation_type_get_name ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * atk_relation_type_get_name (<em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> type</code></em>);</pre>
<p>
Gets the description string describing the <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> <em class="parameter"><code>type</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>The <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> whose name is required</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the string describing the AtkRelationType</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-relation-type-for-name"></a><h3>atk_relation_type_for_name ()</h3>
<pre class="programlisting"><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a> atk_relation_type_for_name (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Get the <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> type corresponding to a relation name.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>a string which is the (non-localized) name of an ATK relation type.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> enumerated type corresponding to the specified name,
or <a class="link" href="AtkRelation.html#ATK-RELATION-NULL:CAPS"><span class="type">ATK_RELATION_NULL</span></a> if no matching relation type is found.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-relation-new"></a><h3>atk_relation_new ()</h3>
<pre class="programlisting"><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="returnvalue">AtkRelation</span></a> * atk_relation_new (<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> **targets</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_targets</code></em>,
<em class="parameter"><code><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> relationship</code></em>);</pre>
<p>
Create a new relation for the specified key and the specified list
of targets. See also <a class="link" href="AtkObject.html#atk-object-add-relationship" title="atk_object_add_relationship ()"><code class="function">atk_object_add_relationship()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>targets</code></em> :</span></p></td>
<td>an array of pointers to <a href="AtkObject.html"><span class="type">AtkObjects</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_targets</code></em> :</span></p></td>
<td>number of <a href="AtkObject.html"><span class="type">AtkObjects</span></a> pointed to by <em class="parameter"><code>targets</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>relationship</code></em> :</span></p></td>
<td>an <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> with which to create the new
<a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a pointer to a new <a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-relation-get-relation-type"></a><h3>atk_relation_get_relation_type ()</h3>
<pre class="programlisting"><a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="returnvalue">AtkRelationType</span></a> atk_relation_get_relation_type (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>);</pre>
<p>
Gets the type of <em class="parameter"><code>relation</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>relation</code></em> :</span></p></td>
<td>an <a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the type of <em class="parameter"><code>relation</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-relation-get-target"></a><h3>atk_relation_get_target ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * atk_relation_get_target (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>);</pre>
<p>
Gets the target list of <em class="parameter"><code>relation</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>relation</code></em> :</span></p></td>
<td>an <a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the target list of <em class="parameter"><code>relation</code></em>. <span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atk-relation-add-target"></a><h3>atk_relation_add_target ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> atk_relation_add_target (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>,
<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *target</code></em>);</pre>
<p>
Adds the specified AtkObject to the target for the relation, if it is
not already present. See also <a class="link" href="AtkObject.html#atk-object-add-relationship" title="atk_object_add_relationship ()"><code class="function">atk_object_add_relationship()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>relation</code></em> :</span></p></td>
<td>an <a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
<td>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 1.9</p>
</div>
<hr>
<div class="refsect2">
<a name="atk-relation-remove-target"></a><h3>atk_relation_remove_target ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> atk_relation_remove_target (<em class="parameter"><code><a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a> *relation</code></em>,
<em class="parameter"><code><a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> *target</code></em>);</pre>
<p>
Remove the specified AtkObject from the target for the relation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>relation</code></em> :</span></p></td>
<td>an <a class="link" href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>target</code></em> :</span></p></td>
<td>an <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if the removal is successful.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="AtkRelation.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="AtkRelation--relation-type"></a><h3>The <code class="literal">"relation-type"</code> property</h3>
<pre class="programlisting"> "relation-type" <a class="link" href="AtkRelation.html#AtkRelationType" title="enum AtkRelationType"><span class="type">AtkRelationType</span></a> : Read / Write</pre>
<p>The type of the relation.</p>
<p>Default value: ATK_RELATION_NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="AtkRelation--target"></a><h3>The <code class="literal">"target"</code> property</h3>
<pre class="programlisting"> "target" <a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray"><span class="type">GValueArray</span></a>* : Read / Write</pre>
<p>An array of the targets for the relation.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|