atkrelation.xml

The ATK library provides a set of interfaces for accessibility.By supporting the ATK interfaces, an

<refentry id="AtkRelation">
<refmeta>
<refentrytitle role="top_of_page" id="AtkRelation.top_of_page">AtkRelation</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>ATK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>AtkRelation</refname>
<refpurpose>An object used to describe a relation between a object and one or more
other objects.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="AtkRelation.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="AtkRelation-struct">AtkRelation</link>;
enum                <link linkend="AtkRelationType">AtkRelationType</link>;
<link linkend="AtkRelationType">AtkRelationType</link>     <link linkend="atk-relation-type-register">atk_relation_type_register</link>          (const <link linkend="gchar">gchar</link> *name);
const <link linkend="gchar">gchar</link>*        <link linkend="atk-relation-type-get-name">atk_relation_type_get_name</link>          (<link linkend="AtkRelationType">AtkRelationType</link> type);
<link linkend="AtkRelationType">AtkRelationType</link>     <link linkend="atk-relation-type-for-name">atk_relation_type_for_name</link>          (const <link linkend="gchar">gchar</link> *name);
<link linkend="AtkRelation">AtkRelation</link>*        <link linkend="atk-relation-new">atk_relation_new</link>                    (<link linkend="AtkObject">AtkObject</link> **targets,
                                                         <link linkend="gint">gint</link> n_targets,
                                                         <link linkend="AtkRelationType">AtkRelationType</link> relationship);
<link linkend="AtkRelationType">AtkRelationType</link>     <link linkend="atk-relation-get-relation-type">atk_relation_get_relation_type</link>      (<link linkend="AtkRelation">AtkRelation</link> *relation);
<link linkend="GPtrArray">GPtrArray</link>*          <link linkend="atk-relation-get-target">atk_relation_get_target</link>             (<link linkend="AtkRelation">AtkRelation</link> *relation);
<link linkend="void">void</link>                <link linkend="atk-relation-add-target">atk_relation_add_target</link>             (<link linkend="AtkRelation">AtkRelation</link> *relation,
                                                         <link linkend="AtkObject">AtkObject</link> *target);
</synopsis>
</refsynopsisdiv>

<refsect1 id="AtkRelation.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----AtkRelation
</synopsis>

</refsect1>





<refsect1 id="AtkRelation.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="AtkRelation--relation-type">relation-type</link>&quot;            <link linkend="AtkRelationType">AtkRelationType</link>       : Read / Write
  &quot;<link linkend="AtkRelation--target">target</link>&quot;                   <link linkend="GValueArray">GValueArray</link>*          : Read / Write
</synopsis>
</refsect1>



<refsect1 id="AtkRelation.description" role="desc">
<title role="desc.title">Description</title>
<para>
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.


</para>
</refsect1>

<refsect1 id="AtkRelation.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="AtkRelation-struct" role="struct">
<title>AtkRelation</title>
<indexterm zone="AtkRelation-struct"><primary>AtkRelation</primary></indexterm><programlisting>typedef struct _AtkRelation AtkRelation;</programlisting>
<para>
The AtkRelation structure should not be accessed directly.

</para></refsect2>
<refsect2 id="AtkRelationType" role="enum">
<title>enum AtkRelationType</title>
<indexterm zone="AtkRelationType"><primary>AtkRelationType</primary></indexterm><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;
</programlisting>
<para>
Describes the type of the relation</para>
<para>

</para><variablelist role="enum">
<varlistentry id="ATK-RELATION-NULL:CAPS" role="constant">
<term><literal>ATK_RELATION_NULL</literal></term>
<listitem><simpara> Not used, represens "no relationship" or an error condition.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-CONTROLLED-BY:CAPS" role="constant">
<term><literal>ATK_RELATION_CONTROLLED_BY</literal></term>
<listitem><simpara> Indicates an object controlled by one or more target objects.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-CONTROLLER-FOR:CAPS" role="constant">
<term><literal>ATK_RELATION_CONTROLLER_FOR</literal></term>
<listitem><simpara> Indicates an object is an controller for one or more target objects.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-LABEL-FOR:CAPS" role="constant">
<term><literal>ATK_RELATION_LABEL_FOR</literal></term>
<listitem><simpara> Indicates an object is a label for one or more target objects.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-LABELLED-BY:CAPS" role="constant">
<term><literal>ATK_RELATION_LABELLED_BY</literal></term>
<listitem><simpara> Indicates an object is labelled by one or more target objects.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-MEMBER-OF:CAPS" role="constant">
<term><literal>ATK_RELATION_MEMBER_OF</literal></term>
<listitem><simpara> Indicates an object is a member of a group of one or more target objects.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-NODE-CHILD-OF:CAPS" role="constant">
<term><literal>ATK_RELATION_NODE_CHILD_OF</literal></term>
<listitem><simpara> 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.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-FLOWS-TO:CAPS" role="constant">
<term><literal>ATK_RELATION_FLOWS_TO</literal></term>
<listitem><simpara> Indicates that the object has content that flows logically to another
 AtkObject in a sequential way, (for instance text-flow).
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-FLOWS-FROM:CAPS" role="constant">
<term><literal>ATK_RELATION_FLOWS_FROM</literal></term>
<listitem><simpara> Indicates that the object has content that flows logically from
 another AtkObject in a sequential way, (for instance text-flow).
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-SUBWINDOW-OF:CAPS" role="constant">
<term><literal>ATK_RELATION_SUBWINDOW_OF</literal></term>
<listitem><simpara> Indicates a subwindow attached to a component but otherwise has no connection in  the UI heirarchy to that component.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-EMBEDS:CAPS" role="constant">
<term><literal>ATK_RELATION_EMBEDS</literal></term>
<listitem><simpara> Indicates that the object visually embeds 
 another object's content, i.e. this object's content flows around 
 another's content.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-EMBEDDED-BY:CAPS" role="constant">