CConsoleBase Class Reference

#include <e32cons.h>

Link against: euser_v5.lib

class CConsoleBase : public CBase

Inherits from

CConsoleBase
- CBase

Public Member Functions
virtual	~CConsoleBase()
pure virtual void	ClearScreen()
pure virtual void	ClearToEndOfLine()
pure virtual TInt	Create(const TDesC &, TSize)
pure virtual TPoint	CursorPos()
IMPORT_C TKeyCode	Getch()
pure virtual TKeyCode	KeyCode()
pure virtual TUint	KeyModifiers()
IMPORT_C void	Printf(TRefByValue< const TDesC >, ...)
pure virtual void	Read(TRequestStatus &)
pure virtual void	ReadCancel()
pure virtual TSize	ScreenSize()
pure virtual void	SetCursorHeight(TInt)
pure virtual void	SetCursorPosAbs(const TPoint &)
pure virtual void	SetCursorPosRel(const TPoint &)
IMPORT_C void	SetPos(TInt)
IMPORT_C void	SetPos(TInt, TInt)
pure virtual void	SetTitle(const TDesC &)
IMPORT_C TInt	WhereX()
IMPORT_C TInt	WhereY()
pure virtual void	Write(const TDesC &)

Protected Member Functions
	CConsoleBase()
virtual IMPORT_C TInt	Extension_(TUint, TAny &, TAny )

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()

Detailed Description

A base class that defines a console interface.

Constructor & Destructor Documentation

CConsoleBase ( )

IMPORT_C

CConsoleBase

(

)

[protected]

Default constructor.

~CConsoleBase ( )

IMPORT_C

~CConsoleBase

(

)

[virtual]

Destructor.

Member Function Documentation

ClearScreen ( )

void

ClearScreen

(

)

[pure virtual]

Clears the console.

ClearToEndOfLine ( )

void

ClearToEndOfLine

(

)

[pure virtual]

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

Create ( const TDesC &, TSize )

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

Creates a new console window.

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

Return Value: KErrNone, if successful; otherwise one of the other system wide error codes.

CursorPos ( )

TPoint

CursorPos

(

)

const [pure virtual]

Gets the current cursor position relative to the console window.

Return Value: The current cursor position.

Extension_ ( TUint, TAny &, TAny )

IMPORT_C TInt	Extension_	(	TUint	aExtensionId,
			TAny *&	a0,
			TAny *	a1
		)	[protected, virtual]

Reimplemented from CBase::Extension_(TUint,TAny *&,TAny *)

Extension function

Getch ( )

IMPORT_C TKeyCode

Getch

(

)

Gets a character from the console.

Return Value: the key code from the console.

KeyCode ( )

TKeyCode

KeyCode

(

)

const [pure virtual]

Gets the current key code value.

Return Value: The key code value.

KeyModifiers ( )

TUint

KeyModifiers

(

)

const [pure virtual]

Gets the current key modifiers.

Return Value: The key modifiers.

Printf ( TRefByValue< const TDesC >, ... )

IMPORT_C void	Printf	(	TRefByValue< const TDesC >	aFmt,
			...
		)

Prints characters to the console window.

Parameters
aFmt	The non-modifiable descriptor containing the format string. The TRefByValue class provides a constructor which takes a TDesC type.

Read ( TRequestStatus & )

void

Read

(

TRequestStatus &

aStatus

)

[pure virtual]

Gets a keystroke from the console window, asynchronously.

Parameters
aStatus	The request status object.

ReadCancel ( )

void

ReadCancel

(

)

[pure virtual]

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

ScreenSize ( )

TSize

ScreenSize

(

)

const [pure virtual]

Gets the size of the console.

SetCursorHeight ( TInt )

void

SetCursorHeight

(

TInt

aPercentage

)

[pure virtual]

Sets the percentage height of the cursor.

Parameters
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

)

[pure virtual]

Puts the cursor at the absolute position in the window.

Parameters
aPoint	The cursor position.

SetCursorPosRel ( const TPoint & )

void

SetCursorPosRel

(

const TPoint &

aPoint

)

[pure virtual]

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

Parameters
aPoint	The cursor position.

SetPos ( TInt )

IMPORT_C void

SetPos

(

TInt

)

Sets the cursor's x-position.

Parameters
aX	The x-position.

SetPos ( TInt, TInt )

IMPORT_C void	SetPos	(	TInt	aX,
			TInt	aY
		)

Sets the cursor's x-position and y-position.

Parameters
aX	The x-position.
aY	The y-position.

SetTitle ( const TDesC & )

void

SetTitle

(

const TDesC &

aTitle

)

[pure virtual]

Sets a new console title.

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

WhereX ( )

IMPORT_C TInt

WhereX

(

)

const

Gets the cursor's x-position.

Return Value: The cursor's x-position.

WhereY ( )

IMPORT_C TInt

WhereY

(

)

const

Gets the cursor's y-position.

Return Value: The cursor's y-position.

Write ( const TDesC & )

void

Write

(

const TDesC &

aDes

)

[pure virtual]

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

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

CConsoleBase Class Reference

Inherits from

Detailed Description

Constructor & Destructor Documentation

CConsoleBase ( )

~CConsoleBase ( )

Member Function Documentation

ClearScreen ( )

ClearToEndOfLine ( )

Create ( const TDesC &, TSize )

CursorPos ( )

Extension_ ( TUint, TAny *&, TAny * )

Getch ( )

KeyCode ( )

KeyModifiers ( )

Printf ( TRefByValue< const TDesC >, ... )

Read ( TRequestStatus & )

ReadCancel ( )

ScreenSize ( )

SetCursorHeight ( TInt )

SetCursorPosAbs ( const TPoint & )

SetCursorPosRel ( const TPoint & )

SetPos ( TInt )

SetPos ( TInt, TInt )

SetTitle ( const TDesC & )

WhereX ( )

WhereY ( )

Write ( const TDesC & )

Extension_ ( TUint, TAny &, TAny )