AtspiStateSet

AtspiStateSet

Synopsis

                    AtspiStateSet;
                    AtspiStateSetClass;
AtspiStateSet *     atspi_state_set_new                 (GArray *states);
void                atspi_state_set_set_by_name         (AtspiStateSet *set,
                                                         const gchar *name,
                                                         gboolean enabled);
void                atspi_state_set_add                 (AtspiStateSet *set,
                                                         AtspiStateType state);
AtspiStateSet *     atspi_state_set_compare             (AtspiStateSet *set,
                                                         AtspiStateSet *set2);
gboolean            atspi_state_set_contains            (AtspiStateSet *set,
                                                         AtspiStateType state);
gboolean            atspi_state_set_equals              (AtspiStateSet *set,
                                                         AtspiStateSet *set2);
GArray *            atspi_state_set_get_states          (AtspiStateSet *set);
gboolean            atspi_state_set_is_empty            (AtspiStateSet *set);
void                atspi_state_set_remove              (AtspiStateSet *set,
                                                         AtspiStateType state);

Object Hierarchy

  GObject
   +----AtspiStateSet

Description

Details

AtspiStateSet

typedef struct _AtspiStateSet AtspiStateSet;

AtspiStateSetClass

typedef struct {
  GObjectClass parent_class;
} AtspiStateSetClass;

atspi_state_set_new ()

AtspiStateSet *     atspi_state_set_new                 (GArray *states);

states :

Returns :

atspi_state_set_set_by_name ()

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

set :

name :

enabled :

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.

Add a particular AtspiState to an AtspiStateSet (i.e. set the given state to TRUE in the stateset.

set :

state :

atspi_state_set_compare ()

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

Determine the differences between two instances of AtspiStateSet. . see AtspiStateSet_equals().

set :

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

set2 :

Returns :

 an AtspiStateSet object containing all states contained on one of the two sets but not the other. [transfer full]

atspi_state_set_contains ()

gboolean            atspi_state_set_contains            (AtspiStateSet *set,
                                                         AtspiStateType state);

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

set :

 a pointer to the AtspiStateSet object on which to operate.

state :

 an AtspiStateType for which the specified AtspiStateSet will be queried.

Returns :

 TRUE if state is true/included in the given AtspiStateSet, otherwise FALSE.

atspi_state_set_equals ()

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

Determine whether two instances of AtspiStateSet are equivalent (i.e. consist of the same AtspiStates). Useful for checking multiple state variables at once; construct the target state then compare against it.

see AtspiStateSet_compare().

set :

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

set2 :

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

Returns :

 TRUE if the two AtspiStateSets are equivalent, otherwise FALSE.

atspi_state_set_get_states ()

GArray *            atspi_state_set_get_states          (AtspiStateSet *set);

set: The AtspiStateSet to be queried.

Return the states in an AtspiStateSet as an array.

set :

Returns :

 A GArray of state types representing the current state. [element-type AtspiStateType][transfer full AtspiStateType]

atspi_state_set_is_empty ()

gboolean            atspi_state_set_is_empty            (AtspiStateSet *set);

set: The AtspiStateSet to query.

set :

Returns :

 TRUE if the state set contains no states; FALSE otherwise.

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 specifiedn state set.

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

set :

state :
Generated by GTK-Doc V1.15