Google

Main Page   Class Hierarchy   Compound List   File List   Compound Members  

iConsoleInput Struct Reference

This is a plugin that can handle keyboard input and display it on an associated console. More...

#include <conin.h>

Inheritance diagram for iConsoleInput:

iBase List of all members.

Public Methods

virtual void Bind (iConsoleOutput *)=0
 Bind to a console.

virtual void SetExecuteCallback (iConsoleExecCallback *iCallback)=0
 Set the command execution callback.

virtual iConsoleExecCallbackGetExecuteCallback ()=0
 Get the command execution callback.

virtual const char* GetText (int iLine=-1) const=0
 Return a line from the input buffer (-1 = current line).

virtual int GetCurLine () const=0
 Return the current input line number.

virtual int GetBufferSize () const=0
 Retrieve the size of the history buffer.

virtual void SetBufferSize (int iSize)=0
 Set the size of the history buffer;.

virtual void Clear ()=0
 Clear the history buffer.

virtual void SetPrompt (const char *iPrompt)=0
 Set the prompt string.

virtual bool HandleEvent (iEvent &)=0
 Handle a console-related event.


Detailed Description

This is a plugin that can handle keyboard input and display it on an associated console.

The plugin has a command history and when user presses <Enter> can call some callback function to execute the entered command.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000