atkobject.xml

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

<indexterm><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>
<title><anchor id="atk-object-set-parent"/>atk_object_set_parent ()</title>
<indexterm><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>
<title><anchor id="atk-object-set-role"/>atk_object_set_role ()</title>
<indexterm><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>
<title><anchor id="atk-object-connect-property-change-handler"/>atk_object_connect_property_change_handler ()</title>
<indexterm><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,
                                             <link linkend="AtkPropertyChangeHandler">AtkPropertyChangeHandler</link> *handler);</programlisting>
<para>
Specifies a function to be called when a property changes value.</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>handler</parameter>&nbsp;:</term>
<listitem><simpara> a function to be called when a property changes its value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="guint"><type>guint</type></link> which is the handler id used in 
<link linkend="atk-object-remove-property-change-handler"><function>atk_object_remove_property_change_handler()</function></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-remove-property-change-handler"/>atk_object_remove_property_change_handler ()</title>
<indexterm><primary>atk_object_remove_property_change_handler</primary></indexterm><programlisting><link linkend="void">void</link>        atk_object_remove_property_change_handler
                                            (<link linkend="AtkObject">AtkObject</link> *accessible,
                                             <link linkend="guint">guint</link> handler_id);</programlisting>
<para>
Removes a property change handler.</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>handler_id</parameter>&nbsp;:</term>
<listitem><simpara> a guint which identifies the handler to be removed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-notify-state-change"/>atk_object_notify_state_change ()</title>
<indexterm><primary>atk_object_notify_state_change</primary></indexterm><programlisting><link linkend="void">void</link>        atk_object_notify_state_change  (<link linkend="AtkObject">AtkObject</link> *accessible,
                                             <link linkend="AtkState">AtkState</link> state,
                                             <link linkend="gboolean">gboolean</link> value);</programlisting>
