This is the documentation for Enlighten.
class Geo TerminalProvider
class Geo::TerminalProvider
Inherit from this class to provide a specific tty command processing type.
Variables
| Name | Description |
|---|---|
| ITerminalDelegate * m_pDelegate | The Terminal delegate. |
| ITerminalInputHandler * m_pInputHandler | The input handler. |
| ITerminalOutputHandler * m_pOutputHandler | The output handler. |
Functions
| Name | Description |
|---|---|
| ~TerminalProvider() | (Destructor) Detach the Terminal |
| Attach(ITerminalDelegate *, ITerminalInputHandler *, ITerminalOutputHandler *) | Call with delegate, input and output handler to tie up to this Terminal command provider. |
| Detach() | Call when you've finished with the Terminal. |
| Poll() | Call to give the Terminal provider a chance to process commands. |
| SendConnected() | Send a connected event to the delegate. |
| SendDisconnected() | Send a disconnected event to the delegate. |
| TerminalProvider() | Default constructor just zeroes out the pointers. |
virtual Geo::TerminalProvider::~TerminalProvider
public: virtual ~TerminalProvider()
(Destructor) Detach the Terminal
virtual void Geo::TerminalProvider::Attach
public: virtual void Attach
(
ITerminalDelegate * pDelegate,
ITerminalInputHandler * pInputHandler,
ITerminalOutputHandler * pOutputHandler
)
Call with delegate, input and output handler to tie up to this Terminal command provider.
virtual void Geo::TerminalProvider::Detach
public: virtual void Detach()
Call when you've finished with the Terminal.
virtual void Geo::TerminalProvider::Poll
public: void Poll()
Call to give the Terminal provider a chance to process commands.
void Geo::TerminalProvider::SendConnected
protected: void SendConnected()
Send a connected event to the delegate.
void Geo::TerminalProvider::SendDisconnected
protected: void SendDisconnected()
Send a disconnected event to the delegate.
Geo::TerminalProvider::TerminalProvider
public: TerminalProvider()
Default constructor just zeroes out the pointers.