atkcomponent.xml

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

</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> a reference to the accessible child, if one exists
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-component-remove-focus-handler" role="function">
<title>atk_component_remove_focus_handler ()</title>
<indexterm zone="atk-component-remove-focus-handler"><primary>atk_component_remove_focus_handler</primary></indexterm><programlisting><link linkend="void">void</link>                atk_component_remove_focus_handler  (<link linkend="AtkComponent">AtkComponent</link> *component,
                                                         <link linkend="guint">guint</link> handler_id);</programlisting>
<para>
Remove the handler specified by <parameter>handler_id</parameter> from the list of
functions to be executed when this object receives focus events 
(in or out).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>component</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="AtkComponent"><type>AtkComponent</type></link> to remove the focus handler from
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>handler_id</parameter>&nbsp;:</term>
<listitem><simpara> the handler id of the focus handler to be removed
from <parameter>component</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-component-set-extents" role="function">
<title>atk_component_set_extents ()</title>
<indexterm zone="atk-component-set-extents"><primary>atk_component_set_extents</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_component_set_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>
Sets the extents of <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> x coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> y coordinate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> width to set for <parameter>component</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> height to set for <parameter>component</parameter>
</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> whether the extents were set or not
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-component-set-position" role="function">
<title>atk_component_set_position ()</title>
<indexterm zone="atk-component-set-position"><primary>atk_component_set_position</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_component_set_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>
Sets the postition of <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> x coordinate
</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> whether or not the position was set or not
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-component-set-size" role="function">
<title>atk_component_set_size ()</title>
<indexterm zone="atk-component-set-size"><primary>atk_component_set_size</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            atk_component_set_size              (<link linkend="AtkComponent">AtkComponent</link> *component,
                                                         <link linkend="gint">gint</link> width,
                                                         <link linkend="gint">gint</link> height);</programlisting>
<para>
Set 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> width to set for <parameter>component</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> height to set for <parameter>component</parameter>
</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> whether the size was set or not
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-component-get-alpha" role="function" condition="since:ATK 1.12">
<title>atk_component_get_alpha ()</title>
<indexterm zone="atk-component-get-alpha" role="ATK 1.12"><primary>atk_component_get_alpha</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link>             atk_component_get_alpha             (<link linkend="AtkComponent">AtkComponent</link> *component);</programlisting>
<para>
Returns the alpha value (i.e. the opacity) for this
<parameter>component</parameter>, on a scale from 0 (fully transparent) to 1.0
(fully opaque).</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 alpha value from 0 to 1.0, inclusive.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since  ATK 1.12
</para></refsect2>

</refsect1>

<refsect1 id="AtkComponent.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="AtkComponent-bounds-changed"><title>The <literal>&quot;bounds-changed&quot;</literal> signal</title>
<indexterm zone="AtkComponent-bounds-changed"><primary>AtkComponent::bounds-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="AtkComponent">AtkComponent</link> *atkcomponent,
                                                        <link linkend="AtkRectangle">AtkRectangle</link> *arg1,
                                                        <link linkend="gpointer">gpointer</link>      user_data)         : Run Last</programlisting>
<para>
The 'bounds-changed" signal is emitted when the bposition or size of the 
a component changes.
</para><variablelist role="params">
<varlistentry><term><parameter>atkcomponent</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
<listitem><simpara>The AtkRectangle giving the new position and size.

</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>



</refentry>