atkcomponent.xml

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

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> y coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>coord_type</parameter>&nbsp;:</term>
<listitem><simpara> specifies whether the coordinates are relative to the screen
or to the components top level window
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> indicating whether the specified point is within
the extent of the <parameter>component</parameter> or not
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-component-get-extents" role="function">
<title>atk_component_get_extents ()</title>
<indexterm zone="atk-component-get-extents"><primary>atk_component_get_extents</primary></indexterm><programlisting><link linkend="void">void</link>                atk_component_get_extents           (<link linkend="AtkComponent">AtkComponent</link> *component,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y,
                                                         <link linkend="gint">gint</link> *width,
                                                         <link linkend="gint">gint</link> *height,
                                                         <link linkend="AtkCoordType">AtkCoordType</link> coord_type);</programlisting>
<para>
Gets the rectangle which gives the extent of the <parameter>component</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>component</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkComponent"><type>AtkComponent</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> address of <link linkend="gint"><type>gint</type></link> to put x coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> address of <link linkend="gint"><type>gint</type></link> to put y coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> address of <link linkend="gint"><type>gint</type></link> to put width
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> address of <link linkend="gint"><type>gint</type></link> to put height
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>coord_type</parameter>&nbsp;:</term>
<listitem><simpara> specifies whether the coordinates are relative to the screen
or to the components top level window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-component-get-layer" role="function">
<title>atk_component_get_layer ()</title>
<indexterm zone="atk-component-get-layer"><primary>atk_component_get_layer</primary></indexterm><programlisting><link linkend="AtkLayer">AtkLayer</link>            atk_component_get_layer             (<link linkend="AtkComponent">AtkComponent</link> *component);</programlisting>
<para>
Gets the layer of the component.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>component</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkComponent"><type>AtkComponent</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 component
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-component-get-mdi-zorder" role="function">
<title>atk_component_get_mdi_zorder ()</title>
<indexterm zone="atk-component-get-mdi-zorder"><primary>atk_component_get_mdi_zorder</primary></indexterm><programlisting><link linkend="gint">gint</link>                atk_component_get_mdi_zorder        (<link linkend="AtkComponent">AtkComponent</link> *component);</programlisting>
<para>
Gets the zorder of the component. The value G_MININT will be returned 
if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>component</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkComponent"><type>AtkComponent</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a gint which is the zorder of the component, 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-component-get-position" role="function">
<title>atk_component_get_position ()</title>
<indexterm zone="atk-component-get-position"><primary>atk_component_get_position</primary></indexterm><programlisting><link linkend="void">void</link>                atk_component_get_position          (<link linkend="AtkComponent">AtkComponent</link> *component,
                                                         <link linkend="gint">gint</link> *x,
                                                         <link linkend="gint">gint</link> *y,
                                                         <link linkend="AtkCoordType">AtkCoordType</link> coord_type);</programlisting>
<para>
Gets the position of <parameter>component</parameter> in the form of 
a point specifying <parameter>component</parameter>'s top-left corner.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>component</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkComponent"><type>AtkComponent</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> address of <link linkend="gint"><type>gint</type></link> to put x coordinate position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> address of <link linkend="gint"><type>gint</type></link> to put y coordinate position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>coord_type</parameter>&nbsp;:</term>
<listitem><simpara> specifies whether the coordinates are relative to the screen
or to the components top level window
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-component-get-size" role="function">
<title>atk_component_get_size ()</title>
<indexterm zone="atk-component-get-size"><primary>atk_component_get_size</primary></indexterm><programlisting><link linkend="void">void</link>                atk_component_get_size              (<link linkend="AtkComponent">AtkComponent</link> *component,
                                                         <link linkend="gint">gint</link> *width,
                                                         <link linkend="gint">gint</link> *height);</programlisting>
<para>
Gets the size of the <parameter>component</parameter> in terms of width and height.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>component</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkComponent"><type>AtkComponent</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> address of <link linkend="gint"><type>gint</type></link> to put width of <parameter>component</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> address of <link linkend="gint"><type>gint</type></link> to put height of <parameter>component</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-component-grab-focus" role="function">
<title>atk_component_grab_focus ()</title>
<indexterm zone="atk-component-grab-focus"><primary>atk_component_grab_focus</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_component_grab_focus            (<link linkend="AtkComponent">AtkComponent</link> *component);</programlisting>
<para>
Grabs focus for this <parameter>component</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>component</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkComponent"><type>AtkComponent</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-component-ref-accessible-at-point" role="function">
<title>atk_component_ref_accessible_at_point ()</title>
<indexterm zone="atk-component-ref-accessible-at-point"><primary>atk_component_ref_accessible_at_point</primary></indexterm><programlisting><link linkend="AtkObject">AtkObject</link>*          atk_component_ref_accessible_at_point
                                                        (<link linkend="AtkComponent">AtkComponent</link> *component,
                                                         <link linkend="gint">gint</link> x,
                                                         <link linkend="gint">gint</link> y,
                                                         <link linkend="AtkCoordType">AtkCoordType</link> coord_type);</programlisting>
<para>
Gets a reference to the accessible child, if one exists, at the
coordinate point specified by <parameter>x</parameter> and <parameter>y</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>component</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="AtkComponent"><type>AtkComponent</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> x coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> y coordinate