Reference Manual
Inti Logo
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

Inti::Atk::StateSet Class Reference

An AtkStateSet C++ wrapper class. More...

#include <inti/atk/stateset.h>

Inheritance diagram for Inti::Atk::StateSet:

Inti::G::Object Inti::G::TypeInstance Inti::MemoryHandler Inti::ReferencedBase List of all members.

Public Member Functions

Constructors
Accessors
Methods

Protected Member Functions

Constructors

Detailed Description

An AtkStateSet C++ wrapper class.

A StateSet determines a component's state set. It is composed of a set of states.


Constructor & Destructor Documentation

Inti::Atk::StateSet::StateSet AtkStateSet *  set,
bool  reference = true
[explicit, protected]
 

Construct a new StateSet from an existing AtkStateSet.

Parameters:
set A pointer to a AtkStateSet.
reference Set false if the initial reference count is floating, set true if it's not.

The set can be a newly created AtkStateSet or an existing AtkStateSet. (see G::Object::Object).


Member Function Documentation

bool Inti::Atk::StateSet::add_state StateType  type  ) 
 

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

Parameters:
type A StateType.
Returns:
true if the state for type is not already in set.

void Inti::Atk::StateSet::add_states const std::vector< StateType > &  types  ) 
 

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

Parameters:
types A vector of StateType.

Pointer<StateSet> Inti::Atk::StateSet::and_sets StateSet compare_set  ) 
 

Constructs the intersection of the states in this set and compare_set.

Parameters:
compare_set Another StateSet.
Returns:
A new StateSet which is the intersection of the two sets, or null if the intersection is empty.

bool Inti::Atk::StateSet::contains_state StateType  type  )  const
 

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

Parameters:
type A StateType.
Returns:
trueif type is the state type is in set.

bool Inti::Atk::StateSet::contains_states const std::vector< StateType > &  types  )  const
 

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

Parameters:
types A vector of StateType
Returns:
true if all the states in types are in set.

bool Inti::Atk::StateSet::is_empty  )  const
 

Checks whether the state set is empty (that is, has no states set).

Returns:
true if set has no states set, otherwise false.

Pointer<StateSet> Inti::Atk::StateSet::or_sets StateSet compare_set  ) 
 

Constructs the union of the states in this set and compare_set.

Parameters:
compare_set Another StateSet.
Returns:
A new StateSet which is the union of the two sets.

bool Inti::Atk::StateSet::remove_state StateType  type  ) 
 

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

Parameters:
type A StateType
Returns:
true if type was in the state set and was removed.

Pointer<StateSet> Inti::Atk::StateSet::xor_sets StateSet compare_set  ) 
 

Constructs the exclusive-or of the states in this set and compare_set.

Parameters:
compare_set Another StateSet.
Returns:
A new StateSet which contains the states which are in exactly one of the two sets, or null if the exclusive-or is empty.

The set returned by this operation contains the states in exactly one of the two sets.


The documentation for this class was generated from the following file: Main Page - Footer


Generated on Sun Sep 14 20:08:08 2003 for Inti by doxygen 1.3.2 written by Dimitri van Heesch, © 1997-2002