atkobject.xml

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

</varlistentry>
<varlistentry id="ATK-ROLE-FORM:CAPS" role="constant">
<term><literal>ATK_ROLE_FORM</literal></term>
<listitem><simpara> The object is a container for form controls, for instance as part of a 
web form or user-input form within a document.  This role is primarily a tag/convenience for 
clients when navigating complex documents, it is not expected that ordinary GUI containers will 
always have ATK_ROLE_FORM. <parameter>Since</parameter>: ATK-1.12.0
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-LINK:CAPS" role="constant">
<term><literal>ATK_ROLE_LINK</literal></term>
<listitem><simpara> The object is a hypertext anchor, i.e. a "link" in a
hypertext document.  Such objects are distinct from 'inline'
content which may also use the Hypertext/Hyperlink interfaces
to indicate the range/location within a text object where
an inline or embedded object lies.  <parameter>Since</parameter>: ATK-1.12.1
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-INPUT-METHOD-WINDOW:CAPS" role="constant">
<term><literal>ATK_ROLE_INPUT_METHOD_WINDOW</literal></term>
<listitem><simpara> The object is a window or similar viewport 
which is used to allow composition or input of a 'complex character',
in other words it is an "input method window." <parameter>Since</parameter>: ATK-1.12.1
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-ROLE-LAST-DEFINED:CAPS" role="constant">
<term><literal>ATK_ROLE_LAST_DEFINED</literal></term>
<listitem><simpara> not a valid role, used for finding end of the enumeration
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-role-register" role="function">
<title>atk_role_register ()</title>
<indexterm zone="atk-role-register"><primary>atk_role_register</primary></indexterm><programlisting><link linkend="AtkRole">AtkRole</link>             atk_role_register                   (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Registers the role specified by <parameter>name</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> a character string describing the new role.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an <link linkend="AtkRole"><type>AtkRole</type></link> for the new role.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="AtkLayer" role="enum">
<title>enum AtkLayer</title>
<indexterm zone="AtkLayer"><primary>AtkLayer</primary></indexterm><programlisting>typedef enum
{
  ATK_LAYER_INVALID,
  ATK_LAYER_BACKGROUND,
  ATK_LAYER_CANVAS,
  ATK_LAYER_WIDGET,
  ATK_LAYER_MDI,
  ATK_LAYER_POPUP,
  ATK_LAYER_OVERLAY,
  ATK_LAYER_WINDOW
} AtkLayer;
</programlisting>
<para>
Describes the layer of a component
</para>
<para>
These enumerated "layer values" are used when determining which UI
rendering layer a component is drawn into, which can help in making
determinations of when components occlude one another.</para>
<para>
</para><variablelist role="enum">
<varlistentry id="ATK-LAYER-INVALID:CAPS" role="constant">
<term><literal>ATK_LAYER_INVALID</literal></term>
<listitem><simpara> The object does not have a layer
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-LAYER-BACKGROUND:CAPS" role="constant">
<term><literal>ATK_LAYER_BACKGROUND</literal></term>
<listitem><simpara> This layer is reserved for the desktop background
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-LAYER-CANVAS:CAPS" role="constant">
<term><literal>ATK_LAYER_CANVAS</literal></term>
<listitem><simpara> This layer is used for Canvas components
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-LAYER-WIDGET:CAPS" role="constant">
<term><literal>ATK_LAYER_WIDGET</literal></term>
<listitem><simpara> This layer is normally used for components
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-LAYER-MDI:CAPS" role="constant">
<term><literal>ATK_LAYER_MDI</literal></term>
<listitem><simpara> This layer is used for layered components
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-LAYER-POPUP:CAPS" role="constant">
<term><literal>ATK_LAYER_POPUP</literal></term>
<listitem><simpara> This layer is used for popup components, such as menus
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-LAYER-OVERLAY:CAPS" role="constant">
<term><literal>ATK_LAYER_OVERLAY</literal></term>
<listitem><simpara> This layer is reserved for future use.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-LAYER-WINDOW:CAPS" role="constant">
<term><literal>ATK_LAYER_WINDOW</literal></term>
<listitem><simpara> This layer is used for toplevel windows.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="AtkImplementor" role="struct">
<title>AtkImplementor</title>
<indexterm zone="AtkImplementor"><primary>AtkImplementor</primary></indexterm><programlisting>typedef struct _AtkImplementor AtkImplementor;</programlisting>
<para>
The AtkImplementor interface is implemented by objects for which AtkObject peers may be obtained via calls to iface->(ref_accessible)(implementor);
</para></refsect2>
<refsect2 id="AtkPropertyValues" role="struct">
<title>AtkPropertyValues</title>
<indexterm zone="AtkPropertyValues"><primary>AtkPropertyValues</primary></indexterm><programlisting>typedef struct {
  const gchar  *property_name;
  GValue old_value;
  GValue new_value;
} AtkPropertyValues;
</programlisting>
<para>
<parameter>note</parameter>: For most properties the old_value field of AtkPropertyValues will
not contain a valid value.
</para>
<para>
Currently, the only property for which old_value is used is
accessible-state; for instance if there is a focus state the
property change handler will be called for the object which lost the focus
with the old_value containing an 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 an AtkState value
corresponding to focused.</para>
<para>
The Atk PropertyValue structure is used when notifying a change in property.
Currently, the only property for which old_value is used is
accessible-state; for instance if there is a focus change the
property change handler will be called for the object which lost the focus
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><variablelist role="struct">
<varlistentry>
<term>const&nbsp;<link linkend="gchar">gchar</link>&nbsp;*<structfield>property_name</structfield>;</term>
<listitem><simpara> The name of the ATK property which is being presented or which has been changed.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GValue">GValue</link>&nbsp;<structfield>old_value</structfield>;</term>
<listitem><simpara> The old property value, NULL; in some contexts this value is undefined (see note below).
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GValue">GValue</link>&nbsp;<structfield>new_value</structfield>;</term>
<listitem><simpara> The new value of the named property.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="AtkFunction" role="function">
<title>AtkFunction ()</title>
<indexterm zone="AtkFunction"><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>a gpointer to parameter data.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>Nothing useful, this is only a dummy prototype.


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="AtkPropertyChangeHandler" role="function">
<title>AtkPropertyChangeHandler ()</title>
<indexterm zone="AtkPropertyChangeHandler"><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> an <link linkend="AtkObject"><type>AtkObject</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>Param2</parameter>&nbsp;:</term>
<listitem><simpara> an <link linkend="AtkPropertyValues"><type>AtkPropertyValues</type></link>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-implementor-ref-accessible" role="function">
<title>atk_implementor_ref_accessible ()</title>
<indexterm zone="atk-implementor-ref-accessible"><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>&nbsp;:</term><listitem><simpara> a reference to an object's <link linkend="AtkObject"><type>AtkObject</type></link> implementation
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-get-name" role="function">
<title>atk_object_get_name ()</title>
<indexterm zone="atk-object-get-name"><primary>atk_object_get_name</primary></indexterm><programlisting>const <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>&nbsp;:</term><listitem><simpara> a character string representing the accessible name of the object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="atk-object-get-description" role="function">
<title>atk_object_get_description ()</title>