Collapse all Symbian^3 Product Developer Library

CConsoleTextWin Class Reference

class CConsoleTextWin : public CConsoleBase

Inherits from

CConsoleTextWin
- CConsoleBase
  - CBase

Public Member Functions
	CConsoleTextWin()
	~CConsoleTextWin()
void	ClearScreen()
void	ClearToEndOfLine()
RConsole &	Console()
TInt	Create(const TDesC &, TSize)
TPoint	CursorPos()
TKeyCode	KeyCode()
TUint	KeyModifiers()
CConsoleTextWin *	NewL(const TDesC &, TSize)
void	Read(TRequestStatus &)
void	ReadCancel()
TSize	ScreenSize()
void	SetCursorHeight(TInt)
void	SetCursorPosAbs(const TPoint &)
void	SetCursorPosRel(const TPoint &)
void	SetTextAttribute(TTextAttribute)
void	SetTitle(const TDesC &)
void	Write(const TDesC &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CConsoleBase::CConsoleBase()
	CConsoleBase::Extension_(TUint,TAny &,TAny )
	CConsoleBase::Getch()
	CConsoleBase::Printf(TRefByValue< const TDesC >,...)
	CConsoleBase::SetPos(TInt)
	CConsoleBase::SetPos(TInt,TInt)
	CConsoleBase::WhereX()const
	CConsoleBase::WhereY()const
	CConsoleBase::~CConsoleBase()

Private Attributes
RConsole	iConsole
TConsoleKey	iKey

Constructor & Destructor Documentation

CConsoleTextWin()

CConsoleTextWin

(

)

~CConsoleTextWin()

~CConsoleTextWin

(

)

[virtual]

Member Functions Documentation

ClearScreen()

void

ClearScreen

(

)

[virtual]

Clears the console.

ClearToEndOfLine()

void

ClearToEndOfLine

(

)

[virtual]

Clears the console from the current cursor position to the end of the line.

Console()

RConsole &

Console

(

)

Create(const TDesC &, TSize)

TInt	Create	(	const TDesC &	aTitle,
			TSize	aSize
		)	[virtual]

Creates a new console window.

Parameters

const TDesC & aTitle	The title text for the console. This should not be longer than 256 characters.
TSize aSize	The size of the console window.

CursorPos()

TPoint

CursorPos

(

)

const [virtual]

Gets the current cursor position relative to the console window.

KeyCode()

TKeyCode

KeyCode

(

)

const [virtual]

Gets the current key code value.

KeyModifiers()

TUint

KeyModifiers

(

)

const [virtual]

Gets the current key modifiers.

NewL(const TDesC &, TSize)

CConsoleTextWin *	NewL	(	const TDesC &	aTitle,
			TSize	aSize
		)	[static]

Parameters

const TDesC & aTitle
TSize aSize

Read(TRequestStatus &)

void

Read

(

TRequestStatus &

aStatus

)

[virtual]

Gets a keystroke from the console window, asynchronously.

Parameters

TRequestStatus & aStatus

The request status object.

ReadCancel()

void

ReadCancel

(

)

[virtual]

Cancels any outstanding request to get a keystroke from the console window.

ScreenSize()

TSize

ScreenSize

(

)

const [virtual]

Gets the size of the console.

SetCursorHeight(TInt)

void

SetCursorHeight

(

TInt

aPercentage

)

[virtual]

Sets the percentage height of the cursor.

Parameters

TInt aPercentage

The percentage height. This is a value from 0 to 100. If 0 is specified, then no cursor is displayed.

SetCursorPosAbs(const TPoint &)

void

SetCursorPosAbs

(

const TPoint &

aPoint

)

[virtual]

Puts the cursor at the absolute position in the window.

Parameters

const TPoint & aPoint

The cursor position.

SetCursorPosRel(const TPoint &)

void

SetCursorPosRel

(

const TPoint &

aPoint

)

[virtual]

Puts the cursor at the specified position relative to the current cursor position.

Parameters

const TPoint & aPoint

The cursor position.

SetTextAttribute(TTextAttribute)

void

SetTextAttribute

(

TTextAttribute

anAttribute

)

[virtual]

Parameters

TTextAttribute anAttribute

SetTitle(const TDesC &)

void

SetTitle

(

const TDesC &

aTitle

)

[virtual]

Sets a new console title.

Parameters

const TDesC & aTitle

The title text for the console. This should not be longer than 256 characters.

Write(const TDesC &)

void

Write

(

const TDesC &

aDes

)

[virtual]

Writes the content of the specified descriptor to the console window.

Parameters

const TDesC & aDes

Descriptor containing the characters to be written to the console window.

Member Data Documentation

RConsole iConsole

RConsole

iConsole

[private]

TConsoleKey iKey

TConsoleKey

iKey

[private]