Google

logo top
Main Page   Widgets   Namespaces   Book  

Atk::StateSet Class Reference

Inheritance diagram for Atk::StateSet:

Inheritance graph
[legend]
List of all members.

Public Methods

virtual ~StateSet ()
AtkStateSet* gobj ()
const AtkStateSet* gobj () const
AtkStateSet* gobj_copy ()
bool is_empty () const
 Checks whether the state set is empty, i.e. has no states set.

bool add_state (StateType type)
 Add a new state for the specified type to the current state set if it is not already present.

void add_states (const Glib::ArrayHandle<StateType>& types)
void clear_states ()
 Removes all states from the state set.

bool contains_state (StateType type)
 Checks whether the state for the specified type is in the specified set.

bool contains_states (const Glib::ArrayHandle<StateType>& types) const
bool remove_state (StateType type)
 Removes the state for the specified type from the state set.

Glib::RefPtr<StateSet> and_sets (const Glib::RefPtr<StateSet>& compare_set)
 Constructs the intersection of the two sets, returning 0 if the intersection is empty.

Glib::RefPtr<StateSet> or_sets (const Glib::RefPtr<StateSet>& compare_set)
 Constructs the union of the two sets.

Glib::RefPtr<StateSet> xor_sets (const Glib::RefPtr<StateSet>& compare_set)
 Constructs the exclusive-or of the two sets, returning 0 is empty.


Static Public Methods

Glib::RefPtr<StateSet> create ()

Protected Methods

 StateSet ()

Related Functions

(Note that these are not member functions.)

Glib::RefPtr<Atk::StateSet> wrap (AtkStateSet* object, bool take_copy=false)

Constructor & Destructor Documentation

virtual Atk::StateSet::~StateSet (   [virtual]
 

Atk::StateSet::StateSet (   [protected]
 


Member Function Documentation

bool Atk::StateSet::add_state ( StateType    type
 

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

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

void Atk::StateSet::add_states ( const Glib::ArrayHandle<StateType>&    types
 

Glib::RefPtr<StateSet> Atk::StateSet::and_sets ( const Glib::RefPtr<StateSet>&    compare_set
 

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

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

void Atk::StateSet::clear_states (  
 

Removes all states from the state set.

bool Atk::StateSet::contains_state ( StateType    type
 

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

Parameters:
type An Atk::StateType.
Returns:
true if type is the state type is in set .

bool Atk::StateSet::contains_states ( const Glib::ArrayHandle<StateType>&    types const
 

Glib::RefPtr<StateSet> Atk::StateSet::create (   [static]
 

const AtkStateSet* Atk::StateSet::gobj (   const [inline]
 

Reimplemented from Glib::ObjectBase.

AtkStateSet* Atk::StateSet::gobj (   [inline]
 

Reimplemented from Glib::ObjectBase.

AtkStateSet* Atk::StateSet::gobj_copy (  
 

bool Atk::StateSet::is_empty (   const
 

Checks whether the state set is empty, i.e. has no states set.

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

Glib::RefPtr<StateSet> Atk::StateSet::or_sets ( const Glib::RefPtr<StateSet>&    compare_set
 

Constructs the union of the two sets.

Parameters:
compare_set Another Atk::StateSet.
Returns:
A new Atk::StateSet which is the union of the two sets, returning 0 is empty.

bool Atk::StateSet::remove_state ( StateType    type
 

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

Parameters:
type An Atk::Type.
Returns:
true if type was the state type is in set .

Glib::RefPtr<StateSet> Atk::StateSet::xor_sets ( const Glib::RefPtr<StateSet>&    compare_set
 

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

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

Parameters:
compare_set Another Atk::StateSet.
Returns:
A new Atk::StateSet which contains the states which are in exactly one of the two sets.


Friends And Related Function Documentation

Glib::RefPtr<Atk::StateSet> wrap ( AtkStateSet*    object,
bool    take_copy = false
[related]
 


The documentation for this class was generated from the following file:
Generated for gtkmm by Doxygen 1.3-rc1 © 1997-2001