|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/21572/root/usr/share/gtk-doc/html/atk/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>AtkRelation</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" 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.6 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="atk.html" title="ATK Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in ATK 1.3">
<link rel="index" href="ix04.html" title="Index of new symbols in ATK 1.4">
<link rel="index" href="ix05.html" title="Index of new symbols in ATK 1.6">
<link rel="index" href="ix06.html" title="Index of new symbols in ATK 1.9">
<link rel="index" href="ix07.html" title="Index of new symbols in ATK 1.12">
</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"><nobr><a href="#id2572816" class="shortcut">Top</a>
 | 
<a href="#id2573103" class="shortcut">Description</a>
 | 
<a href="#id2573027" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2573051" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="AtkRelation"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2572816"></a><span class="refentrytitle">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">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="AtkRelation.html#AtkRelation-struct">AtkRelation</a>;
enum <a href="AtkRelation.html#AtkRelationType">AtkRelationType</a>;
<a href="AtkRelation.html#AtkRelationType">AtkRelationType</a> <a href="AtkRelation.html#atk-relation-type-register">atk_relation_type_register</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="AtkRelation.html#atk-relation-type-get-name">atk_relation_type_get_name</a> (<a href="AtkRelation.html#AtkRelationType">AtkRelationType</a> type);
<a href="AtkRelation.html#AtkRelationType">AtkRelationType</a> <a href="AtkRelation.html#atk-relation-type-for-name">atk_relation_type_for_name</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a href="AtkRelation.html" title="AtkRelation">AtkRelation</a>* <a href="AtkRelation.html#atk-relation-new">atk_relation_new</a> (<a href="AtkObject.html" title="AtkObject">AtkObject</a> **targets,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> n_targets,
<a href="AtkRelation.html#AtkRelationType">AtkRelationType</a> relationship);
<a href="AtkRelation.html#AtkRelationType">AtkRelationType</a> <a href="AtkRelation.html#atk-relation-get-relation-type">atk_relation_get_relation_type</a>
(<a href="AtkRelation.html" title="AtkRelation">AtkRelation</a> *relation);
<a
href="../glib/glib-Pointer-Arrays.html#GPtrArray"
>GPtrArray</a>* <a href="AtkRelation.html#atk-relation-get-target">atk_relation_get_target</a> (<a href="AtkRelation.html" title="AtkRelation">AtkRelation</a> *relation);
void <a href="AtkRelation.html#atk-relation-add-target">atk_relation_add_target</a> (<a href="AtkRelation.html" title="AtkRelation">AtkRelation</a> *relation,
<a href="AtkObject.html" title="AtkObject">AtkObject</a> *target);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2573027"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----AtkRelation
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2573051"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="AtkRelation.html#AtkRelation--relation-type">relation-type</a>" <a href="AtkRelation.html#AtkRelationType">AtkRelationType</a> : Read / Write
"<a href="AtkRelation.html#AtkRelation--target">target</a>" <a
href="../gobject/gobject-Value-arrays.html#GValueArray"
>GValueArray</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2573103"></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" lang="en">
<a name="id2573121"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2573131"></a><h3>
<a name="AtkRelation-struct"></a>AtkRelation</h3>
<a class="indexterm" name="id2573144"></a><pre class="programlisting">typedef struct _AtkRelation AtkRelation;</pre>
<p>
The AtkRelation structure should not be accessed directly.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573160"></a><h3>
<a name="AtkRelationType"></a>enum AtkRelationType</h3>
<a class="indexterm" name="id2573174"></a><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_LAST_DEFINED
} AtkRelationType;
</pre>
<p>
Describes the type of the relation</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><a name="ATK-RELATION-NULL:CAPS"></a><code class="literal">ATK_RELATION_NULL</code></span></td>
<td> Not used, represens "no relationship" or an error condition.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-RELATION-CONTROLLED-BY:CAPS"></a><code class="literal">ATK_RELATION_CONTROLLED_BY</code></span></td>
<td> Indicates an object controlled by one or more target objects.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-RELATION-CONTROLLER-FOR:CAPS"></a><code class="literal">ATK_RELATION_CONTROLLER_FOR</code></span></td>
<td> Indicates an object is an controller for one or more target objects.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-RELATION-LABEL-FOR:CAPS"></a><code class="literal">ATK_RELATION_LABEL_FOR</code></span></td>
<td> Indicates an object is a label for one or more target objects.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-RELATION-LABELLED-BY:CAPS"></a><code class="literal">ATK_RELATION_LABELLED_BY</code></span></td>
<td> Indicates an object is labelled by one or more target objects.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-RELATION-MEMBER-OF:CAPS"></a><code class="literal">ATK_RELATION_MEMBER_OF</code></span></td>
<td> Indicates an object is a member of a group of one or more target objects.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-RELATION-NODE-CHILD-OF:CAPS"></a><code class="literal">ATK_RELATION_NODE_CHILD_OF</code></span></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><span class="term"><a name="ATK-RELATION-FLOWS-TO:CAPS"></a><code class="literal">ATK_RELATION_FLOWS_TO</code></span></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><span class="term"><a name="ATK-RELATION-FLOWS-FROM:CAPS"></a><code class="literal">ATK_RELATION_FLOWS_FROM</code></span></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><span class="term"><a name="ATK-RELATION-SUBWINDOW-OF:CAPS"></a><code class="literal">ATK_RELATION_SUBWINDOW_OF</code></span></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><span class="term"><a name="ATK-RELATION-EMBEDS:CAPS"></a><code class="literal">ATK_RELATION_EMBEDS</code></span></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><span class="term"><a name="ATK-RELATION-EMBEDDED-BY:CAPS"></a><code class="literal">ATK_RELATION_EMBEDDED_BY</code></span></td>
<td> Inverse of <a 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><span class="term"><a name="ATK-RELATION-POPUP-FOR:CAPS"></a><code class="literal">ATK_RELATION_POPUP_FOR</code></span></td>
<td> Indicates that an object is a popup for another object.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-RELATION-PARENT-WINDOW-OF:CAPS"></a><code class="literal">ATK_RELATION_PARENT_WINDOW_OF</code></span></td>
<td> Indicates that an object is a parent window of another object.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-RELATION-DESCRIBED-BY:CAPS"></a><code class="literal">ATK_RELATION_DESCRIBED_BY</code></span></td>
<td> Indicates that another object provides descriptive information about this object; more verbose than ATK_RELATION_LABELLED_BY.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-RELATION-DESCRIPTION-FOR:CAPS"></a><code class="literal">ATK_RELATION_DESCRIPTION_FOR</code></span></td>
<td> Indicates that an object provides descriptive information about another object; more verbose than ATK_RELATION_LABEL_FOR.
</td>
</tr>
<tr>
<td><span class="term"><a name="ATK-RELATION-LAST-DEFINED:CAPS"></a><code class="literal">ATK_RELATION_LAST_DEFINED</code></span></td>
<td> Not used, this value indicates the end of the enumeration.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573624"></a><h3>
<a name="atk-relation-type-register"></a>atk_relation_type_register ()</h3>
<a class="indexterm" name="id2573637"></a><pre class="programlisting"><a href="AtkRelation.html#AtkRelationType">AtkRelationType</a> atk_relation_type_register (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Associate <em class="parameter"><code>name</code></em> with a new <a href="AtkRelation.html#AtkRelationType"><span class="type">AtkRelationType</span></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> a name string
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> an <a href="AtkRelation.html#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" lang="en">
<a name="id2573724"></a><h3>
<a name="atk-relation-type-get-name"></a>atk_relation_type_get_name ()</h3>
<a class="indexterm" name="id2573738"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* atk_relation_type_get_name (<a href="AtkRelation.html#AtkRelationType">AtkRelationType</a> type);</pre>
<p>
Gets the description string describing the <a href="AtkRelation.html#AtkRelationType"><span class="type">AtkRelationType</span></a> <em class="parameter"><code>type</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>type</code></em> :</span></td>
<td> The <a href="AtkRelation.html#AtkRelationType"><span class="type">AtkRelationType</span></a> whose name is required
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the string describing the AtkRelationType
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2573823"></a><h3>
<a name="atk-relation-type-for-name"></a>atk_relation_type_for_name ()</h3>
<a class="indexterm" name="id2573837"></a><pre class="programlisting"><a href="AtkRelation.html#AtkRelationType">AtkRelationType</a> atk_relation_type_for_name (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Get the <a href="AtkRelation.html#AtkRelationType"><span class="type">AtkRelationType</span></a> type corresponding to a relation name.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>name</code></em> :</span></td>
<td> a string which is the (non-localized) name of an ATK relation type.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the <a href="AtkRelation.html#AtkRelationType"><span class="type">AtkRelationType</span></a> enumerated type corresponding to the specified name,
or <a 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" lang="en">
<a name="id2573926"></a><h3>
<a name="atk-relation-new"></a>atk_relation_new ()</h3>
<a class="indexterm" name="id2573939"></a><pre class="programlisting"><a href="AtkRelation.html" title="AtkRelation">AtkRelation</a>* atk_relation_new (<a href="AtkObject.html" title="AtkObject">AtkObject</a> **targets,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> n_targets,
<a href="AtkRelation.html#AtkRelationType">AtkRelationType</a> relationship);</pre>
<p>
Create a new relation for the specified key and the specified list
of targets.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>targets</code></em> :</span></td>
<td> an array of pointers to <span class="type">AtkObjects</span>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>n_targets</code></em> :</span></td>
<td> number of <span class="type">AtkObjects</span> pointed to by <em class="parameter"><code>targets</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>relationship</code></em> :</span></td>
<td> an <a href="AtkRelation.html#AtkRelationType"><span class="type">AtkRelationType</span></a> with which to create the new
<a href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> a pointer to a new <a href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2574090"></a><h3>
<a name="atk-relation-get-relation-type"></a>atk_relation_get_relation_type ()</h3>
<a class="indexterm" name="id2574103"></a><pre class="programlisting"><a href="AtkRelation.html#AtkRelationType">AtkRelationType</a> atk_relation_get_relation_type
(<a href="AtkRelation.html" title="AtkRelation">AtkRelation</a> *relation);</pre>
<p>
Gets the type of <em class="parameter"><code>relation</code></em></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>relation</code></em> :</span></td>
<td> an <a href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the type of <em class="parameter"><code>relation</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2574183"></a><h3>
<a name="atk-relation-get-target"></a>atk_relation_get_target ()</h3>
<a class="indexterm" name="id2574196"></a><pre class="programlisting"><a
href="../glib/glib-Pointer-Arrays.html#GPtrArray"
>GPtrArray</a>* atk_relation_get_target (<a href="AtkRelation.html" title="AtkRelation">AtkRelation</a> *relation);</pre>
<p>
Gets the target list of <em class="parameter"><code>relation</code></em></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>relation</code></em> :</span></td>
<td> an <a href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> the target list of <em class="parameter"><code>relation</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2574275"></a><h3>
<a name="atk-relation-add-target"></a>atk_relation_add_target ()</h3>
<a class="indexterm" name="id2574290"></a><pre class="programlisting">void atk_relation_add_target (<a href="AtkRelation.html" title="AtkRelation">AtkRelation</a> *relation,
<a href="AtkObject.html" title="AtkObject">AtkObject</a> *target);</pre>
<p>
Adds the specified AtkObject to the target for the relation, if it is
not already present.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>relation</code></em> :</span></td>
<td> an <a href="AtkRelation.html" title="AtkRelation"><span class="type">AtkRelation</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>target</code></em> :</span></td>
<td> an <a href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>
</td>
</tr>
</tbody>
</table></div>
<p>Since ATK 1.9
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2574384"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2574395"></a><h3>
<a name="AtkRelation--relation-type"></a>The "<code class="literal">relation-type</code>" property</h3>
<a class="indexterm" name="id2574412"></a><pre class="programlisting"> "relation-type" <a href="AtkRelation.html#AtkRelationType">AtkRelationType</a> : Read / Write</pre>
<p>The type of the relation.</p>
<p>Default value: ATK_RELATION_NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2574439"></a><h3>
<a name="AtkRelation--target"></a>The "<code class="literal">target</code>" property</h3>
<a class="indexterm" name="id2574454"></a><pre class="programlisting"> "target" <a
href="../gobject/gobject-Value-arrays.html#GValueArray"
>GValueArray</a> : Read / Write</pre>
<p>An array of the targets for the relation.</p>
</div>
</div>
</div>
</body>
</html>