Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

CTerminalControl Class Reference

A terminal UI control class. More...

#include <terminalcontrol.h>

List of all members.

Public Methods

 CTerminalControl (MTerminalObserver *anObserver)
 Terminal control constructor.

void ConstructL (const TRect &aRect, RWindow &aContainerWindow)
 Second-phase constructor.

 ~CTerminalControl ()
 Destructor.

virtual void DrawText (TInt aX, TInt aY, const TDesC &aText, TBool aBold, TBool aUnderline, TRgb aForeground, TRgb aBackground)
 Draws text on the terminal window.

void SetFontL (TBool aLargeFont)
 Changes the terminal font.

void SetGrayed (TBool aGrayed)
 Sets the terminal control to be grayed out or normal.


Detailed Description

A terminal UI control class.

Manages a terminal control on the screen, taking care of drawing the text and delivering keypresses to the user. The terminal user must implement the MTerminalObserver interface.


Constructor & Destructor Documentation

CTerminalControl::CTerminalControl MTerminalObserver *    anObserver
 

Terminal control constructor.

Parameters:
anObserver  The observer class to use.


Member Function Documentation

void CTerminalControl::ConstructL const TRect &    aRect,
RWindow &    aContainerWindow
 

Second-phase constructor.

Must be called before the control is used. FIXME: Replace with NewL.

Parameters:
aRect  Initial terminal control rectangle on screen. Use SetRect() to change the terminal size.
aContainerWindow  The window that contains this control.

void CTerminalControl::DrawText TInt    aX,
TInt    aY,
const TDesC &    aText,
TBool    aBold,
TBool    aUnderline,
TRgb    aForeground,
TRgb    aBackground
[virtual]
 

Draws text on the terminal window.

The coordinates are zero-based character coordinates inside the terminal. There is no clipping -- the terminal control assumes that the user takes care of this.

Cursors can be drawn as text with a different background color.

Parameters:
aX  Text X-coordinate
aY  Text Y-coordinate
aText  The text to draw
aBold  ETrue if text should be bold (not supported currently)
aUnderline  ETrue if text should be underlined.
aForeground  Text foreground color
aBackground  Text background color. The text is drawn inside a solid rectangle colored with this color.

void CTerminalControl::SetFontL TBool    aLargeFont
 

Changes the terminal font.

Parameters:
aLargeFont  ETrue to use the large terminal font

void CTerminalControl::SetGrayed TBool    aGrayed
 

Sets the terminal control to be grayed out or normal.

The terminal control can be grayed out when there is no connection, and it cannot be redrawn properly.

Parameters:
aGrayed  True if the terminal should be grayed out.


The documentation for this class was generated from the following files:
Generated on Sun Feb 9 13:01:29 2003 for PuTTY by doxygen1.2.18