struct AtspiStateSet

struct AtspiStateSet;

struct AtspiStateSetClass

struct AtspiStateSetClass {
  GObjectClass parent_class;
};

atspi_state_set_new ()

AtspiStateSet *     atspi_state_set_new                 (GArray *states);

states: (element-type AtspiStateType): An array of states with which the method initializes the state set.

Generates an AtspiStateSet with the given states.

atspi_state_set_set_by_name ()

void                atspi_state_set_set_by_name         (AtspiStateSet *set,
                                                         const gchar *name,
                                                         gboolean enabled);

set: a pointer to the AtspiStateSet object on which to operate.

name: a string corresponding to a state name.

enabled: if TRUE, name should be enabled in the set in question; otherwise, it should be disabled.

Enables/disables a state in an AtspiStateSet according to its name.

atspi_state_set_add ()

void                atspi_state_set_add                 (AtspiStateSet *set,
                                                         AtspiStateType state);

set: a pointer to the AtspiStateSet object on which to operate.

state: an AtspiStateType to be added to the specified AtspiStateSet.

Adds a particular AtspiState to an AtspiStateSet (i.e. sets the given state to TRUE in the stateset).

atspi_state_set_compare ()

AtspiStateSet *     atspi_state_set_compare             (AtspiStateSet *set,
                                                         AtspiStateSet *set2);

set: a pointer to the first AtspiStateSet object on which to operate.

set2: a pointer to the second AtspiStateSet object on which to operate.

Determines the differences between two instances of AtspiStateSet.

see atspi_state_set_equals.

atspi_state_set_contains ()

gboolean            atspi_state_set_contains            (AtspiStateSet *set,
                                                         AtspiStateType state);

set: a pointer to the AtspiStateSet object on which to operate.

state: an AtspiStateType for which the specified AtspiStateSet will be queried.

Determines whether a given AtspiStateSet includes a given state; that is, whether state is true for the set in question.

atspi_state_set_equals ()

gboolean            atspi_state_set_equals              (AtspiStateSet *set,
                                                         AtspiStateSet *set2);

set: a pointer to the first AtspiStateSet object on which to operate.

set2: a pointer to the second AtspiStateSet object on which to operate.

Determines whether two instances of AtspiStateSet are equivalent (i.e. consist of the same AtspiStates). Useful for checking multiple state variables at once.

see atspi_state_set_compare.

atspi_state_set_get_states ()

GArray *            atspi_state_set_get_states          (AtspiStateSet *set);

set: The AtspiStateSet to be queried.

Returns the states in an AtspiStateSet as an array.

atspi_state_set_is_empty ()

gboolean            atspi_state_set_is_empty            (AtspiStateSet *set);

set: The AtspiStateSet to query.

atspi_state_set_remove ()

void                atspi_state_set_remove              (AtspiStateSet *set,
                                                         AtspiStateType state);

set: a pointer to the AtspiStateSet object on which to operate.

state: an AtspiStateType to remove from the specified set.

Removes a particular AtspiState to an AtspiStateSet (i.e. sets the given state to FALSE in the stateset.)