cee::app::States Class Reference

Class to manage the list of states in the application. More...

Public Member Functions

size_t count () const
 Returns the number of states. More...
 
cee::ug::DataStatecurrent ()
 Returns the current state. More...
 
cee::ug::StateInfo currentInfo () const
 Returns the current state info. More...
 
void setCurrentInfo (cee::ug::StateInfo info)
 Sets the current state info. More...
 
size_t currentIndex () const
 Returns the index of the current state. More...
 
void setCurrentIndex (size_t index)
 Sets the state with index index to current. More...
 
size_t indexOf (cee::ug::StateInfo info) const
 Returns the index of the specified state info info. More...
 
cee::ug::StateInfo info (size_t index) const
 Returns the state info at index. More...
 
cee::ug::StateInfo info (const cee::Str &wildcard) const
 Returns the state info matching the search string wildcard. More...
 
- Public Member Functions inherited from cee::RefCountedObject
void addRef () const
 Increments the reference count for this object. More...
 
void release () const
 Decrements the reference count for this object. More...
 
int refCount () const
 Returns the reference count for this object. More...
 
void setRefCountZero () const
 Sets the ref count to zero, but DOES NOT delete the object. More...
 

Static Public Member Functions

static Statesinstance ()
 States is a singleton. Always access States using this instance() More...
 
Inheritance diagram for cee::app::States:
cee::RefCountedObject

Detailed Description

Class to manage the list of states in the application.

Member Function Documentation

size_t cee::app::States::count ( ) const

Returns the number of states.

DataState * cee::app::States::current ( )

Returns the current state.

size_t cee::app::States::currentIndex ( ) const

Returns the index of the current state.

StateInfo cee::app::States::currentInfo ( ) const

Returns the current state info.

size_t cee::app::States::indexOf ( cee::ug::StateInfo  info) const

Returns the index of the specified state info info.

StateInfo cee::app::States::info ( size_t  index) const

Returns the state info at index.

cee::ug::StateInfo cee::app::States::info ( const cee::Str wildcard) const

Returns the state info matching the search string wildcard.

Return an invalid state info (id == -1) if none found

States * cee::app::States::instance ( )
static

States is a singleton. Always access States using this instance()

void cee::app::States::setCurrentIndex ( size_t  index)

Sets the state with index index to current.

void cee::app::States::setCurrentInfo ( cee::ug::StateInfo  info)

Sets the current state info.