atkstate.xml

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

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

<refnamediv>
<refname>AtkState</refname><refpurpose>An AtkState describes a component's particular state.</refpurpose>
</refnamediv>

<refsynopsisdiv><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);
G_CONST_RETURN <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>
<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>
<title>Details</title>
<refsect2>
<title><anchor id="AtkStateType"/>enum AtkStateType</title>
<indexterm><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_LAST_DEFINED
} AtkStateType;
</programlisting>
<para>
The possible types of states of an object</para>
<para>

</para><variablelist role="enum">
<varlistentry>
<term><literal>ATK_STATE_INVALID</literal></term>
<listitem><simpara> Indicates an invalid state
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_ACTIVE</literal></term>
<listitem><simpara> Indicates a window is currently the active window
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_ARMED</literal></term>
<listitem><simpara> Indicates that the object is armed
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_BUSY</literal></term>
<listitem><simpara> Indicates the current object is busy
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_CHECKED</literal></term>
<listitem><simpara> Indicates this object is currently checked
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_DEFUNCT</literal></term>
<listitem><simpara> Indicates the user interface object corresponding to this object no longer exists
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_EDITABLE</literal></term>
<listitem><simpara> Indicates the user can change the contents of this object
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_ENABLED</literal></term>
<listitem><simpara> Indicates that this object is enabled
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_EXPANDABLE</literal></term>
<listitem><simpara> Indicates this object allows progressive disclosure of its children
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_EXPANDED</literal></term>
<listitem><simpara> Indicates this object its expanded
</simpara></listitem>
</varlistentry>
<varlistentry>
<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>
<term><literal>ATK_STATE_FOCUSED</literal></term>
<listitem><simpara> Indicates this object currently has the keyboard focus
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_HORIZONTAL</literal></term>
<listitem><simpara> Indicates the orientation of this object is horizontal
</simpara></listitem>
</varlistentry>
<varlistentry>
<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>
<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>
<term><literal>ATK_STATE_MULTI_LINE</literal></term>
<listitem><simpara> Indicates this (text) object can contain multiple lines of text
</simpara></listitem>
</varlistentry>
<varlistentry>
<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
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_OPAQUE</literal></term>
<listitem><simpara> Indicates this object paints every pixel within its rectangular region
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_PRESSED</literal></term>
<listitem><simpara> Indicates this object is currently pressed
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_RESIZABLE</literal></term>
<listitem><simpara> Indicates the size of this object is not fixed
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_SELECTABLE</literal></term>
<listitem><simpara> Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_SELECTED</literal></term>
<listitem><simpara> Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_SENSITIVE</literal></term>
<listitem><simpara> Indicates this object is sensitive
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_SHOWING</literal></term>
<listitem><simpara> Indicates this object, the object's parent, the object's parent's parent, and so on, are all visible
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_SINGLE_LINE</literal></term>
<listitem><simpara> Indicates this (text) object can contain only a single line of text
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_STALE</literal></term>
<listitem><simpara> Indicates that the index associated with this object has changed since the user accessed the object.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_TRANSIENT</literal></term>
<listitem><simpara> Indicates this object is transient
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_VERTICAL</literal></term>
<listitem><simpara> Indicates the orientation of this object is vertical
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_VISIBLE</literal></term>
<listitem><simpara> Indicates this object is visible
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_MANAGES_DESCENDANTS</literal></term>
<listitem><simpara> Indicates that "active-descendant-changed" event
is sent when children become 'active' (i.e. are selected or navigated to onscreen).
Used to prevent need to enumerate all children in very large containers, like tables.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_INDETERMINATE</literal></term>
<listitem><simpara> Indicates that a check box is in a state other than checked or not checked.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><literal>ATK_STATE_LAST_DEFINED</literal></term>
<listitem><simpara> Not a valid state, used for finding end of enumeration
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="AtkState"/>AtkState</title>
<indexterm><primary>AtkState</primary></indexterm><programlisting>typedef guint64      AtkState;
</programlisting>
<para>
The AtkState value should not be referenceed directly.

</para></refsect2>
<refsect2>
<title><anchor id="atk-state-type-register"/>atk_state_type_register ()</title>
<indexterm><primary>atk_state_type_register</primary></indexterm><programlisting><link linkend="AtkStateType">AtkStateType</link> atk_state_type_register        (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Register a new object state.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> a character string describing the new state.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an <link linkend="AtkState"><type>AtkState</type></link> value for the new state.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-state-type-get-name"/>atk_state_type_get_name ()</title>
<indexterm><primary>atk_state_type_get_name</primary></indexterm><programlisting>G_CONST_RETURN <link linkend="gchar">gchar</link>* atk_state_type_get_name
                                            (<link linkend="AtkStateType">AtkStateType</link> type);</programlisting>
<para>
Gets the description string describing the <link linkend="AtkStateType"><type>AtkStateType</type></link> <parameter>type</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
<listitem><simpara> The <link linkend="AtkStateType"><type>AtkStateType</type></link> whose name is required
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the string describing the AtkStateType
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="atk-state-type-for-name"/>atk_state_type_for_name ()</title>
<indexterm><primary>atk_state_type_for_name</primary></indexterm><programlisting><link linkend="AtkStateType">AtkStateType</link> atk_state_type_for_name        (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Gets the <link linkend="AtkStateType"><type>AtkStateType</type></link> corresponding to the description string <parameter>name</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
<listitem><simpara> a character string state name
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an <link linkend="AtkStateType"><type>AtkStateType</type></link> corresponding to <parameter>name</parameter> 
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>