DtCommandInput Class Reference

Collaboration diagram for DtCommandInput:

Public Member Functions
	DtCommandInput ()
	~DtCommandInput ()
virtual bool	keyboardTick (char *command)
	Check for keyboard input and copy input to command when Enter is pressed. More...
virtual void	forceInput ()
	Block on next keyboard tick until Enter is pressed. More...
virtual void	restoreCommand (int index)
	Restore the previous command with the given index. More...
virtual void	eraseLastCommand ()
	Erase last command. More...
virtual void	printHistory (unsigned int start=0, unsigned int end=65535) const
	Print history from start to finish, default is entire list. More...

Protected Member Functions
virtual bool	processInput (unsigned int x, char *command)
	Process input. More...
virtual int	isEndOfLine (unsigned int x)
	Is character eol? More...
virtual void	append (char x)
	Append character to command line. More...
virtual void	unAppend (void)
	Unappend character to command line. More...
virtual bool	isEmpty () const
	Is command line empty? More...
virtual void	saveCommand ()
	Save the command. More...
virtual void	restorePreviousCommand ()
	Restore the previous command. More...
virtual void	restoreNextCommand ()
	Restore next command. More...
virtual void	clearCommand ()
	Clear the current command. More...

Protected Attributes
char	myCommandLine [1024]
std::deque< DtString >	myPreviousCommands
int	myMaxCommands
int	myLastCommandIndex
char	myClearLine [1024]
bool	myForceInput
bool	myPromptOnScreen
bool	mySurpressPrompt

Constructor & Destructor Documentation

DtCommandInput::DtCommandInput

(

)

DtCommandInput::~DtCommandInput

(

)

Member Function Documentation

virtual void DtCommandInput::append ( char  x )

protectedvirtual

Append character to command line.

virtual void DtCommandInput::clearCommand ( )

protectedvirtual

Clear the current command.

virtual void DtCommandInput::eraseLastCommand ( )

virtual

Erase last command.

virtual void DtCommandInput::forceInput ( )

virtual

Block on next keyboard tick until Enter is pressed.

virtual bool DtCommandInput::isEmpty ( ) const

protectedvirtual

Is command line empty?

virtual int DtCommandInput::isEndOfLine ( unsigned int  x )

protectedvirtual

Is character eol?

virtual bool DtCommandInput::keyboardTick ( char *  command )

virtual

Check for keyboard input and copy input to command when Enter is pressed.

Return true if command (non empty) is ready for processing Note: Non-blocking until input is pending, then blocking until Enter is pressed.

virtual void DtCommandInput::printHistory ( unsigned int  start = 0, unsigned int  end = 65535  ) const

virtual

Print history from start to finish, default is entire list.

virtual bool DtCommandInput::processInput ( unsigned int  x, char *  command  )

protectedvirtual

Process input.

virtual void DtCommandInput::restoreCommand ( int  index )

virtual

Restore the previous command with the given index.

virtual void DtCommandInput::restoreNextCommand ( )

protectedvirtual

Restore next command.

virtual void DtCommandInput::restorePreviousCommand ( )

protectedvirtual

Restore the previous command.

virtual void DtCommandInput::saveCommand ( )

protectedvirtual

Save the command.

virtual void DtCommandInput::unAppend ( void  )

protectedvirtual

Unappend character to command line.

Member Data Documentation

char DtCommandInput::myClearLine[1024]

protected

char DtCommandInput::myCommandLine[1024]

protected

bool DtCommandInput::myForceInput

protected

int DtCommandInput::myLastCommandIndex

protected

int DtCommandInput::myMaxCommands

protected

std::deque<DtString> DtCommandInput::myPreviousCommands

protected

bool DtCommandInput::myPromptOnScreen

protected

bool DtCommandInput::mySurpressPrompt

protected

---

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

• consoleInput.h