Tekkotsu Homepage
Demos
Overview
Downloads
Dev. Resources
Reference
Credits

StringInputControl Class Reference

#include <StringInputControl.h>

Inheritance diagram for StringInputControl:

List of all members.


Detailed Description

Upon activation, prompts the user for a string and stores it.

Definition at line 10 of file StringInputControl.h.


Public Member Functions

 StringInputControl (const std::string &n, const std::string &prompt)
 Constructor.
 StringInputControl (const std::string &n, const std::string &desc, const std::string &prompt)
 Constructor.
virtual void refresh ()
 called when the child has deactivated and this control should refresh its display, or some other event (such as the user pressing the refresh button) has happened to cause a refresh to be needed
virtual ControlBasedoReadStdIn (const std::string &prompt)
 prompt the user for text input on the current input device (cin, tekkotsu console (sout), or GUI)
virtual ControlBasetakeInput (const std::string &msg)
 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 const std::string & getLastInput () const
 returns last call to takeInput()
virtual void clearLastInput ()
 clears the last input (i.e. so you can easily tell later if new input is entered)
virtual void setPrompt (const std::string &prompt)
 sets the prompt to give to the user

Protected Attributes

std::string lastInput
 stores the last input to takeInput()
std::string userPrompt
 stores the prompt to send out

Constructor & Destructor Documentation

StringInputControl::StringInputControl ( const std::string &  n,
const std::string &  prompt 
) [inline]

Constructor.

Definition at line 13 of file StringInputControl.h.

StringInputControl::StringInputControl ( const std::string &  n,
const std::string &  desc,
const std::string &  prompt 
) [inline]

Constructor.

Definition at line 15 of file StringInputControl.h.


Member Function Documentation

void StringInputControl::refresh (  )  [virtual]

called when the child has deactivated and this control should refresh its display, or some other event (such as the user pressing the refresh button) has happened to cause a refresh to be needed

Reimplemented from ControlBase.

Reimplemented in ConfigurationEditor::NamedEnumerationEditor, and ValueEditControl< T >.

Definition at line 14 of file StringInputControl.cc.

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

ControlBase * StringInputControl::doReadStdIn ( const std::string &  prompt  )  [virtual]

prompt the user for text input on the current input device (cin, tekkotsu console (sout), or GUI)

The value which is returned is then activate()ed and pushed on the Controller's stack, so you probably want to return this

Reimplemented from ControlBase.

Definition at line 19 of file StringInputControl.cc.

Referenced by refresh().

virtual ControlBase* StringInputControl::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 ControlBase.

Reimplemented in SavePostureControl, SaveWalkControl, and ValueEditControl< T >.

Definition at line 23 of file StringInputControl.h.

Referenced by clearLastInput(), WalkCalibration::refresh(), PostureEditor::refresh(), ConfigurationEditor::NewCollectionEntry::refresh(), ValueEditControl< T >::takeInput(), SaveWalkControl::takeInput(), and SavePostureControl::takeInput().

virtual const std::string& StringInputControl::getLastInput (  )  const [inline, virtual]

virtual void StringInputControl::clearLastInput (  )  [inline, virtual]

clears the last input (i.e. so you can easily tell later if new input is entered)

Definition at line 32 of file StringInputControl.h.

Referenced by ConfigurationEditor::NamedEnumerationEditor::doSelect(), WaypointWalkControl::refresh(), and SensorObserverControl::refresh().

virtual void StringInputControl::setPrompt ( const std::string &  prompt  )  [inline, virtual]

sets the prompt to give to the user

Definition at line 35 of file StringInputControl.h.


Member Data Documentation

std::string StringInputControl::lastInput [protected]

stores the last input to takeInput()

Definition at line 38 of file StringInputControl.h.

Referenced by getLastInput(), and takeInput().

std::string StringInputControl::userPrompt [protected]

stores the prompt to send out

Definition at line 39 of file StringInputControl.h.

Referenced by doReadStdIn(), refresh(), ConfigurationEditor::NamedEnumerationEditor::refresh(), and setPrompt().


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

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