atkstate.xml

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

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

<refnamediv>
<refname>AtkState</refname>
<refpurpose>An AtkState describes a component's particular state.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="atk-AtkState.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
enum                <link linkend="AtkStateType">AtkStateType</link>;
typedef             <link linkend="AtkState">AtkState</link>;
<link linkend="AtkStateType">AtkStateType</link>        <link linkend="atk-state-type-register">atk_state_type_register</link>             (const <link linkend="gchar">gchar</link> *name);
const <link linkend="gchar">gchar</link>*        <link linkend="atk-state-type-get-name">atk_state_type_get_name</link>             (<link linkend="AtkStateType">AtkStateType</link> type);
<link linkend="AtkStateType">AtkStateType</link>        <link linkend="atk-state-type-for-name">atk_state_type_for_name</link>             (const <link linkend="gchar">gchar</link> *name);
</synopsis>
</refsynopsisdiv>









<refsect1 id="atk-AtkState.description" role="desc">
<title role="desc.title">Description</title>
<para>
An AtkState describes a component's particular state. The actual state of
an component is described by its AtkStateSet, which is a set of AtkStates.
</para>
</refsect1>

<refsect1 id="atk-AtkState.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="AtkStateType" role="enum">
<title>enum AtkStateType</title>
<indexterm zone="AtkStateType"><primary>AtkStateType</primary></indexterm><programlisting>typedef enum
{
  ATK_STATE_INVALID,
  ATK_STATE_ACTIVE,
  ATK_STATE_ARMED,
  ATK_STATE_BUSY,
  ATK_STATE_CHECKED,
  ATK_STATE_DEFUNCT,
  ATK_STATE_EDITABLE,
  ATK_STATE_ENABLED,
  ATK_STATE_EXPANDABLE,
  ATK_STATE_EXPANDED,
  ATK_STATE_FOCUSABLE,
  ATK_STATE_FOCUSED,
  ATK_STATE_HORIZONTAL,
  ATK_STATE_ICONIFIED,
  ATK_STATE_MODAL,
  ATK_STATE_MULTI_LINE,
  ATK_STATE_MULTISELECTABLE,
  ATK_STATE_OPAQUE,
  ATK_STATE_PRESSED,
  ATK_STATE_RESIZABLE,
  ATK_STATE_SELECTABLE,
  ATK_STATE_SELECTED,
  ATK_STATE_SENSITIVE,
  ATK_STATE_SHOWING,
  ATK_STATE_SINGLE_LINE,
  ATK_STATE_STALE,
  ATK_STATE_TRANSIENT,
  ATK_STATE_VERTICAL,
  ATK_STATE_VISIBLE,
  ATK_STATE_MANAGES_DESCENDANTS,
  ATK_STATE_INDETERMINATE,
  ATK_STATE_TRUNCATED,
  ATK_STATE_REQUIRED,
  ATK_STATE_INVALID_ENTRY,
  ATK_STATE_SUPPORTS_AUTOCOMPLETION,
  ATK_STATE_SELECTABLE_TEXT,
  ATK_STATE_DEFAULT,
  ATK_STATE_ANIMATED,
  ATK_STATE_VISITED,
	
  ATK_STATE_LAST_DEFINED
} AtkStateType;
</programlisting>
<para>
The possible types of states of an object</para>
<para>

