atkobject.xml

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

<refentry id="AtkObject">
<refmeta>
<refentrytitle role="top_of_page" id="AtkObject.top_of_page">AtkObject</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>ATK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>AtkObject</refname>
<refpurpose>
The base object class for the Accessibility Toolkit API.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="AtkObject.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="AtkObject-struct">AtkObject</link>;
enum                <link linkend="AtkRole">AtkRole</link>;
<link linkend="AtkRole">AtkRole</link>             <link linkend="atk-role-register">atk_role_register</link>                   (const <link linkend="gchar">gchar</link> *name);
enum                <link linkend="AtkLayer">AtkLayer</link>;
                    <link linkend="AtkImplementor">AtkImplementor</link>;
                    <link linkend="AtkPropertyValues">AtkPropertyValues</link>;
<link linkend="gboolean">gboolean</link>            (<link linkend="AtkFunction">*AtkFunction</link>)                      (<link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link>                (<link linkend="AtkPropertyChangeHandler">*AtkPropertyChangeHandler</link>)         (<link linkend="AtkObject">AtkObject</link> *,
                                                         <link linkend="AtkPropertyValues">AtkPropertyValues</link> *);
<link linkend="AtkObject">AtkObject</link>*          <link linkend="atk-implementor-ref-accessible">atk_implementor_ref_accessible</link>      (<link linkend="AtkImplementor">AtkImplementor</link> *implementor);
const <link linkend="gchar">gchar</link>*        <link linkend="atk-object-get-name">atk_object_get_name</link>                 (<link linkend="AtkObject">AtkObject</link> *accessible);
const <link linkend="gchar">gchar</link>*        <link linkend="atk-object-get-description">atk_object_get_description</link>          (<link linkend="AtkObject">AtkObject</link> *accessible);
<link linkend="AtkObject">AtkObject</link>*          <link linkend="atk-object-get-parent">atk_object_get_parent</link>               (<link linkend="AtkObject">AtkObject</link> *accessible);
<link linkend="gint">gint</link>                <link linkend="atk-object-get-n-accessible-children">atk_object_get_n_accessible_children</link>
                                                        (<link linkend="AtkObject">AtkObject</link> *accessible);
<link linkend="AtkObject">AtkObject</link>*          <link linkend="atk-object-ref-accessible-child">atk_object_ref_accessible_child</link>     (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         <link linkend="gint">gint</link> i);
<link linkend="AtkRelationSet">AtkRelationSet</link>*     <link linkend="atk-object-ref-relation-set">atk_object_ref_relation_set</link>         (<link linkend="AtkObject">AtkObject</link> *accessible);
<link linkend="AtkLayer">AtkLayer</link>            <link linkend="atk-object-get-layer">atk_object_get_layer</link>                (<link linkend="AtkObject">AtkObject</link> *accessible);
<link linkend="gint">gint</link>                <link linkend="atk-object-get-mdi-zorder">atk_object_get_mdi_zorder</link>           (<link linkend="AtkObject">AtkObject</link> *accessible);
<link linkend="AtkRole">AtkRole</link>             <link linkend="atk-object-get-role">atk_object_get_role</link>                 (<link linkend="AtkObject">AtkObject</link> *accessible);
<link linkend="AtkStateSet">AtkStateSet</link>*        <link linkend="atk-object-ref-state-set">atk_object_ref_state_set</link>            (<link linkend="AtkObject">AtkObject</link> *accessible);
<link linkend="gint">gint</link>                <link linkend="atk-object-get-index-in-parent">atk_object_get_index_in_parent</link>      (<link linkend="AtkObject">AtkObject</link> *accessible);
<link linkend="void">void</link>                <link linkend="atk-object-set-name">atk_object_set_name</link>                 (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         const <link linkend="gchar">gchar</link> *name);
<link linkend="void">void</link>                <link linkend="atk-object-set-description">atk_object_set_description</link>          (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         const <link linkend="gchar">gchar</link> *description);
<link linkend="void">void</link>                <link linkend="atk-object-set-parent">atk_object_set_parent</link>               (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         <link linkend="AtkObject">AtkObject</link> *parent);
<link linkend="void">void</link>                <link linkend="atk-object-set-role">atk_object_set_role</link>                 (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         <link linkend="AtkRole">AtkRole</link> role);
<link linkend="guint">guint</link>               <link linkend="atk-object-connect-property-change-handler">atk_object_connect_property_change_handler</link>
                                                        (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         <link linkend="AtkPropertyChangeHandler">AtkPropertyChangeHandler</link> *handler);
<link linkend="void">void</link>                <link linkend="atk-object-remove-property-change-handler">atk_object_remove_property_change_handler</link>
                                                        (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         <link linkend="guint">guint</link> handler_id);
<link linkend="void">void</link>                <link linkend="atk-object-notify-state-change">atk_object_notify_state_change</link>      (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         <link linkend="AtkState">AtkState</link> state,
                                                         <link linkend="gboolean">gboolean</link> value);
<link linkend="void">void</link>                <link linkend="atk-object-initialize">atk_object_initialize</link>               (<link linkend="AtkObject">AtkObject</link> *accessible,
                                                         <link linkend="gpointer">gpointer</link> data);
<link linkend="gboolean">gboolean</link>            <link linkend="atk-object-add-relationship">atk_object_add_relationship</link>         (<link linkend="AtkObject">AtkObject</link> *object,
                                                         <link linkend="AtkRelationType">AtkRelationType</link> relationship,
                                                         <link linkend="AtkObject">AtkObject</link> *target);
<link linkend="gboolean">gboolean</link>            <link linkend="atk-object-remove-relationship">atk_object_remove_relationship</link>      (<link linkend="AtkObject">AtkObject</link> *object,
                                                         <link linkend="AtkRelationType">AtkRelationType</link> relationship,
                                                         <link linkend="AtkObject">AtkObject</link> *target);
<link linkend="AtkAttributeSet">AtkAttributeSet</link>*    <link linkend="atk-object-get-attributes">atk_object_get_attributes</link>           (<link linkend="AtkObject">AtkObject</link> *accessible);
const <link linkend="gchar">gchar</link>*        <link linkend="atk-role-get-name">atk_role_get_name</link>                   (<link linkend="AtkRole">AtkRole</link> role);
const <link linkend="gchar">gchar</link>*        <link linkend="atk-role-get-localized-name">atk_role_get_localized_name</link>         (<link linkend="AtkRole">AtkRole</link> role);
<link linkend="AtkRole">AtkRole</link>             <link linkend="atk-role-for-name">atk_role_for_name</link>                   (const <link linkend="gchar">gchar</link> *name);
</synopsis>
</refsynopsisdiv>

<refsect1 id="AtkObject.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----AtkObject
         +----<link linkend="AtkGObjectAccessible">AtkGObjectAccessible</link>
         +----<link linkend="AtkNoOpObject">AtkNoOpObject</link>
</synopsis>

</refsect1>





<refsect1 id="AtkObject.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="AtkObject--accessible-component-layer">accessible-component-layer</link>&quot; <link linkend="gint">gint</link>                  : Read
  &quot;<link linkend="AtkObject--accessible-component-mdi-zorder">accessible-component-mdi-zorder</link>&quot; <link linkend="gint">gint</link>                  : Read
  &quot;<link linkend="AtkObject--accessible-description">accessible-description</link>&quot;   <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="AtkObject--accessible-hypertext-nlinks">accessible-hypertext-nlinks</link>&quot; <link linkend="gint">gint</link>                  : Read
  &quot;<link linkend="AtkObject--accessible-name">accessible-name</link>&quot;          <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="AtkObject--accessible-parent">accessible-parent</link>&quot;        <link linkend="AtkObject">AtkObject</link>*            : Read / Write
  &quot;<link linkend="AtkObject--accessible-role">accessible-role</link>&quot;          <link linkend="gint">gint</link>                  : Read / Write
  &quot;<link linkend="AtkObject--accessible-table-caption">accessible-table-caption</link>&quot; <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="AtkObject--accessible-table-caption-object">accessible-table-caption-object</link>&quot; <link linkend="AtkObject">AtkObject</link>*            : Read / Write
  &quot;<link linkend="AtkObject--accessible-table-column-description">accessible-table-column-description</link>&quot; <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="AtkObject--accessible-table-column-header">accessible-table-column-header</link>&quot; <link linkend="AtkObject">AtkObject</link>*            : Read / Write
  &quot;<link linkend="AtkObject--accessible-table-row-description">accessible-table-row-description</link>&quot; <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="AtkObject--accessible-table-row-header">accessible-table-row-header</link>&quot; <link linkend="AtkObject">AtkObject</link>*            : Read / Write
  &quot;<link linkend="AtkObject--accessible-table-summary">accessible-table-summary</link>&quot; <link linkend="AtkObject">AtkObject</link>*            : Read / Write
  &quot;<link linkend="AtkObject--accessible-value">accessible-value</link>&quot;         <link linkend="gdouble">gdouble</link>               : Read / Write
</synopsis>
</refsect1>

<refsect1 id="AtkObject.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="AtkObject-active-descendant-changed">active-descendant-changed</link>&quot;                      : Run Last / Has Details
  &quot;<link linkend="AtkObject-children-changed">children-changed</link>&quot;                               : Run Last / Has Details
  &quot;<link linkend="AtkObject-focus-event">focus-event</link>&quot;                                    : Run Last
  &quot;<link linkend="AtkObject-property-change">property-change</link>&quot;                                : Run Last / Has Details
  &quot;<link linkend="AtkObject-state-change">state-change</link>&quot;                                   : Run Last / Has Details
  &quot;<link linkend="AtkObject-visible-data-changed">visible-data-changed</link>&quot;                           : Run Last
</synopsis>
</refsect1>


<refsect1 id="AtkObject.description" role="desc">
<title role="desc.title">Description</title>
<para>
This class is the primary class for accessibility support via
the Accessibility ToolKit (ATK).  Objects which are instances
of <link linkend="AtkObject"><type>AtkObject</type></link> (or instances of AtkObject-derived types) are
queried for properties which relate basic (and generic) properties of a
UI component such as name and description.  Instances of <link linkend="AtkObject"><type>AtkObject</type></link>
may also be queried as to whether they implement other ATK interfaces
(e.g. <link linkend="AtkAction"><type>AtkAction</type></link>, <link linkend="AtkComponent"><type>AtkComponent</type></link>, etc.), as appropriate to the role
which a given UI component plays in a user interface.
</para>
<para>All UI components in an application which provide useful
information or services to the user must provide corresponding
<link linkend="AtkObject"><type>AtkObject</type></link> instances on request (in GTK+, for instance, usually
on a call to #<link linkend="gtk-widget-get-accessible"><function>gtk_widget_get_accessible()</function></link>), either via ATK support
built into the toolkit for the widget class or ancestor class, or in
the case of custom widgets, if the inherited <link linkend="AtkObject"><type>AtkObject</type></link> implementation
is insufficient, via instances of a new <link linkend="AtkObject"><type>AtkObject</type></link> subclass. 
</para>
</refsect1>

<refsect1 id="AtkObject.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="AtkObject-struct" role="struct">
<title>AtkObject</title>
<indexterm zone="AtkObject-struct"><primary>AtkObject</primary></indexterm><programlisting>typedef struct _AtkObject AtkObject;</programlisting>
<para>
The AtkObject structure should not be accessed directly.

</para></refsect2>
<refsect2 id="AtkRole" role="enum">
<title>enum AtkRole</title>
<indexterm zone="AtkRole"><primary>AtkRole</primary></indexterm><programlisting>typedef enum
{
  ATK_ROLE_INVALID = 0, 
  ATK_ROLE_ACCEL_LABEL,
  ATK_ROLE_ALERT,
  ATK_ROLE_ANIMATION,
  ATK_ROLE_ARROW,
  ATK_ROLE_CALENDAR,
  ATK_ROLE_CANVAS,
  ATK_ROLE_CHECK_BOX,
  ATK_ROLE_CHECK_MENU_ITEM,
  ATK_ROLE_COLOR_CHOOSER,
  ATK_ROLE_COLUMN_HEADER,
  ATK_ROLE_COMBO_BOX,
  ATK_ROLE_DATE_EDITOR,
  ATK_ROLE_DESKTOP_ICON,
  ATK_ROLE_DESKTOP_FRAME,
  ATK_ROLE_DIAL,
  ATK_ROLE_DIALOG,
  ATK_ROLE_DIRECTORY_PANE,
  ATK_ROLE_DRAWING_AREA,
  ATK_ROLE_FILE_CHOOSER,
  ATK_ROLE_FILLER,
  ATK_ROLE_FONT_CHOOSER,
  ATK_ROLE_FRAME,
  ATK_ROLE_GLASS_PANE,
  ATK_ROLE_HTML_CONTAINER,
  ATK_ROLE_ICON,
  ATK_ROLE_IMAGE,
  ATK_ROLE_INTERNAL_FRAME,
  ATK_ROLE_LABEL,
  ATK_ROLE_LAYERED_PANE,
  ATK_ROLE_LIST,
  ATK_ROLE_LIST_ITEM,
  ATK_ROLE_MENU,
  ATK_ROLE_MENU_BAR,
  ATK_ROLE_MENU_ITEM,
  ATK_ROLE_OPTION_PANE,
  ATK_ROLE_PAGE_TAB,
  ATK_ROLE_PAGE_TAB_LIST,
  ATK_ROLE_PANEL,
  ATK_ROLE_PASSWORD_TEXT,
  ATK_ROLE_POPUP_MENU,
  ATK_ROLE_PROGRESS_BAR,
  ATK_ROLE_PUSH_BUTTON,
  ATK_ROLE_RADIO_BUTTON,
  ATK_ROLE_RADIO_MENU_ITEM,
  ATK_ROLE_ROOT_PANE,
  ATK_ROLE_ROW_HEADER,
  ATK_ROLE_SCROLL_BAR,
  ATK_ROLE_SCROLL_PANE,
  ATK_ROLE_SEPARATOR,
  ATK_ROLE_SLIDER,
  ATK_ROLE_SPLIT_PANE,
  ATK_ROLE_SPIN_BUTTON,
  ATK_ROLE_STATUSBAR,
  ATK_ROLE_TABLE,
  ATK_ROLE_TABLE_CELL,
  ATK_ROLE_TABLE_COLUMN_HEADER,
  ATK_ROLE_TABLE_ROW_HEADER,
  ATK_ROLE_TEAR_OFF_MENU_ITEM,
  ATK_ROLE_TERMINAL,
  ATK_ROLE_TEXT,
  ATK_ROLE_TOGGLE_BUTTON,
  ATK_ROLE_TOOL_BAR,
  ATK_ROLE_TOOL_TIP,
  ATK_ROLE_TREE,
  ATK_ROLE_TREE_TABLE,
  ATK_ROLE_UNKNOWN,
  ATK_ROLE_VIEWPORT,
  ATK_ROLE_WINDOW,
  ATK_ROLE_HEADER,