atk.StateSet.StateSet Class Reference

List of all members.

Detailed Description

Description An AtkStateSet determines a component's state set.

It is composed of a set of AtkStates.


Public Member Functions

AtkStateSet * getStateSetStruct ()
 this (AtkStateSet *atkStateSet)
 Sets our main struct and passes it to the parent class.
 this ()
 Creates a new empty state set.
int isEmpty ()
 Checks whether the state set is empty, i.e.
int addState (AtkStateType type)
 Add a new state for the specified type to the current state set if it is not already present.
void addStates (AtkStateType *types, int nTypes)
 Add the states for the specified types to the current state set.
void clearStates ()
 Removes all states from the state set.
int containsState (AtkStateType type)
 Checks whether the state for the specified type is in the specified set.
int containsStates (AtkStateType *types, int nTypes)
 Checks whether the states for all the specified types are in the specified set.
int removeState (AtkStateType type)
 Removes the state for the specified type from the state set.
AtkStateSet * andSets (AtkStateSet *compareSet)
 Constructs the intersection of the two sets, returning NULL if the intersection is empty.
AtkStateSet * orSets (AtkStateSet *compareSet)
 Constructs the union of the two sets.
AtkStateSet * xorSets (AtkStateSet *compareSet)
 Constructs the exclusive-or of the two sets, returning NULL is empty.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

AtkStateSet * atkStateSet
 the main Gtk struct


Constructor & Destructor Documentation

atk.StateSet.StateSet.this ( AtkStateSet *  atkStateSet  ) 

Sets our main struct and passes it to the parent class.

atk.StateSet.StateSet.this (  ) 

Creates a new empty state set.

Returns: a new AtkStateSet


Member Function Documentation

int atk.StateSet.StateSet.addState ( AtkStateType  type  ) 

Add a new state for the specified type to the current state set if it is not already present.

set: an AtkStateSet type: an AtkStateType Returns: TRUE if the state for type is not already in set.

void atk.StateSet.StateSet.addStates ( AtkStateType types,
int  nTypes 
)

Add the states for the specified types to the current state set.

set: an AtkStateSet types: an array of AtkStateType n_types: The number of elements in the array

AtkStateSet* atk.StateSet.StateSet.andSets ( AtkStateSet *  compareSet  ) 

Constructs the intersection of the two sets, returning NULL if the intersection is empty.

set: an AtkStateSet compare_set: another AtkStateSet Returns: a new AtkStateSet which is the intersection of the two sets.

void atk.StateSet.StateSet.clearStates (  ) 

Removes all states from the state set.

set: an AtkStateSet

int atk.StateSet.StateSet.containsState ( AtkStateType  type  ) 

Checks whether the state for the specified type is in the specified set.

set: an AtkStateSet type: an AtkStateType Returns: TRUE if type is the state type is in set.

int atk.StateSet.StateSet.containsStates ( AtkStateType types,
int  nTypes 
)

Checks whether the states for all the specified types are in the specified set.

set: an AtkStateSet types: an array of AtkStateType n_types: The number of elements in the array Returns: TRUE if all the states for type are in set.

AtkStateSet* atk.StateSet.StateSet.getStateSetStruct (  ) 

void* atk.StateSet.StateSet.getStruct (  )  [protected]

the main Gtk struct as a void*

int atk.StateSet.StateSet.isEmpty (  ) 

Checks whether the state set is empty, i.e.

has no states set. set: an AtkStateType Returns: TRUE if set has no states set, otherwise FALSE

AtkStateSet* atk.StateSet.StateSet.orSets ( AtkStateSet *  compareSet  ) 

Constructs the union of the two sets.

set: an AtkStateSet compare_set: another AtkStateSet Returns: a new AtkStateSet which is the union of the two sets, returning NULL is empty.

int atk.StateSet.StateSet.removeState ( AtkStateType  type  ) 

Removes the state for the specified type from the state set.

set: an AtkStateSet type: an AtkType Returns: TRUE if type was the state type is in set.

AtkStateSet* atk.StateSet.StateSet.xorSets ( AtkStateSet *  compareSet  ) 

Constructs the exclusive-or of the two sets, returning NULL is empty.

The set returned by this operation contains the states in exactly one of the two sets. set: an AtkStateSet compare_set: another AtkStateSet Returns: a new AtkStateSet which contains the states which are in exactly one of the two sets.


Member Data Documentation

AtkStateSet* atk.StateSet.StateSet.atkStateSet [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo