Class CConsoleBase

class CConsoleBase : public CBase;

Description

A base class that defines a console interface.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CConsoleBase - A base class that defines a console interface.

Members

Defined in CConsoleBase:

• CConsoleBase()Default constructor.
• ClearScreen()Clears the console.
• ClearToEndOfLine()Clears the console from the current cursor position to the end of the line.
• Create(const TDesC &,TSize)Creates a new console window.
• CursorPos()constGets the current cursor position relative to the console window.
• Extension_(TUint,TAny *&,TAny *)Extension function
• Getch()Gets a character from the console.
• KeyCode()constGets the current key code value.
• KeyModifiers()constGets the current key modifiers.
• Printf(TRefByValue< const TDesC >,...)Prints characters to the console window.
• Read(TRequestStatus &)Gets a keystroke from the console window, asynchronously.
• ReadCancel()Cancels any outstanding request to get a keystroke from the console window.
• ScreenSize()constGets the size of the console.
• SetCursorHeight(TInt)Sets the percentage height of the cursor.
• SetCursorPosAbs(const TPoint &)Puts the cursor at the absolute position in the window.
• SetCursorPosRel(const TPoint &)Puts the cursor at the specified position relative to the current cursor positio...
• SetPos(TInt)Sets the cursor's x-position.
• SetPos(TInt,TInt)Sets the cursor's x-position and y-position.
• SetTitle(const TDesC &)Sets a new console title.
• WhereX()constGets the cursor's x-position.
• WhereY()constGets the cursor's y-position.
• Write(const TDesC &)Writes the content of the specified descriptor to the console window.
• ~CConsoleBase()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C virtual ~CConsoleBase();

Description

Destructor.

protected: IMPORT_C CConsoleBase();

Description

Default constructor.

IMPORT_C TKeyCode Getch();

Description

Gets a character from the console.

Return value

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

Description

Prints characters to the console window.

Parameters

IMPORT_C void SetPos(TInt aX);

Description

Sets the cursor's x-position.

Parameters

IMPORT_C void SetPos(TInt aX, TInt aY);

Description

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

Parameters

IMPORT_C TInt WhereX() const;

Description

Gets the cursor's x-position.

Return value

IMPORT_C TInt WhereY() const;

Description

Gets the cursor's y-position.

Return value

virtual TInt Create(const TDesC &aTitle, TSize aSize)=0;

Description

Creates a new console window.

Parameters

Return value

virtual void Read(TRequestStatus &aStatus)=0;

Description

Gets a keystroke from the console window, asynchronously.

Parameters

virtual void ReadCancel()=0;

Description

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

virtual void Write(const TDesC &aDes)=0;

Description

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

Parameters

virtual TPoint CursorPos() const=0;

Description

Gets the current cursor position relative to the console window.

Return value

virtual void SetCursorPosAbs(const TPoint &aPoint)=0;

Description

Puts the cursor at the absolute position in the window.

Parameters

virtual void SetCursorPosRel(const TPoint &aPoint)=0;

Description

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

Parameters

virtual void SetCursorHeight(TInt aPercentage)=0;

Description

Sets the percentage height of the cursor.

Parameters

virtual void SetTitle(const TDesC &aTitle)=0;

Description

Sets a new console title.

Parameters

virtual void ClearScreen()=0;

Description

Clears the console.

virtual void ClearToEndOfLine()=0;

Description

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

virtual TSize ScreenSize() const=0;

Description

Gets the size of the console.

Return value

virtual TKeyCode KeyCode() const=0;

Description

Gets the current key code value.

Return value

virtual TUint KeyModifiers() const=0;

Description

Gets the current key modifiers.

Return value

protected: IMPORT_C virtual TInt Extension_(TUint aExtensionId, TAny *&a0, TAny *a1);

Description

Extension function

Parameters

Return value