Symbian^3 Application Developer Library >

CEikConsoleScreen Class Reference

class CEikConsoleScreen : public CConsoleBase

Inherits from

Public Member Functions
CEikConsoleScreen ()
~CEikConsoleScreen ()
TUint Att ()
IMPORT_C void ClearChars (const TRect &, TUint )
IMPORT_C void ClearScreen ()
IMPORT_C void ClearToEndOfLine ()
CEikConsoleControl * ConsoleControl ()
IMPORT_C void ConstructL (const TDesC &, TInt )
IMPORT_C void ConstructL (const TDesC &, const TSize &, TInt , TEikConsWinUnits )
IMPORT_C void ConstructL (const TDesC &, TPoint , const TSize &, TInt , TEikConsWinUnits )
IMPORT_C void Cr ()
IMPORT_C TInt Create (const TDesC &, TSize )
IMPORT_C TPoint CursorPos ()
IMPORT_C void Down ( TUint )
IMPORT_C void DrawCursor ()
IMPORT_C void DrawCursorInSight ()
IMPORT_C void DrawInSight ( TPoint )
IMPORT_C void FlushChars ()
IMPORT_C const TFontSpec & Font ()
IMPORT_C TInt HideCursor ()
TUint HistorySize ()
IMPORT_C TKeyCode KeyCode ()
IMPORT_C TUint KeyModifiers ()
IMPORT_C void Left ( TUint )
IMPORT_C void Lf ()
IMPORT_C void MoveTopLeft ( TPoint )
IMPORT_C void Read ( TRequestStatus &)
IMPORT_C void ReadCancel ()
IMPORT_C void Redraw (const TRect &)
IMPORT_C HBufC * RetrieveL (const TRect &)
IMPORT_C void Right ( TUint )
IMPORT_C TSize ScreenSize ()
IMPORT_C void ScrollChars (const TRect &, const TPoint &)
IMPORT_C void SelectCursor ()
IMPORT_C TRect Selection ()
IMPORT_C void SetAllPrintable ( TUint )
IMPORT_C void SetAtt ( TUint )
IMPORT_C void SetAtt ( TUint , TUint )
IMPORT_C void SetConsWin ( CEikConsoleControl *)
IMPORT_C void SetCursorHeight ( TInt )
IMPORT_C void SetCursorPosAbs (const TPoint &)
IMPORT_C void SetCursorPosRel (const TPoint &)
IMPORT_C void SetFontL (const TFontSpec &)
IMPORT_C void SetHistorySizeL ( TUint , TUint )
IMPORT_C void SetKeepCursorInSight ( TUint )
IMPORT_C void SetPureCRLF ( TUint )
IMPORT_C void SetScrollBarVisibilityL ( CEikScrollBarFrame::TScrollBarVisibility , CEikScrollBarFrame::TScrollBarVisibility )
IMPORT_C void SetScrollLock ( TUint )
IMPORT_C void SetSelection (const TRect &)
IMPORT_C void SetTitle (const TDesC &)
IMPORT_C void SetTitleL (const TDesC &)
HBufC * Title ()
IMPORT_C void Up ( TUint )
IMPORT_C TBool UpdateScrollBars ()
IMPORT_C void Write (const TDesC &)
Private Member Functions
void ClipCursor ()
void DrawCursorWhereNeeded ()
TPoint GetAnInSightPosition ( TPoint )
void InvertOverlap ( TPoint , TPoint , TPoint , TPoint )
void InvertRange (const TRect &)
TPtr8 MemAttPtr ( TPoint , TUint )
TPtr MemChrPtr ( TPoint , TUint )
void MemScrClr (const TRect &, TUint8 )
void MemScrMove ( TPoint , TPoint , TUint )
void MemScrPut (const TDesC &, TPoint , TUint8 )
void MemScrScroll (const TRect &, TPoint )
void MemScrScrollUp ( TUint )
TBool RecalculateSize ()
void RedrawChars ( TInt , TInt , TInt , TUint )
TPoint ScrToVis ( TPoint )
TRect ScrToVis (const TRect &)
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()
Public Member Enumerations
enum TEikConsoleFlags { EUseBackedUpWindow  = 0x1, ENoInitialCursor  = 0x2 }
Private Attributes
TUint iAllPrintable
TUint iAtt
TUint8 * iAttBuf
TText * iChrBuf
TInt iConsFlags
CEikConsoleControl * iConsoleControl
TSize iConsoleSize
HBufC * iConsoleTitle
TPoint iCursor
TUint iCursorBlinking
TUint iKeepCursorInSight
TInt iMaxAttExtra
TInt iMaxChrExtra
TInt iNoChrExtra
TUint iPureCRLF
TUint iScrollLock
TRect iSelection
TPoint iTopLeft
TSize iVisSize
TRect iVisWin
TBuf < 256 > iWriteBuffer
TInt iWriteNow

Constructor & Destructor Documentation

CEikConsoleScreen()

IMPORT_C CEikConsoleScreen ( )

CEikConsoleScreen() constructor

~CEikConsoleScreen()

IMPORT_C ~CEikConsoleScreen ( )

CEikConsoleScreen() destructor

Member Functions Documentation

Att()

TUint Att ( ) const [inline]

Att() Attributes

ClearChars(const TRect &, TUint)

IMPORT_C void ClearChars ( const TRect & aRect,
TUint aCharacterAttributes
)

ClearChars() Clears characters within rectangle matching attributes

Parameters

const TRect & aRect Rectangle in pixels
TUint aCharacterAttributes Matching character attributes

ClearScreen()

IMPORT_C void ClearScreen ( ) [virtual]

ClearScreen() Clears the console screen

ClearToEndOfLine()

IMPORT_C void ClearToEndOfLine ( ) [virtual]

ClearToEndOfLine() Clears from cursor position to end of the line

ClipCursor()

void ClipCursor ( ) [private]

ConsoleControl()

CEikConsoleControl * ConsoleControl ( ) const [inline]

ConsoleControl() fetching console control

Returns console control

ConstructL(const TDesC &, TInt)

IMPORT_C void ConstructL ( const TDesC & aTitle,
TInt aFlags
)

ConstructL() Constructs a console and sets title

Parameters

const TDesC & aTitle Title of the console
TInt aFlags Flags, for example EUseBackedUpWindow or ENoInitialCursor

ConstructL(const TDesC &, const TSize &, TInt, TEikConsWinUnits)

IMPORT_C void ConstructL ( const TDesC & aTitle,
const TSize & aSize,
TInt aFlags,
TEikConsWinUnits aUnit = EEikConsWinInChars
)

ConstructL() Constructs a console and sets title and size

Parameters

const TDesC & aTitle Title of the console
const TSize & aSize Size of the console in pixels
TInt aFlags Flags, for example EUseBackedUpWindow or ENoInitialCursor
TEikConsWinUnits aUnit = EEikConsWinInChars Unit of the console

ConstructL(const TDesC &, TPoint, const TSize &, TInt, TEikConsWinUnits)

IMPORT_C void ConstructL ( const TDesC & aTitle,
TPoint aTopLeft,
const TSize & aSize,
TInt aFlags,
TEikConsWinUnits aUnit = EEikConsWinInChars
)

ConstructL() Constructs a console and sets title and position and size

Parameters

const TDesC & aTitle Title of the console
TPoint aTopLeft TopLeft corner of the console window
const TSize & aSize Size of the console in pixels
TInt aFlags Flags, for example EUseBackedUpWindow or ENoInitialCursor
TEikConsWinUnits aUnit = EEikConsWinInChars Unit of the console

Cr()

IMPORT_C void Cr ( )

Insert a CR

Create(const TDesC &, TSize)

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

Create() Creates a console and sets title and size

returns error code

Parameters

const TDesC & aTitle Title of the console
TSize aSize Size of the console in pixels

CursorPos()

IMPORT_C TPoint CursorPos ( ) const [virtual]

CursorPos() Cursor position getter returns cursor position

Down(TUint)

IMPORT_C void Down ( TUint aCount = 1 )

Move cursor down

Parameters

TUint aCount = 1 Number of steps to move

DrawCursor()

IMPORT_C void DrawCursor ( )

DrawCursor() Draws cursor

DrawCursorInSight()

IMPORT_C void DrawCursorInSight ( )

DrawCursorInSight() Draws cursor and insight

DrawCursorWhereNeeded()

void DrawCursorWhereNeeded ( ) [private]

DrawInSight(TPoint)

IMPORT_C void DrawInSight ( TPoint aPosition )

DrawInSight Moves topleft corner

Parameters

TPoint aPosition New position for insight

FlushChars()

IMPORT_C void FlushChars ( )

FlushChars() Updates the character buffers

Font()

IMPORT_C const TFontSpec & Font ( ) const

Font() Gets the used font

GetAnInSightPosition(TPoint)

TPoint GetAnInSightPosition ( TPoint aPosition ) const [private]

Parameters

TPoint aPosition

HideCursor()

IMPORT_C TInt HideCursor ( )

HideCursor() Hides cursor

HistorySize()

TUint HistorySize ( ) const [inline]

Size of the history

InvertOverlap(TPoint, TPoint, TPoint, TPoint)

void InvertOverlap ( TPoint aStart,
TPoint aEnd,
TPoint bStart,
TPoint bEnd
) [private]

Parameters

TPoint aStart
TPoint aEnd
TPoint bStart
TPoint bEnd

InvertRange(const TRect &)

void InvertRange ( const TRect & aRect ) [private]

Parameters

const TRect & aRect

KeyCode()

IMPORT_C TKeyCode KeyCode ( ) const [virtual]

KeyCode() Not implemented

KeyModifiers()

IMPORT_C TUint KeyModifiers ( ) const [virtual]

KeyModifiers() Not implemented

Left(TUint)

IMPORT_C void Left ( TUint aCount = 1 )

Move cursor left

Parameters

TUint aCount = 1 Number of steps to move

Lf()

IMPORT_C void Lf ( )

Insert a linefeed

MemAttPtr(TPoint, TUint)

TPtr8 MemAttPtr ( TPoint aPos,
TUint aLen
) [private]

Parameters

TPoint aPos
TUint aLen

MemChrPtr(TPoint, TUint)

TPtr MemChrPtr ( TPoint aPos,
TUint aLen
) [private]

Parameters

TPoint aPos
TUint aLen

MemScrClr(const TRect &, TUint8)

void MemScrClr ( const TRect & aRect,
TUint8 aCharacterAttributes
) [private]

Parameters

const TRect & aRect
TUint8 aCharacterAttributes

MemScrMove(TPoint, TPoint, TUint)

void MemScrMove ( TPoint anOldPt,
TPoint aNewPt,
TUint aLen
) [private]

Parameters

TPoint anOldPt
TPoint aNewPt
TUint aLen

MemScrPut(const TDesC &, TPoint, TUint8)

void MemScrPut ( const TDesC & aString,
TPoint aPos,
TUint8 aCharacterAttributes
) [private]

Parameters

const TDesC & aString
TPoint aPos
TUint8 aCharacterAttributes

MemScrScroll(const TRect &, TPoint)

void MemScrScroll ( const TRect & aRect,
TPoint aVector
) [private]

Parameters

const TRect & aRect
TPoint aVector

MemScrScrollUp(TUint)

void MemScrScrollUp ( TUint aLines = 1 ) [private]

Parameters

TUint aLines = 1

MoveTopLeft(TPoint)

IMPORT_C void MoveTopLeft ( TPoint aVector )

Moves topleft

Parameters

TPoint aVector new position of topleft

Read(TRequestStatus &)

IMPORT_C void Read ( TRequestStatus & aStatus ) [virtual]

Read() Not implemented

Parameters

TRequestStatus & aStatus

ReadCancel()

IMPORT_C void ReadCancel ( ) [virtual]

ReadCancel() Not implemented

RecalculateSize()

TBool RecalculateSize ( ) [private]

Redraw(const TRect &)

IMPORT_C void Redraw ( const TRect & aRect )

Redraw a rectangle

Parameters

const TRect & aRect Rectangle to redraw

RedrawChars(TInt, TInt, TInt, TUint)

void RedrawChars ( TInt anX,
TInt anY,
TInt aLength,
TUint aCharacterAttributes
) [private]

Parameters

TInt anX
TInt anY
TInt aLength
TUint aCharacterAttributes

RetrieveL(const TRect &)

IMPORT_C HBufC * RetrieveL ( const TRect & aRange )

RetrieveL() returns selected text

Parameters

const TRect & aRange selection

Right(TUint)

IMPORT_C void Right ( TUint aCount = 1 )

Move cursor right

Parameters

TUint aCount = 1 Number of steps to move

ScrToVis(TPoint)

TPoint ScrToVis ( TPoint aPoint ) [private]

Parameters

TPoint aPoint

ScrToVis(const TRect &)

TRect ScrToVis ( const TRect & aRect ) [private]

Parameters

const TRect & aRect

ScreenSize()

IMPORT_C TSize ScreenSize ( ) const [virtual]

ScreenSize() Gets size of the screen

returns Size of the screen in pixels

ScrollChars(const TRect &, const TPoint &)

IMPORT_C void ScrollChars ( const TRect & anArea,
const TPoint & aVector
)

Scroll characters

Parameters

const TRect & anArea Area to scroll
const TPoint & aVector How much to scroll

SelectCursor()

IMPORT_C void SelectCursor ( )

SelectCursor() Sets empty selection starting and ending at cursor position

Selection()

IMPORT_C TRect Selection ( )

Selection() Get selection position

SetAllPrintable(TUint)

IMPORT_C void SetAllPrintable ( TUint aFlag )

SetAllPrintable() sets all printable flag

Parameters

TUint aFlag flags

SetAtt(TUint)

IMPORT_C void SetAtt ( TUint aCharacterAttributes )

Set attributes

Parameters

TUint aCharacterAttributes Attributes for characters

SetAtt(TUint, TUint)

IMPORT_C void SetAtt ( TUint aForegroundGray16,
TUint aBackgroundGray16
)

Set attributes

Parameters

TUint aForegroundGray16 Grey16 attributes for foreground
TUint aBackgroundGray16 Grey16 attribuets for background

SetConsWin(CEikConsoleControl *)

IMPORT_C void SetConsWin ( CEikConsoleControl * aConsWin )

SetConsWin() Sets console window

Parameters

CEikConsoleControl * aConsWin Console control

SetCursorHeight(TInt)

IMPORT_C void SetCursorHeight ( TInt aPercentage ) [virtual]

SetCursorHeight changes cursor height

Parameters

TInt aPercentage Cursor height relative to character height

SetCursorPosAbs(const TPoint &)

IMPORT_C void SetCursorPosAbs ( const TPoint & aPoint ) [virtual]

SetCursorPosAbs Moving cursor to absolute position

Parameters

const TPoint & aPoint Position in absolute coordinates

SetCursorPosRel(const TPoint &)

IMPORT_C void SetCursorPosRel ( const TPoint & aPoint ) [virtual]

SetCursorPosRel Moving cursor to relative position

Parameters

const TPoint & aPoint Position in relative coordinates

SetFontL(const TFontSpec &)

IMPORT_C void SetFontL ( const TFontSpec & aFontDesc )

SetFontL() Sets the font for console

Parameters

const TFontSpec & aFontDesc font specification

SetHistorySizeL(TUint, TUint)

IMPORT_C void SetHistorySizeL ( TUint aMaxChrExtra,
TUint aMaxAttExtra
)

Set history buffer size

Parameters

TUint aMaxChrExtra lines allocated for history
TUint aMaxAttExtra attributed lines allocated for history

SetKeepCursorInSight(TUint)

IMPORT_C void SetKeepCursorInSight ( TUint aFlag )

SetKeepCursorInSight() sets cursor in sight flag

Parameters

TUint aFlag flags

SetPureCRLF(TUint)

IMPORT_C void SetPureCRLF ( TUint aFlag )

SetPureCRLF() sets pure flag

Parameters

TUint aFlag flags

SetScrollBarVisibilityL(CEikScrollBarFrame::TScrollBarVisibility, CEikScrollBarFrame::TScrollBarVisibility)

IMPORT_C void SetScrollBarVisibilityL ( CEikScrollBarFrame::TScrollBarVisibility aHBarVisibility,
CEikScrollBarFrame::TScrollBarVisibility aVBarVisibility
)

SetScrollBarVisibilityL() sets scrollbar visibility

Parameters

CEikScrollBarFrame::TScrollBarVisibility aHBarVisibility horizontal scrollbar visibility
CEikScrollBarFrame::TScrollBarVisibility aVBarVisibility vertical scrollbar visibility

SetScrollLock(TUint)

IMPORT_C void SetScrollLock ( TUint aFlag )

SetScrollLock() sets scroll lock flag

Parameters

TUint aFlag flags

SetSelection(const TRect &)

IMPORT_C void SetSelection ( const TRect & aRange )

SetSelection() Sets the selection position

Parameters

const TRect & aRange range of the selection

SetTitle(const TDesC &)

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

SetTitle() Set title of the console

Parameters

const TDesC & aTitle Title of the console

SetTitleL(const TDesC &)

IMPORT_C void SetTitleL ( const TDesC & aTitle )

SetTitle() Set title of the console

Parameters

const TDesC & aTitle Title of the console

Title()

HBufC * Title ( ) const [inline]

Title() Gets title of the console

returns Title of the console

Up(TUint)

IMPORT_C void Up ( TUint aCount = 1 )

Move cursor up

Parameters

TUint aCount = 1 Number of steps to move

UpdateScrollBars()

IMPORT_C TBool UpdateScrollBars ( )

UpdateScrollBars() updates scrollbars

Write(const TDesC &)

IMPORT_C void Write ( const TDesC & aDes ) [virtual]

Write() Writes text to the console

Parameters

const TDesC & aDes Text to be written to the console

Member Enumerations Documentation

Enum TEikConsoleFlags

Enumerators

EUseBackedUpWindow = 0x1
ENoInitialCursor = 0x2

Member Data Documentation

TUint iAllPrintable

TUint iAllPrintable [private]

TUint iAtt

TUint iAtt [private]

TUint8 * iAttBuf

TUint8 * iAttBuf [private]

TText * iChrBuf

TText * iChrBuf [private]

TInt iConsFlags

TInt iConsFlags [private]

CEikConsoleControl * iConsoleControl

CEikConsoleControl * iConsoleControl [private]

TSize iConsoleSize

TSize iConsoleSize [private]

HBufC * iConsoleTitle

HBufC * iConsoleTitle [private]

TPoint iCursor

TPoint iCursor [private]

TUint iCursorBlinking

TUint iCursorBlinking [private]

TUint iKeepCursorInSight

TUint iKeepCursorInSight [private]

TInt iMaxAttExtra

TInt iMaxAttExtra [private]

TInt iMaxChrExtra

TInt iMaxChrExtra [private]

TInt iNoChrExtra

TInt iNoChrExtra [private]

TUint iPureCRLF

TUint iPureCRLF [private]

TUint iScrollLock

TUint iScrollLock [private]

TRect iSelection

TRect iSelection [private]

TPoint iTopLeft

TPoint iTopLeft [private]

TSize iVisSize

TSize iVisSize [private]

TRect iVisWin

TRect iVisWin [private]

TBuf< 256 > iWriteBuffer

TBuf < 256 > iWriteBuffer [private]

TInt iWriteNow

TInt iWriteNow [private]

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.