atkrelation.xml

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

<term><literal>ATK_RELATION_EMBEDDED_BY</literal></term>
<listitem><simpara> Inverse of <link linkend="ATK-RELATION-EMBEDS:CAPS"><literal>ATK_RELATION_EMBEDS</literal></link>, indicates that
 this object's content is visualy embedded in another object.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-POPUP-FOR:CAPS" role="constant">
<term><literal>ATK_RELATION_POPUP_FOR</literal></term>
<listitem><simpara> Indicates that an object is a popup for another object.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-PARENT-WINDOW-OF:CAPS" role="constant">
<term><literal>ATK_RELATION_PARENT_WINDOW_OF</literal></term>
<listitem><simpara> Indicates that an object is a parent window of another object.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-DESCRIBED-BY:CAPS" role="constant">
<term><literal>ATK_RELATION_DESCRIBED_BY</literal></term>
<listitem><simpara> Indicates that another object provides descriptive information about this object; more verbose than ATK_RELATION_LABELLED_BY.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-DESCRIPTION-FOR:CAPS" role="constant">
<term><literal>ATK_RELATION_DESCRIPTION_FOR</literal></term>
<listitem><simpara> Indicates that an object provides descriptive information about another object; more verbose than ATK_RELATION_LABEL_FOR.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-RELATION-LAST-DEFINED:CAPS" role="constant">
<term><literal>ATK_RELATION_LAST_DEFINED</literal></term>
<listitem><simpara> Not used, this value indicates the end of the enumeration.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-relation-type-register" role="function">
<title>atk_relation_type_register ()</title>
<indexterm zone="atk-relation-type-register"><primary>atk_relation_type_register</primary></indexterm><programlisting><link linkend="AtkRelationType">AtkRelationType</link>     atk_relation_type_register          (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Associate <parameter>name</parameter> with a new <link linkend="AtkRelationType"><type>AtkRelationType</type></link></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> a name string
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an <link linkend="AtkRelationType"><type>AtkRelationType</type></link> associated with <parameter>name</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-relation-type-get-name" role="function">
<title>atk_relation_type_get_name ()</title>
<indexterm zone="atk-relation-type-get-name"><primary>atk_relation_type_get_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_relation_type_get_name          (<link linkend="AtkRelationType">AtkRelationType</link> type);</programlisting>
<para>
Gets the description string describing the <link linkend="AtkRelationType"><type>AtkRelationType</type></link> <parameter>type</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="AtkRelationType"><type>AtkRelationType</type></link> whose name is required
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the string describing the AtkRelationType
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-relation-type-for-name" role="function">
<title>atk_relation_type_for_name ()</title>
<indexterm zone="atk-relation-type-for-name"><primary>atk_relation_type_for_name</primary></indexterm><programlisting><link linkend="AtkRelationType">AtkRelationType</link>     atk_relation_type_for_name          (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Get the <link linkend="AtkRelationType"><type>AtkRelationType</type></link> type corresponding to a relation name.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> a string which is the (non-localized) name of an ATK relation type.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="AtkRelationType"><type>AtkRelationType</type></link> enumerated type corresponding to the specified name,
         or <link linkend="ATK-RELATION-NULL:CAPS"><type>ATK_RELATION_NULL</type></link> if no matching relation type is found.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-relation-new" role="function">
<title>atk_relation_new ()</title>
<indexterm zone="atk-relation-new"><primary>atk_relation_new</primary></indexterm><programlisting><link linkend="AtkRelation">AtkRelation</link>*        atk_relation_new                    (<link linkend="AtkObject">AtkObject</link> **targets,
                                                         <link linkend="gint">gint</link> n_targets,
                                                         <link linkend="AtkRelationType">AtkRelationType</link> relationship);</programlisting>
<para>
Create a new relation for the specified key and the specified list
of targets.  See also <link linkend="atk-object-add-relationship"><function>atk_object_add_relationship()</function></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>targets</parameter>&nbsp;:</term>
<listitem><simpara> an array of pointers to <link linkend="AtkObjects"><type>AtkObjects</type></link>  
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n_targets</parameter>&nbsp;:</term>
<listitem><simpara> number of <link linkend="AtkObjects"><type>AtkObjects</type></link> pointed to by <parameter>targets</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>relationship</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelationType"><type>AtkRelationType</type></link> with which to create the new
 <link linkend="AtkRelation"><type>AtkRelation</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a pointer to a new <link linkend="AtkRelation"><type>AtkRelation</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-relation-get-relation-type" role="function">
<title>atk_relation_get_relation_type ()</title>
<indexterm zone="atk-relation-get-relation-type"><primary>atk_relation_get_relation_type</primary></indexterm><programlisting><link linkend="AtkRelationType">AtkRelationType</link>     atk_relation_get_relation_type      (<link linkend="AtkRelation">AtkRelation</link> *relation);</programlisting>
<para>
Gets the type of <parameter>relation</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>relation</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelation"><type>AtkRelation</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the type of <parameter>relation</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-relation-get-target" role="function">
<title>atk_relation_get_target ()</title>
<indexterm zone="atk-relation-get-target"><primary>atk_relation_get_target</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link>*          atk_relation_get_target             (<link linkend="AtkRelation">AtkRelation</link> *relation);</programlisting>
<para>
Gets the target list of <parameter>relation</parameter></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>relation</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelation"><type>AtkRelation</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the target list of <parameter>relation</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-relation-add-target" role="function" condition="since:ATK 1.9">
<title>atk_relation_add_target ()</title>
<indexterm zone="atk-relation-add-target" role="ATK 1.9"><primary>atk_relation_add_target</primary></indexterm><programlisting><link linkend="void">void</link>                atk_relation_add_target             (<link linkend="AtkRelation">AtkRelation</link> *relation,
                                                         <link linkend="AtkObject">AtkObject</link> *target);</programlisting>
<para>
Adds the specified AtkObject to the target for the relation, if it is
not already present.  See also <link linkend="atk-object-add-relationship"><function>atk_object_add_relationship()</function></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>relation</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRelation"><type>AtkRelation</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>target</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  ATK 1.9
</para></refsect2>

</refsect1>
<refsect1 id="AtkRelation.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="AtkRelation--relation-type"><title>The <literal>&quot;relation-type&quot;</literal> property</title>
<indexterm zone="AtkRelation--relation-type"><primary>AtkRelation:relation-type</primary></indexterm><programlisting>  &quot;relation-type&quot;            <link linkend="AtkRelationType">AtkRelationType</link>       : Read / Write</programlisting>
<para>The type of the relation.</para><para>Default value: ATK_RELATION_NULL</para>
</refsect2>
<refsect2 id="AtkRelation--target"><title>The <literal>&quot;target&quot;</literal> property</title>
<indexterm zone="AtkRelation--target"><primary>AtkRelation:target</primary></indexterm><programlisting>  &quot;target&quot;                   <link linkend="GValueArray">GValueArray</link>*          : Read / Write</programlisting>
<para>An array of the targets for the relation.</para></refsect2>

</refsect1>




</refentry>