Symbian^3 Application Developer Library >

CConsoleBase Class Reference

class CConsoleBase : public CBase

A base class that defines a console interface.

Inherits from

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

Constructor & Destructor Documentation

CConsoleBase()

IMPORT_C CConsoleBase ( ) [protected]

Default constructor.

~CConsoleBase()

IMPORT_C ~CConsoleBase ( ) [virtual]

Destructor.

Member Functions 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

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 [pure virtual]

Gets the current cursor position relative to the console window.

Extension_(TUint, TAny *&, TAny *)

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

Extension function

Parameters

TUint aExtensionId
TAny *& a0
TAny * a1

Getch()

IMPORT_C TKeyCode Getch ( )

Gets a character from the console.

KeyCode()

TKeyCode KeyCode ( ) const [pure virtual]

Gets the current key code value.

KeyModifiers()

TUint KeyModifiers ( ) const [pure virtual]

Gets the current key modifiers.

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

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

Prints characters to the console window.

Parameters

TRefByValue < const TDesC > 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

TRequestStatus & 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

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 ) [pure 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 ) [pure virtual]

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

Parameters

const TPoint & aPoint The cursor position.

SetPos(TInt)

IMPORT_C void SetPos ( TInt aX )

Sets the cursor's x-position.

Parameters

TInt 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

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

SetTitle(const TDesC &)

void SetTitle ( const TDesC & aTitle ) [pure virtual]

Sets a new console title.

Parameters

const TDesC & 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.

WhereY()

IMPORT_C TInt WhereY ( ) const

Gets 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

const TDesC & aDes Descriptor containing the characters to be written to the console window.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.