|  |  |  | AT-SPI C Bindings Reference Manual |  | 
|---|---|---|---|---|
enum AccessibleState; struct AccessibleStateSet; void AccessibleStateSet_ref (AccessibleStateSet *obj); void AccessibleStateSet_unref (AccessibleStateSet *obj); void AccessibleStateSet_add (AccessibleStateSet *obj, AccessibleState state); AccessibleStateSet* AccessibleStateSet_compare (AccessibleStateSet *obj, AccessibleStateSet *obj2); SPIBoolean AccessibleStateSet_contains (AccessibleStateSet *obj, AccessibleState state); SPIBoolean AccessibleStateSet_equals (AccessibleStateSet *obj, AccessibleStateSet *obj2); SPIBoolean AccessibleStateSet_isEmpty (AccessibleStateSet *obj); void AccessibleStateSet_remove (AccessibleStateSet *obj, AccessibleState state);
typedef enum
{
  SPI_STATE_INVALID,
  SPI_STATE_ACTIVE,
  SPI_STATE_ARMED,
  SPI_STATE_BUSY,
  SPI_STATE_CHECKED,
  SPI_STATE_COLLAPSED,
  SPI_STATE_DEFUNCT,
  SPI_STATE_EDITABLE,
  SPI_STATE_ENABLED,
  SPI_STATE_EXPANDABLE,
  SPI_STATE_EXPANDED,
  SPI_STATE_FOCUSABLE,
  SPI_STATE_FOCUSED,
  SPI_STATE_HORIZONTAL,
  SPI_STATE_ICONIFIED,
  SPI_STATE_MODAL,
  SPI_STATE_MULTI_LINE,
  SPI_STATE_MULTISELECTABLE,
  SPI_STATE_OPAQUE,
  SPI_STATE_PRESSED,
  SPI_STATE_RESIZABLE,
  SPI_STATE_SELECTABLE,
  SPI_STATE_SELECTED,
  SPI_STATE_SENSITIVE,
  SPI_STATE_SHOWING,
  SPI_STATE_SINGLE_LINE,
  SPI_STATE_STALE,
  SPI_STATE_TRANSIENT,
  SPI_STATE_VERTICAL,
  SPI_STATE_VISIBLE,
  SPI_STATE_MANAGES_DESCENDANTS, 
  SPI_STATE_INDETERMINATE, 
  SPI_STATE_TRUNCATED,
  SPI_STATE_REQUIRED,
  SPI_STATE_INVALID_ENTRY,
  SPI_STATE_SUPPORTS_AUTOCOMPLETION,
  SPI_STATE_SELECTABLE_TEXT,
  SPI_STATE_IS_DEFAULT,
  SPI_STATE_VISITED,
  SPI_STATE_LAST_DEFINED
} AccessibleState;
The possibles states of an object.
struct AccessibleStateSet {
	guint   ref_count;
	GArray *states;
};
An opaque structure representing an accessible object's state, which can then be queried via AccessibleStateSet APIs.
An AccessibleStateSet determines a component's state set. It is composed of a set of AccessibleState values.
| guint ref_count; | private | 
| GArray * states; | private | 
void AccessibleStateSet_ref (AccessibleStateSet *obj);
Increment the reference count for an AccessibleStateSet object.
| obj: | a pointer to the AccessibleStateSet object on which to operate. | 
void AccessibleStateSet_unref (AccessibleStateSet *obj);
Decrement the reference count for an AccessibleStateSet object.
| obj: | a pointer to the AccessibleStateSet object on which to operate. | 
void AccessibleStateSet_add (AccessibleStateSet *obj, AccessibleState state);
Add a particular AccessibleState to an AccessibleStateSet (i.e. set the given state to TRUE in the stateset.
| obj: | a pointer to the AccessibleStateSet object on which to operate. | 
| state: | an AccessibleState to be added to the specified AccessibleStateSet | 
AccessibleStateSet* AccessibleStateSet_compare (AccessibleStateSet *obj, AccessibleStateSet *obj2);
Determine the differences between two instances of AccessibleStateSet.
Not Yet Implemented.
.
see AccessibleStateSet_equals().
| obj: | a pointer to the first AccessibleStateSet object on which to operate. | 
| obj2: | a pointer to the second AccessibleStateSet object on which to operate. | 
| Returns : | an AccessibleStateSet object containing all states contained on one of the two sets but not the other. | 
SPIBoolean AccessibleStateSet_contains (AccessibleStateSet *obj, AccessibleState state);
Determine whether a given AccessibleStateSet includes a given state; that is,
      whether state is true for the stateset in question.
| obj: | a pointer to the AccessibleStateSet object on which to operate. | 
| state: | an AccessibleState for which the specified AccessibleStateSet will be queried. | 
| Returns : | TRUE if stateis true/included in the given AccessibleStateSet,
         otherwise FALSE. | 
SPIBoolean AccessibleStateSet_equals (AccessibleStateSet *obj, AccessibleStateSet *obj2);
Determine whether two instances of AccessibleStateSet are equivalent (i.e. consist of the same AccessibleStates). Useful for checking multiple state variables at once; construct the target state then compare against it.
see AccessibleStateSet_compare().
| obj: | a pointer to the first AccessibleStateSet object on which to operate. | 
| obj2: | a pointer to the second AccessibleStateSet object on which to operate. | 
| Returns : | TRUE if the two AccessibleStateSets are equivalent, otherwise FALSE. | 
SPIBoolean AccessibleStateSet_isEmpty (AccessibleStateSet *obj);
Determine whether a given AccessibleStateSet is the empty set.
| obj: | a pointer to the AccessibleStateSet object on which to operate. | 
| Returns : | TRUE if the given AccessibleStateSet contains no (true) states, otherwise FALSE. | 
void AccessibleStateSet_remove (AccessibleStateSet *obj, AccessibleState state);
Remove a particular AccessibleState to an AccessibleStateSet (i.e. set the given state to FALSE in the stateset.)
| obj: | a pointer to the AccessibleStateSet object on which to operate. | 
| state: | an AccessibleState to be removed from the specified AccessibleStateSet |