ValueEditControl< T > Class Template Reference
#include <ValueEditControl.h>
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 ControlBase * | activate (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 ControlBase * | doSelect () |
| if the value of the target!=cur, assigns the current value to the target and all the copies | |
| virtual ControlBase * | doNextItem () |
| adds one to the current value | |
| virtual ControlBase * | doPrevItem () |
| subtracts one from the current value | |
| virtual ControlBase * | takeInput (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 ValueEditControl & | setTarget (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 ValueEditControl & | addCopy (T *t) |
| copies.push_back(t) | |
Protected Attributes | |
| T * | target |
| the main target | |
| T | cur |
| the value to use when set | |
| std::vector< T * > | copies |
| additional targets | |
Constructor & Destructor Documentation
| ValueEditControl< T >::ValueEditControl | ( | const std::string & | n, | |
| T * | t | |||
| ) | [inline] |
| ValueEditControl< T >::ValueEditControl | ( | const std::string & | n, | |
| const std::string & | p, | |||
| T * | t | |||
| ) | [inline] |
| ValueEditControl< T >::ValueEditControl | ( | const std::string & | n, | |
| const std::string & | d, | |||
| const std::string & | p, | |||
| T * | t | |||
| ) | [inline] |
| ValueEditControl< T >::ValueEditControl | ( | const ValueEditControl< T > & | vec | ) | [inline] |
| virtual ValueEditControl< T >::~ValueEditControl | ( | ) | [inline, virtual] |
Member Function Documentation
| ValueEditControl ValueEditControl< T >::operator= | ( | const ValueEditControl< T > & | vec | ) | [inline] |
| 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.
| 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.
| 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().
| 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.
| 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().
| 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().
| 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().
| 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.
| virtual T* ValueEditControl< T >::getTarget | ( | ) | const [inline, virtual] |
| 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.
| virtual std::vector<T*>& ValueEditControl< T >::getCopies | ( | ) | [inline, virtual] |
| virtual ValueEditControl& ValueEditControl< T >::addCopy | ( | T * | t | ) | [inline, virtual] |
| 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
T* ValueEditControl< T >::target [protected] |
the main target
Definition at line 132 of file ValueEditControl.h.
Referenced by ValueEditControl< T >::activate(), ValueEditControl< T >::doSelect(), ValueEditControl< T >::getName(), ValueEditControl< T >::getTarget(), ValueEditControl< T >::operator=(), ValueEditControl< T >::refresh(), and ValueEditControl< T >::setTarget().
T ValueEditControl< T >::cur [protected] |
the value to use when set
Definition at line 133 of file ValueEditControl.h.
Referenced by ValueEditControl< T >::activate(), ValueEditControl< T >::doNextItem(), ValueEditControl< T >::doPrevItem(), ValueEditControl< T >::doSelect(), ValueEditControl< T >::operator=(), ValueEditControl< T >::refresh(), and ValueEditControl< T >::takeInput().
std::vector<T*> ValueEditControl< T >::copies [protected] |
additional targets
Definition at line 134 of file ValueEditControl.h.
Referenced by ValueEditControl< T >::addCopy(), ValueEditControl< T >::doSelect(), ValueEditControl< T >::getCopies(), and ValueEditControl< T >::operator=().
The documentation for this class was generated from the following file:
