atkobject.xml

linux下图形库开发包atk-1.4.0.tar.gz

with the old_value containing the AtkState value corresponding to focused
and the property change handler will be called for the object which
received the focus with the new_value containing the AtkState value
corresponding to focused.

</para></refsect2>
<refsect2>
<title><anchor id="AtkFunction"/>AtkFunction ()</title>
<indexterm><primary>AtkFunction</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    (*AtkFunction)                  (<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
An AtkFunction is a function definition used for padding which has been added 
to class and interface structures to allow for expansion in the future.

</para><variablelist role="params">
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="AtkPropertyChangeHandler"/>AtkPropertyChangeHandler ()</title>
<indexterm><primary>AtkPropertyChangeHandler</primary></indexterm><programlisting><link linkend="void">void</link>        (*AtkPropertyChangeHandler)     (<link linkend="AtkObject">AtkObject</link>*,
                                             <link linkend="AtkPropertyValues">AtkPropertyValues</link>*);</programlisting>
<para>
An AtkPropertyChangeHandler is a function which is executed when an AtkObject's property changes value. It is specified in a call to 
<link linkend="atk-object-connect-property-change-handler"><function>atk_object_connect_property_change_handler()</function></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>Param1</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>Param2</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-implementor-ref-accessible"/>atk_implementor_ref_accessible ()</title>
<indexterm><primary>atk_implementor_ref_accessible</primary></indexterm><programlisting><link linkend="AtkObject">AtkObject</link>*  atk_implementor_ref_accessible  (<link linkend="AtkImplementor">AtkImplementor</link> *implementor);</programlisting>
<para>
Gets a reference to an object's <link linkend="AtkObject"><type>AtkObject</type></link> implementation, if
the object implements <link linkend="AtkObjectIface"><type>AtkObjectIface</type></link></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>implementor</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="GObject"><type>GObject</type></link> instance which should implement <link linkend="AtkImplementorIface"><type>AtkImplementorIface</type></link>
if a non-null return value is required.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a reference to an object's <link linkend="AtkObject"><type>AtkObject</type></link> implementation
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-get-name"/>atk_object_get_name ()</title>
<indexterm><primary>atk_object_get_name</primary></indexterm><programlisting>G_CONST_RETURN <link linkend="gchar">gchar</link>* atk_object_get_name   (<link linkend="AtkObject">AtkObject</link> *accessible);</programlisting>
<para>
Gets 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><emphasis>Returns</emphasis> :</term><listitem><simpara> a character string representing the accessible name of the object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-get-description"/>atk_object_get_description ()</title>
<indexterm><primary>atk_object_get_description</primary></indexterm><programlisting>G_CONST_RETURN <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> :</term><listitem><simpara> a character string representing the accessible description
of the accessible.

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-get-parent"/>atk_object_get_parent ()</title>
<indexterm><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> :</term><listitem><simpara> a <link linkend="AtkObject"><type>AtkObject</type></link> representing the accessible parent of the accessible
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-get-n-accessible-children"/>atk_object_get_n_accessible_children ()</title>
<indexterm><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> :</term><listitem><simpara> an integer representing the number of accessible children
of the accessible.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-ref-accessible-child"/>atk_object_ref_accessible_child ()</title>
<indexterm><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> :</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>
<title><anchor id="atk-object-ref-relation-set"/>atk_object_ref_relation_set ()</title>
<indexterm><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> :</term><listitem><simpara> an <link linkend="AtkRelationSet"><type>AtkRelationSet</type></link> representing the relation set of the object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-get-layer"/>atk_object_get_layer ()</title>
<indexterm><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.
Returns:</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> :</term><listitem><simpara> an <link linkend="AtkLayer"><type>AtkLayer</type></link> which is the layer of the accessible
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-get-mdi-zorder"/>atk_object_get_mdi_zorder ()</title>
<indexterm><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.
Returns:</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> :</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>
<title><anchor id="atk-object-get-role"/>atk_object_get_role ()</title>
<indexterm><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> :</term><listitem><simpara> an <link linkend="AtkRole"><type>AtkRole</type></link> which is the role of the accessible
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-ref-state-set"/>atk_object_ref_state_set ()</title>
<indexterm><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> :</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>
<title><anchor id="atk-object-get-index-in-parent"/>atk_object_get_index_in_parent ()</title>
<indexterm><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> :</term><listitem><simpara> an integer which is the index of the accessible in its parent
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-set-name"/>atk_object_set_name ()</title>
<indexterm><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>
<title><anchor id="atk-object-set-description"/>atk_object_set_description ()</title>