AtkState

Description

An AtkState describes a component's particular state.

Methods and Functions

atkStateTypeRegister(name)
atkStateTypeGetName(type)
atkStateTypeForName(name)

Detailed 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.

Enums and Flags

AtkStateType

The possible types of states of an object

invalid

Indicates an invalid state

active

Indicates a window is currently the active window

armed

Indicates that the object is armed

busy

Indicates the current object is busy

checked

Indicates this object is currently checked

defunct

Indicates the user interface object corresponding to this object no longer exists

editable

Indicates the user can change the contents of this object

enabled

Indicates that this object is enabled. An inconsistent GtkToggleButton is an example of an object which is sensitive but not enabled.

expandable

Indicates this object allows progressive disclosure of its children

expanded

Indicates this object its expanded

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

focused

Indicates this object currently has the keyboard focus

horizontal

Indicates the orientation of this object is horizontal

iconified

Indicates this object is minimized and is represented only by an icon

modal

Indicates something must be done with this object before the user can interact with an object in a different window

multi-line

Indicates this (text) object can contain multiple lines of text

multiselectable

Indicates this object allows more than one of its children to be selected at the same time

opaque

Indicates this object paints every pixel within its rectangular region

pressed

Indicates this object is currently pressed

resizable

Indicates the size of this object is not fixed

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

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

sensitive

Indicates this object is sensitive

showing

Indicates this object, the object's parent, the object's parent's parent, and so on, are all visible

single-line

Indicates this (text) object can contain only a single line of text

stale

Indicates that the index associated with this object has changed since the user accessed the object.

transient

Indicates this object is transient

vertical

Indicates the orientation of this object is vertical

visible

Indicates this object is visible

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.

indeterminate

Indicates that a check box is in a state other than checked or not checked.

truncated

Indicates that an object is truncated, e.g. a text value in a speradsheet cell.

required

Indicates that explicit user interaction with an object is required by the user interface, e.g. a required field in a "web-form" interface.

last-defined

Not a valid state, used for finding end of enumeration

Author(s)

Derived by RGtkGen from GTK+ documentation

References

http://developer.gnome.org/doc/API/2.0/atk/atk-AtkState.html