Homepage Demos Overview Downloads Tutorials Reference
Credits

StringInputControl Class Reference

#include <StringInputControl.h>

Inheritance diagram for StringInputControl:

Inheritance graph
[legend]
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 died and this control should refresh its display

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 not have been prompted by doReadStdIn()!)

virtual std::string getLastInput ()
 returns last call to takeInput()

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.

References lastInput, and userPrompt.

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

Constructor.

Definition at line 15 of file StringInputControl.h.

References lastInput, and userPrompt.


Member Function Documentation

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)

Reimplemented from ControlBase.

Definition at line 19 of file StringInputControl.cc.

References ControlBase::doReadStdIn(), ControlBase::getName(), ControlBase::gui_comm, Wireless::isConnected(), Socket::sock, userPrompt, wireless, and Socket::write().

Here is the call graph for this function:

virtual std::string StringInputControl::getLastInput  )  [inline, virtual]
 

returns last call to takeInput()

Definition at line 29 of file StringInputControl.h.

References lastInput.

void StringInputControl::refresh  )  [virtual]
 

called when the child has died and this control should refresh its display

Reimplemented from ControlBase.

Reimplemented in ValueEditControl< T >.

Definition at line 14 of file StringInputControl.cc.

References doReadStdIn(), ControlBase::refresh(), and userPrompt.

Here is the call graph for this function:

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

sets the prompt to give to the user

Definition at line 32 of file StringInputControl.h.

References userPrompt.

virtual ControlBase* StringInputControl::takeInput const std::string &  msg  )  [inline, virtual]
 

called when the user has supplied a text string (may not have been prompted by doReadStdIn()!)

Reimplemented from ControlBase.

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

Definition at line 23 of file StringInputControl.h.

References lastInput.


Member Data Documentation

std::string StringInputControl::lastInput [protected]
 

stores the last input to takeInput()

Definition at line 35 of file StringInputControl.h.

std::string StringInputControl::userPrompt [protected]
 

stores the prompt to send out

Definition at line 36 of file StringInputControl.h.


The documentation for this class was generated from the following files:
Tekkotsu v1.5
Generated Fri Oct 10 15:57:54 2003 by Doxygen 1.3.4