This class is an interactor that emulates a serial terminal.
![]() | Construction |
![]() | Overrides from class PInteractor |
![]() | New functions for class |
![]() | Overrides from class PInteractor |
![]() | New functions for class |
System callback functions.
Member variables
Overrides from class PObject
This class is an interactor that emulates a serial terminal. This is an abstract class that has specific terminal emulators descended from it eg the \ref{PAnsiTerminal} class.A descendent class should implement the \ref{Write()} function or \ref{ProcessCharacter()} function to output characters to the terminal lines implemented by PTerminal. The descendent may also wish to implement the \ref{PInteractor::OnKeyDown()} and \ref{Reset()} functions for any special keys supported by the terminal or initialisation required when the terminal is reset.
This also determines the coordinate system to be used for laying out child interactors via the \ref{SetPosition()} and \ref{SetDimensions()} functions. The coordinates used are 1/4 average font width and 1/8 the font height.
If the toChildren parameter is TRUE then the font is propagated down to all child interactors and grandchild interactors etc.
virtual void Write( const char * buf, PINDEX len )
len - Length of the buffer of characters.void Write( const PString & str )
virtual BOOL HasSelection() const
virtual PString GetSelection() const
virtual void SetSelection( PINDEX startRow, PINDEX startColumn, PINDEX finishRow, PINDEX finishColumn )
startColumn - Starting column of the selected block
finishRow - Finishing row of the selected block
finishColumn - Finishing column of the selected blockvoid SetKeyboardStream( ostream * out )
PString GetRow(PINDEX idx) const
PINDEX GetTotalRows() const
PINDEX GetMaxSavedRows() const
void SetMaxSavedRows( PINDEX newRows )
PINDEX GetRows() const
PINDEX GetColumns() const
void SetColumns( PINDEX newColumns )
BOOL GetVariableRowColumns() const
void SetVariableRowColumns( BOOL b )
BOOL GetBlockCursor() const
void SetBlockCursor( BOOL b )
BOOL GetWrapEOL() const
void SetWrapEOL( BOOL b )
BOOL GetLineFeedOnReturn() const
void SetLineFeedOnReturn( BOOL b )
BOOL GetReturnOnLineFeed() const
void SetReturnOnLineFeed( BOOL b )
BOOL GetLocalEcho() const
void SetLocalEcho( BOOL b )
The lastTrack parameter can be used to for special action
at the end of the track operation. The mouse pointer is automatically grabbed (via \ref{GrabMouse()})
and released (via \ref{ReleaseMouse()}). The canvas provided is
also automatically created and deleted.
virtual void OnMouseDown( PKeyCode button, const PPoint & where, BOOL doubleClick )
where - The position of the mouse pointer provided in pixels with its origin
at the top left of the interactor.
doubleClick - Is TRUE if the mouse down is the second click of a double click.virtual void OnMouseTrack( PCanvas * canvas, const PPoint & where, BOOL lastTrack )
where - The position of the mouse pointer provided in pixels with its origin
at the top left of the interactor.
lastTrack - This is TRUE if the position is the last track of the drag operation.virtual void OnKeyInput( const PString & str )
virtual void OnRedraw( PCanvas & canvas )
PINDEX maxSavedRows
PDIMENSION cellWidth
PDIMENSION cellHeight
PINDEX rows
PINDEX columns
PINDEX columnsVisible
PINDEX rowsVisible
PINDEX scrollTop
PINDEX scrollBottom
PINDEX cursorRow
PINDEX cursorColumn
Attribute attribute
BOOL variableRowColumns
BOOL blockCursor
BOOL wrapEOL
BOOL lineFeedOnReturn
BOOL returnOnLineFeed
BOOL localEcho
ostream* keyboard
PINDEX updateColumn
PINDEX anchor
BOOL columnModeSelection
Alphabetic index HTML hierarchy of classes or Java