<para>
Emits a state-change signal for the specified state.</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>state</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkState"><type>AtkState</type></link> whose state is changed
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
<listitem><simpara> a gboolean which indicates whether the state is being set on or off
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-initialize"/>atk_object_initialize ()</title>
<indexterm><primary>atk_object_initialize</primary></indexterm><programlisting><link linkend="void">void</link>        atk_object_initialize           (<link linkend="AtkObject">AtkObject</link> *accessible,
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
This function is called when implementing subclasses of <link linkend="AtkObject"><type>AtkObject</type></link>.
It does initialization required for the new object. It is intended
that this function should called only in the ...<link linkend="new"><function>_new()</function></link> functions used
to create an instance of a subclass of <link linkend="AtkObject"><type>AtkObject</type></link></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>accessible</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="gpointer"><type>gpointer</type></link> which identifies the object for which the AtkObject was created.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-add-relationship"/>atk_object_add_relationship ()</title>
<indexterm><primary>atk_object_add_relationship</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    atk_object_add_relationship     (<link linkend="AtkObject">AtkObject</link> *object,
                                             <link linkend="AtkRelationType">AtkRelationType</link> relationship,
                                             <link linkend="AtkObject">AtkObject</link> *target);</programlisting>
<para>
Adds a relationship of the specified type with the specified target.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="AtkObject"><type>AtkObject</type></link> to which an AtkRelation is to be added. 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>relationship</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="AtkRelationType"><type>AtkRelationType</type></link> of the relation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>target</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="AtkObject"><type>AtkObject</type></link> which is to be the target of the relation.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>TRUE if the relationship is added.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-object-remove-relationship"/>atk_object_remove_relationship ()</title>
<indexterm><primary>atk_object_remove_relationship</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    atk_object_remove_relationship  (<link linkend="AtkObject">AtkObject</link> *object,
                                             <link linkend="AtkRelationType">AtkRelationType</link> relationship,
                                             <link linkend="AtkObject">AtkObject</link> *target);</programlisting>
<para>
Removes a relationship of the specified type with the specified target.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="AtkObject"><type>AtkObject</type></link> from which an AtkRelation is to be removed. 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>relationship</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="AtkRelationType"><type>AtkRelationType</type></link> of the relation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>target</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="AtkObject"><type>AtkObject</type></link> which is the target of the relation to be removed.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>TRUE if the relationship is removed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-role-get-name"/>atk_role_get_name ()</title>
<indexterm><primary>atk_role_get_name</primary></indexterm><programlisting>G_CONST_RETURN <link linkend="gchar">gchar</link>* atk_role_get_name     (<link linkend="AtkRole">AtkRole</link> role);</programlisting>
<para>
Gets the description string describing the <link linkend="AtkRole"><type>AtkRole</type></link> <parameter>role</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>role</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="AtkRole"><type>AtkRole</type></link> whose name is required
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the string describing the AtkRole
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-role-get-localized-name"/>atk_role_get_localized_name ()</title>
<indexterm><primary>atk_role_get_localized_name</primary></indexterm><programlisting>G_CONST_RETURN <link linkend="gchar">gchar</link>* atk_role_get_localized_name
                                            (<link linkend="AtkRole">AtkRole</link> role);</programlisting>
<para>
Gets the localized description string describing the <link linkend="AtkRole"><type>AtkRole</type></link> <parameter>role</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>role</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="AtkRole"><type>AtkRole</type></link> whose localized name is required
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the localized string describing the AtkRole
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-role-for-name"/>atk_role_for_name ()</title>
<indexterm><primary>atk_role_for_name</primary></indexterm><programlisting><link linkend="AtkRole">AtkRole</link>     atk_role_for_name               (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Get the <link linkend="AtkRole"><type>AtkRole</type></link> type corresponding to a rolew 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 role.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="AtkRole"><type>AtkRole</type></link> enumerated type corresponding to the specified
name,
         or <link linkend="ATK-ROLE-INVALID-CAPS"><type>ATK_ROLE_INVALID</type></link> if no matching role is found.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1>
<title>Properties</title>
<variablelist>
<varlistentry><term><anchor id="AtkObject--accessible-component-layer"/>&quot;<literal>accessible-component-layer</literal>&quot; (<link linkend="gint">gint</link> : Read)</term>
<listitem>
<para>The accessible layer of this object .</para>
</listitem></varlistentry>
<varlistentry><term><anchor id="AtkObject--accessible-component-mdi-zorder"/>&quot;<literal>accessible-component-mdi-zorder</literal>&quot; (<link linkend="gint">gint</link> : Read)</term>
<listitem>
<para>The accessible MDI value of this object .</para>
</listitem></varlistentry>
<varlistentry><term><anchor id="AtkObject--accessible-description"/>&quot;<literal>accessible-description</literal>&quot; (<link linkend="gchararray">gchararray</link> : Read / Write)</term>
<listitem>
<para>Description of an object, formatted for assistive technology access.</para>
</listitem></varlistentry>
<varlistentry><term><anchor id="AtkObject--accessible-name"/>&quot;<literal>accessible-name</literal>&quot; (<link linkend="gchararray">gchararray</link> : Read / Write)</term>
<listitem>
<para>Object instance's name formatted for assistive technology access.</para>
</listitem></varlistentry>
<varlistentry><term><anchor id="AtkObject--accessible-parent"/>&quot;<literal>accessible-parent</literal>&quot; (<link linkend="AtkObject">AtkObject</link> : Read / Write)</term>
<listitem>
<para>Is used to notify that the parent has changed .</para>
</listitem></varlistentry>
<varlistentry><term><anchor id="AtkObject--accessible-role"/>&quot;<literal>accessible-role</literal>&quot; (<link linkend="gint">gint</link> : Read / Write)</term>
<listitem>
<para>The accessible role of this object .</para>
</listitem></varlistentry>
<varlistentry><term><anchor id="AtkObject--accessible-table-caption"/>&quot;<literal>accessible-table-caption</literal>&quot; (<link linkend="gchararray">gchararray</link> : Read / Write)</term>
<listitem>
<para>Is used to notify that the table caption has changed; this property should not be used. accessible-table-caption-object should be used instead.</para>
</listitem></varlistentry>
<varlistentry><term><anchor id="AtkObject--accessible-table-caption-object"/>&quot;<literal>accessible-table-caption-object</literal>&quot; (<link linkend="AtkObject">AtkObject</link> : Read / Write)</term>
<listitem>
<para>Is used to notify that the table caption has changed .</para>
</listitem></varlistentry>
<varlistentry><term><anchor id="AtkObject--accessible-table