## AtkState

AtkState — An AtkState describes a component's particular state.

##

# Synopsis

    enum        AtkStateType;
    typedef     AtkState;
    AtkStateType atk_state_type_register        (const gchar *name);
    G_CONST_RETURN gchar* atk_state_type_get_name
                                                (AtkStateType type);
    AtkStateType atk_state_type_for_name        (const gchar *name);

## Description

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.

## Details

### enum AtkStateType

    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;

The possible types of states of an object

`ATK_STATE_INVALID` | Indicates an invalid state
`ATK_STATE_ACTIVE` | Indicates a window is currently the active window
`ATK_STATE_ARMED` | Indicates that the object is armed
`ATK_STATE_BUSY` | Indicates the current object is busy
`ATK_STATE_CHECKED` | Indicates this object is currently checked
`ATK_STATE_DEFUNCT` | Indicates the user interface object corresponding to this object no longer exists
`ATK_STATE_EDITABLE` | Indicates the user can change the contents of this object
`ATK_STATE_ENABLED` | Indicates that this object is enabled
`ATK_STATE_EXPANDABLE` | Indicates this object allows progressive disclosure of its children
`ATK_STATE_EXPANDED` | Indicates this object its expanded
`ATK_STATE_FOCUSABLE` | 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
`ATK_STATE_FOCUSED` | Indicates this object currently has the keyboard focus
`ATK_STATE_HORIZONTAL` | Indicates the orientation of this object is horizontal
`ATK_STATE_ICONIFIED` | Indicates this object is minimized and is represented only by an icon
`ATK_STATE_MODAL` | Indicates something must be done with this object before the user can interact with an object in a different window
`ATK_STATE_MULTI_LINE` | Indicates this (text) object can contain multiple lines of text
`ATK_STATE_MULTISELECTABLE` | Indicates this object allows more than one of its children to be selected at the same time
`ATK_STATE_OPAQUE` | Indicates this object paints every pixel within its rectangular region
`ATK_STATE_PRESSED` | Indicates this object is currently pressed
`ATK_STATE_RESIZABLE` | Indicates the size of this object is not fixed
`ATK_STATE_SELECTABLE` | 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
`ATK_STATE_SELECTED` | 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
`ATK_STATE_SENSITIVE` | Indicates this object is sensitive
`ATK_STATE_SHOWING` | Indicates this object, the object's parent, the object's parent's parent, and so on, are all visible
`ATK_STATE_SINGLE_LINE` | Indicates this (text) object can contain only a single line of text
`ATK_STATE_STALE` | Indicates that the index associated with this object has changed since the user accessed the object.
`ATK_STATE_TRANSIENT` | Indicates this object is transient
`ATK_STATE_VERTICAL` | Indicates the orientation of this object is vertical
`ATK_STATE_VISIBLE` | Indicates this object is visible
`ATK_STATE_MANAGES_DESCENDANTS` | 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.
`ATK_STATE_INDETERMINATE` | Indicates that a check box is in a state other than checked or not checked.
`ATK_STATE_LAST_DEFINED` | Not a valid state, used for finding end of enumeration

### AtkState

    typedef guint64      AtkState;

The AtkState value should not be referenceed directly.

### atk_state_type_register ()

    AtkStateType atk_state_type_register        (const gchar *name);

Register a new object state.

`name` : | a character string describing the new state.
Returns : | an AtkState value for the new state.

### atk_state_type_get_name ()

    G_CONST_RETURN gchar* atk_state_type_get_name
                                                (AtkStateType type);

Gets the description string describing the AtkStateType `type`.

`type` : | The AtkStateType whose name is required
Returns : | the string describing the AtkStateType

### atk_state_type_for_name ()

    AtkStateType atk_state_type_for_name        (const gchar *name);

Gets the AtkStateType corresponding to the description string `name`.

`name` : | a character string state name
Returns : | an AtkStateType corresponding to `name`