atkobject.xml

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

<indexterm zone="atk-object-get-description"><primary>atk_object_get_description</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        atk_object_get_description          (<link linkend="AtkObject">AtkObject</link> *accessible);</programlisting>
<para>
Gets the accessible description of the accessible.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a character string representing the accessible description
of the accessible.

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-get-parent" role="function">
<title>atk_object_get_parent ()</title>
<indexterm zone="atk-object-get-parent"><primary>atk_object_get_parent</primary></indexterm><programlisting><link linkend="AtkObject">AtkObject</link>*          atk_object_get_parent               (<link linkend="AtkObject">AtkObject</link> *accessible);</programlisting>
<para>
Gets the accessible parent of the accessible.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="AtkObject"><type>AtkObject</type></link> representing the accessible parent of the accessible
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-get-n-accessible-children" role="function">
<title>atk_object_get_n_accessible_children ()</title>
<indexterm zone="atk-object-get-n-accessible-children"><primary>atk_object_get_n_accessible_children</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_object_get_n_accessible_children
                                                        (<link linkend="AtkObject">AtkObject</link> *accessible);</programlisting>
<para>
Gets the number of accessible children of the accessible.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer representing the number of accessible children
of the accessible.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-ref-accessible-child" role="function">
<title>atk_object_ref_accessible_child ()</title>
<indexterm zone="atk-object-ref-accessible-child"><primary>atk_object_ref_accessible_child</primary></indexterm><programlisting><link linkend="AtkObject">AtkObject</link>*          atk_object_ref_accessible_child     (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         <link linkend="gint">gint</link> i);</programlisting>
<para>
Gets a reference to the specified accessible child of the object.
The accessible children are 0-based so the first accessible child is
at index 0, the second at index 1 and so on.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>i</parameter>&nbsp;:</term>
<listitem><simpara> a gint representing the position of the child, starting from 0
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link> representing the specified accessible child
of the accessible.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-ref-relation-set" role="function">
<title>atk_object_ref_relation_set ()</title>
<indexterm zone="atk-object-ref-relation-set"><primary>atk_object_ref_relation_set</primary></indexterm><programlisting><link linkend="AtkRelationSet">AtkRelationSet</link>*     atk_object_ref_relation_set         (<link linkend="AtkObject">AtkObject</link> *accessible);</programlisting>
<para>
Gets the <link linkend="AtkRelationSet"><type>AtkRelationSet</type></link> associated with the object.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an <link linkend="AtkRelationSet"><type>AtkRelationSet</type></link> representing the relation set of the object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-get-layer" role="function" condition="deprecated:Use atk_component_get_layer instead.">
<title>atk_object_get_layer ()</title>
<indexterm zone="atk-object-get-layer" role="deprecated"><primary>atk_object_get_layer</primary></indexterm><programlisting><link linkend="AtkLayer">AtkLayer</link>            atk_object_get_layer                (<link linkend="AtkObject">AtkObject</link> *accessible);</programlisting>
<warning><para><literal>atk_object_get_layer</literal> is deprecated and should not be used in newly-written code. Use atk_component_get_layer instead.</para></warning>
<para>
Gets the layer of the accessible.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an <link linkend="AtkLayer"><type>AtkLayer</type></link> which is the layer of the accessible
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-get-mdi-zorder" role="function" condition="deprecated:Use atk_component_get_mdi_zorder instead.">
<title>atk_object_get_mdi_zorder ()</title>
<indexterm zone="atk-object-get-mdi-zorder" role="deprecated"><primary>atk_object_get_mdi_zorder</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_object_get_mdi_zorder           (<link linkend="AtkObject">AtkObject</link> *accessible);</programlisting>
<warning><para><literal>atk_object_get_mdi_zorder</literal> is deprecated and should not be used in newly-written code. Use atk_component_get_mdi_zorder instead.</para></warning>
<para>
Gets the zorder of the accessible. The value G_MININT will be returned 
if the layer of the accessible is not ATK_LAYER_MDI.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a gint which is the zorder of the accessible, i.e. the depth at 
which the component is shown in relation to other components in the same 
container.

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-get-role" role="function">
<title>atk_object_get_role ()</title>
<indexterm zone="atk-object-get-role"><primary>atk_object_get_role</primary></indexterm><programlisting><link linkend="AtkRole">AtkRole</link>             atk_object_get_role                 (<link linkend="AtkObject">AtkObject</link> *accessible);</programlisting>
<para>
Gets the role of the accessible.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an <link linkend="AtkRole"><type>AtkRole</type></link> which is the role of the accessible
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-ref-state-set" role="function">
<title>atk_object_ref_state_set ()</title>
<indexterm zone="atk-object-ref-state-set"><primary>atk_object_ref_state_set</primary></indexterm><programlisting><link linkend="AtkStateSet">AtkStateSet</link>*        atk_object_ref_state_set            (<link linkend="AtkObject">AtkObject</link> *accessible);</programlisting>
<para>
Gets a reference to the state set of the accessible; the caller must
unreference it when it is no longer needed.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a reference to an <link linkend="AtkStateSet"><type>AtkStateSet</type></link> which is the state
set of the accessible
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-get-index-in-parent" role="function">
<title>atk_object_get_index_in_parent ()</title>
<indexterm zone="atk-object-get-index-in-parent"><primary>atk_object_get_index_in_parent</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_object_get_index_in_parent      (<link linkend="AtkObject">AtkObject</link> *accessible);</programlisting>
<para>
Gets the 0-based index of this accessible in its parent; returns -1 if the
accessible does not have an accessible parent.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an integer which is the index of the accessible in its parent
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-set-name" role="function">
<title>atk_object_set_name ()</title>
<indexterm zone="atk-object-set-name"><primary>atk_object_set_name</primary></indexterm><programlisting><link linkend="void">void</link>                atk_object_set_name                 (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Sets the accessible name of the accessible.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> a character string to be set as the accessible name
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-set-description" role="function">
<title>atk_object_set_description ()</title>
<indexterm zone="atk-object-set-description"><primary>atk_object_set_description</primary></indexterm><programlisting><link linkend="void">void</link>                atk_object_set_description          (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         const <link linkend="gchar">gchar</link> *description);</programlisting>
<para>
Sets the accessible description of the accessible.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>description</parameter>&nbsp;:</term>
<listitem><simpara> a character string to be set as the accessible description
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-set-parent" role="function">
<title>atk_object_set_parent ()</title>
<indexterm zone="atk-object-set-parent"><primary>atk_object_set_parent</primary></indexterm><programlisting><link linkend="void">void</link>                atk_object_set_parent               (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         <link linkend="AtkObject">AtkObject</link> *parent);</programlisting>
<para>
Sets the accessible parent of the accessible.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link> to be set as the accessible parent
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-set-role" role="function">
<title>atk_object_set_role ()</title>
<indexterm zone="atk-object-set-role"><primary>atk_object_set_role</primary></indexterm><programlisting><link linkend="void">void</link>                atk_object_set_role                 (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         <link linkend="AtkRole">AtkRole</link> role);</programlisting>
<para>
Sets the role of the accessible.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>role</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkRole"><type>AtkRole</type></link> to be set as the role
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-connect-property-change-handler" role="function">
<title>atk_object_connect_property_change_handler ()</title>
<indexterm zone="atk-object-connect-property-change-handler"><primary>atk_object_connect_property_change_handler</primary></indexterm><programlisting><link linkend="guint">guint</link>               atk_object_connect_property_change_handler
                                                        (<link linkend="AtkObject">AtkObject</link> *accessible,