Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

ValueEditControl< T > Class Template Reference

#include <ValueEditControl.h>

Inheritance diagram for ValueEditControl< T >:

List of all members.


Detailed Description

template<class T>
class ValueEditControl< T >

allows real-time modification of a value through a pointer

Todo:
needs some work to really be useful again

Definition at line 21 of file ValueEditControl.h.


Public Member Functions

 ValueEditControl (const std::string &n, T *t)
 constructor
 ValueEditControl (const std::string &n, const std::string &p, T *t)
 constructor
 ValueEditControl (const std::string &n, const std::string &d, const std::string &p, T *t)
 constructor
 ValueEditControl (const ValueEditControl< T > &vec)
 copy constructor
ValueEditControl operator= (const ValueEditControl< T > &vec)
 assignment operator
virtual ~ValueEditControl ()
 destructor
virtual ControlBaseactivate (MotionManager::MC_ID display, Socket *gui)
 reads in current value from target
virtual void processEvent (const EventBase &e)
 will increment/decrement the current and then assign it to the target when head buttons pressed
virtual void refresh ()
 displays current value
virtual void pause ()
 request to continue receiving events so we can modify the value while running
virtual ControlBasedoSelect ()
 if the value of the target!=cur, assigns the current value to the target and all the copies
virtual ControlBasedoNextItem ()
 adds one to the current value
virtual ControlBasedoPrevItem ()
 subtracts one from the current value
virtual ControlBasetakeInput (const std::string &str)
 called when the user has supplied a text string (may or may not have been prompted by doReadStdIn()! May not even be active yet - the user can direct the same input to a set of hilighted menus)
virtual std::string getName () const
 shows current value
Target
accessors for the target pointer

virtual T * getTarget () const
 returns the target pointer
virtual ValueEditControlsetTarget (T *t)
 sets the target pointer - the object pointed to will be overwritten on activate(); returns *this
Copies
accessors for the copies vector, so you can assign the same value to several places if you need to

virtual std::vector< T * > & getCopies ()
 returns a reference to the vector copies
virtual ValueEditControladdCopy (T *t)
 copies.push_back(t)

Protected Attributes

T * target
 the main target
cur
 the value to use when set
std::vector< T * > copies
 additional targets

Constructor & Destructor Documentation

template<class T>
ValueEditControl< T >::ValueEditControl ( const std::string &  n,
T *  t 
) [inline]

constructor

Definition at line 24 of file ValueEditControl.h.

template<class T>
ValueEditControl< T >::ValueEditControl ( const std::string &  n,
const std::string &  p,
T *  t 
) [inline]

constructor

Definition at line 26 of file ValueEditControl.h.

template<class T>
ValueEditControl< T >::ValueEditControl ( const std::string &  n,
const std::string &  d,
const std::string &  p,
T *  t 
) [inline]

constructor

Definition at line 28 of file ValueEditControl.h.

template<class T>
ValueEditControl< T >::ValueEditControl ( const ValueEditControl< T > &  vec  )  [inline]

copy constructor

Definition at line 30 of file ValueEditControl.h.

template<class T>
virtual ValueEditControl< T >::~ValueEditControl (  )  [inline, virtual]

destructor

Definition at line 34 of file ValueEditControl.h.


Member Function Documentation

template<class T>
ValueEditControl ValueEditControl< T >::operator= ( const ValueEditControl< T > &  vec  )  [inline]

assignment operator

Definition at line 32 of file ValueEditControl.h.

template<class T>
virtual ControlBase* ValueEditControl< T >::activate ( MotionManager::MC_ID  display,
Socket gui 
) [inline, virtual]

reads in current value from target

Reimplemented from ControlBase.

Definition at line 37 of file ValueEditControl.h.

template<class T>
virtual void ValueEditControl< T >::processEvent ( const EventBase e  )  [inline, virtual]

will increment/decrement the current and then assign it to the target when head buttons pressed

Implements EventListener.

Definition at line 43 of file ValueEditControl.h.

template<class T>
virtual void ValueEditControl< T >::refresh (  )  [inline, virtual]

displays current value

Reimplemented from StringInputControl.

Definition at line 56 of file ValueEditControl.h.

Referenced by ValueEditControl< T >::doNextItem(), and ValueEditControl< T >::doPrevItem().

template<class T>
virtual void ValueEditControl< T >::pause (  )  [inline, virtual]

request to continue receiving events so we can modify the value while running

Reimplemented from ControlBase.

Definition at line 70 of file ValueEditControl.h.

template<class T>
virtual ControlBase* ValueEditControl< T >::doSelect (  )  [inline, virtual]

if the value of the target!=cur, assigns the current value to the target and all the copies

Reimplemented from ControlBase.

Reimplemented in MCValueEditControl< T >.

Definition at line 78 of file ValueEditControl.h.

Referenced by MCValueEditControl< T >::doSelect(), ValueEditControl< T >::processEvent(), and ValueEditControl< T >::takeInput().

template<class T>
virtual ControlBase* ValueEditControl< T >::doNextItem (  )  [inline, virtual]

adds one to the current value

Reimplemented from ControlBase.

Definition at line 94 of file ValueEditControl.h.

Referenced by ValueEditControl< T >::processEvent().

template<class T>
virtual ControlBase* ValueEditControl< T >::doPrevItem (  )  [inline, virtual]

subtracts one from the current value

Reimplemented from ControlBase.

Definition at line 100 of file ValueEditControl.h.

Referenced by ValueEditControl< T >::processEvent().

template<class T>
virtual ControlBase* ValueEditControl< T >::takeInput ( const std::string &  msg  )  [inline, virtual]

called when the user has supplied a text string (may or may not have been prompted by doReadStdIn()! May not even be active yet - the user can direct the same input to a set of hilighted menus)

The value which is returned is then activate()ed and pushed on the Controller's stack

Reimplemented from StringInputControl.

Definition at line 106 of file ValueEditControl.h.

template<class T>
virtual T* ValueEditControl< T >::getTarget (  )  const [inline, virtual]

returns the target pointer

Definition at line 114 of file ValueEditControl.h.

template<class T>
virtual ValueEditControl& ValueEditControl< T >::setTarget ( T *  t  )  [inline, virtual]

sets the target pointer - the object pointed to will be overwritten on activate(); returns *this

Definition at line 115 of file ValueEditControl.h.

template<class T>
virtual std::vector<T*>& ValueEditControl< T >::getCopies (  )  [inline, virtual]

returns a reference to the vector copies

Definition at line 120 of file ValueEditControl.h.

template<class T>
virtual ValueEditControl& ValueEditControl< T >::addCopy ( T *  t  )  [inline, virtual]

copies.push_back(t)

Definition at line 121 of file ValueEditControl.h.

template<class T>
virtual std::string ValueEditControl< T >::getName (  )  const [inline, virtual]

shows current value

Reimplemented from ControlBase.

Definition at line 125 of file ValueEditControl.h.

Referenced by ValueEditControl< T >::doSelect(), and ValueEditControl< T >::refresh().


Member Data Documentation

template<class T>
std::vector<T*> ValueEditControl< T >::copies [protected]


The documentation for this class was generated from the following file:

Tekkotsu v4.0
Generated Thu Nov 22 00:58:46 2007 by Doxygen 1.5.4