</para><variablelist role="enum">
<varlistentry id="ATK-STATE-INVALID:CAPS" role="constant">
<term><literal>ATK_STATE_INVALID</literal></term>
<listitem><simpara> Indicates an invalid state - probably an error condition.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-ACTIVE:CAPS" role="constant">
<term><literal>ATK_STATE_ACTIVE</literal></term>
<listitem><simpara> Indicates a window is currently the active window, or is an active subelement within a container or table
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-ARMED:CAPS" role="constant">
<term><literal>ATK_STATE_ARMED</literal></term>
<listitem><simpara> Indicates that the object is 'armed', i.e. will be activated by if a pointer button-release event occurs within its bounds.  Buttons often enter this state when a pointer click occurs within their bounds, as a precursor to activation.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-BUSY:CAPS" role="constant">
<term><literal>ATK_STATE_BUSY</literal></term>
<listitem><simpara>  Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress.  This state may be used by implementors of Document to indicate that content loading is underway.  It also may indicate other 'pending' conditions; clients may wish to interrogate this object when the ATK_STATE_BUSY flag is removed.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-CHECKED:CAPS" role="constant">
<term><literal>ATK_STATE_CHECKED</literal></term>
<listitem><simpara> Indicates this object is currently checked, for instance a checkbox is 'non-empty'.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-DEFUNCT:CAPS" role="constant">
<term><literal>ATK_STATE_DEFUNCT</literal></term>
<listitem><simpara> Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed)
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-EDITABLE:CAPS" role="constant">
<term><literal>ATK_STATE_EDITABLE</literal></term>
<listitem><simpara> Indicates the user can change the contents of this object
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-ENABLED:CAPS" role="constant">
<term><literal>ATK_STATE_ENABLED</literal></term>
<listitem><simpara> 	Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the STATE_SENSITIVE if direct user interaction cannot cause them to acquire STATE_ENABLED. See also: ATK_STATE_SENSITIVE
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-EXPANDABLE:CAPS" role="constant">
<term><literal>ATK_STATE_EXPANDABLE</literal></term>
<listitem><simpara> Indicates this object allows progressive disclosure of its children
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-EXPANDED:CAPS" role="constant">
<term><literal>ATK_STATE_EXPANDED</literal></term>
<listitem><simpara> Indicates this object its expanded - see ATK_STATE_EXPANDABLE above
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-FOCUSABLE:CAPS" role="constant">
<term><literal>ATK_STATE_FOCUSABLE</literal></term>
<listitem><simpara> Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-FOCUSED:CAPS" role="constant">
<term><literal>ATK_STATE_FOCUSED</literal></term>
<listitem><simpara> Indicates this object currently has the keyboard focus
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-HORIZONTAL:CAPS" role="constant">
<term><literal>ATK_STATE_HORIZONTAL</literal></term>
<listitem><simpara> Indicates the orientation of this object is horizontal; used, for instance, by objects of ATK_ROLE_SCROLL_BAR.  For objects where vertical/horizontal orientation is especially meaningful.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-ICONIFIED:CAPS" role="constant">
<term><literal>ATK_STATE_ICONIFIED</literal></term>
<listitem><simpara> Indicates this object is minimized and is represented only by an icon
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-MODAL:CAPS" role="constant">
<term><literal>ATK_STATE_MODAL</literal></term>
<listitem><simpara> Indicates something must be done with this object before the user can interact with an object in a different window
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-MULTI-LINE:CAPS" role="constant">
<term><literal>ATK_STATE_MULTI_LINE</literal></term>
<listitem><simpara> Indicates this (text) object can contain multiple lines of text
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-MULTISELECTABLE:CAPS" role="constant">
<term><literal>ATK_STATE_MULTISELECTABLE</literal></term>
<listitem><simpara> Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-OPAQUE:CAPS" role="constant">
<term><literal>ATK_STATE_OPAQUE</literal></term>
<listitem><simpara> Indicates this object paints every pixel within its rectangular region.
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-PRESSED:CAPS" role="constant">
<term><literal>ATK_STATE_PRESSED</literal></term>
<listitem><simpara> Indicates this object is currently pressed; c.f. ATK_STATE_ARMED
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-RESIZABLE:CAPS" role="constant">
<term><literal>ATK_STATE_RESIZABLE</literal></term>
<listitem><simpara> Indicates the size of this object is not fixed
</simpara></listitem>
</varlistentry>
<varlistentry id="ATK-STATE-SELECTABLE:CAPS" role="constant">
<term><literal>ATK_STATE_SELECTABLE</literal></term>