![]() |
Public API Reference |
#include <conin.h>
Inheritance diagram for iConsoleInput:
Public Methods | |
virtual void | Bind (iConsoleOutput *)=0 |
Bind to a console. More... | |
virtual void | SetExecuteCallback (iConsoleExecCallback *iCallback)=0 |
Set the command execution callback. More... | |
virtual iConsoleExecCallback * | GetExecuteCallback ()=0 |
Get the command execution callback. More... | |
virtual const char * | GetText (int iLine=-1) const=0 |
Return a line from the input buffer (-1 = current line). More... | |
virtual int | GetCurLine () const=0 |
Return the current input line number. More... | |
virtual int | GetBufferSize () const=0 |
Retrieve the size of the history buffer. More... | |
virtual void | SetBufferSize (int iSize)=0 |
Set the size of the history buffer. More... | |
virtual void | Clear ()=0 |
Clear the history buffer. More... | |
virtual void | SetPrompt (const char *iPrompt)=0 |
Set the prompt string. More... | |
virtual bool | HandleEvent (iEvent &)=0 |
Handle a console-related event. More... |
The plugin has a command history and when user presses 'Enter' can call some callback function to execute the entered command.
WARNING Do NOT use the event handler that may (or may not) be implemented by the console and register that to the event queue. This doesn't work properly. Instead register your own event handler and call HandleEvent() from that.
Definition at line 53 of file conin.h.
|
Bind to a console.
|
|
Clear the history buffer.
|
|
Retrieve the size of the history buffer.
|
|
Return the current input line number.
|
|
Get the command execution callback.
|
|
Return a line from the input buffer (-1 = current line).
|
|
Handle a console-related event. Do NOT use the event handler that may (or may not) be implemented by the console and register that to the event queue. This doesn't work properly. Instead register your own event handler and call HandleEvent() from that. |
|
Set the size of the history buffer.
|
|
Set the command execution callback.
|
|
Set the prompt string.
|