CEikConsoleScreen Class Reference

class CEikConsoleScreen : public CConsoleBase

Inherits from

Public Member Functions
CEikConsoleScreen()
~CEikConsoleScreen()
TUint Att()
IMPORT_C voidClearChars(const TRect &, TUint)
IMPORT_C voidClearScreen()
IMPORT_C voidClearToEndOfLine()
CEikConsoleControl *ConsoleControl()
IMPORT_C voidConstructL(const TDesC &, TInt)
IMPORT_C voidConstructL(const TDesC &, const TSize &, TInt, TEikConsWinUnits)
IMPORT_C voidConstructL(const TDesC &, TPoint, const TSize &, TInt, TEikConsWinUnits)
IMPORT_C voidCr()
IMPORT_C TIntCreate(const TDesC &, TSize)
IMPORT_C TPointCursorPos()
IMPORT_C voidDown(TUint)
IMPORT_C voidDrawCursor()
IMPORT_C voidDrawCursorInSight()
IMPORT_C voidDrawInSight(TPoint)
IMPORT_C voidFlushChars()
IMPORT_C const TFontSpec &Font()
IMPORT_C TIntHideCursor()
TUint HistorySize()
IMPORT_C TKeyCodeKeyCode()
IMPORT_C TUintKeyModifiers()
IMPORT_C voidLeft(TUint)
IMPORT_C voidLf()
IMPORT_C voidMoveTopLeft(TPoint)
IMPORT_C voidRead(TRequestStatus &)
IMPORT_C voidReadCancel()
IMPORT_C voidRedraw(const TRect &)
IMPORT_C HBufC *RetrieveL(const TRect &)
IMPORT_C voidRight(TUint)
IMPORT_C TSizeScreenSize()
IMPORT_C voidScrollChars(const TRect &, const TPoint &)
IMPORT_C voidSelectCursor()
IMPORT_C TRectSelection()
IMPORT_C voidSetAllPrintable(TUint)
IMPORT_C voidSetAtt(TUint)
IMPORT_C voidSetAtt(TUint, TUint)
IMPORT_C voidSetConsWin(CEikConsoleControl *)
IMPORT_C voidSetCursorHeight(TInt)
IMPORT_C voidSetCursorPosAbs(const TPoint &)
IMPORT_C voidSetCursorPosRel(const TPoint &)
IMPORT_C voidSetFontL(const TFontSpec &)
IMPORT_C voidSetHistorySizeL(TUint, TUint)
IMPORT_C voidSetKeepCursorInSight(TUint)
IMPORT_C voidSetPureCRLF(TUint)
IMPORT_C voidSetScrollBarVisibilityL(CEikScrollBarFrame::TScrollBarVisibility, CEikScrollBarFrame::TScrollBarVisibility)
IMPORT_C voidSetScrollLock(TUint)
IMPORT_C voidSetSelection(const TRect &)
IMPORT_C voidSetTitle(const TDesC &)
IMPORT_C voidSetTitleL(const TDesC &)
HBufC *Title()
IMPORT_C voidUp(TUint)
IMPORT_C TBoolUpdateScrollBars()
IMPORT_C voidWrite(const TDesC &)
Private Member Functions
voidClipCursor()
voidDrawCursorWhereNeeded()
TPoint GetAnInSightPosition(TPoint)
voidInvertOverlap(TPoint, TPoint, TPoint, TPoint)
voidInvertRange(const TRect &)
TPtr8 MemAttPtr(TPoint, TUint)
TPtr MemChrPtr(TPoint, TUint)
voidMemScrClr(const TRect &, TUint8)
voidMemScrMove(TPoint, TPoint, TUint)
voidMemScrPut(const TDesC &, TPoint, TUint8)
voidMemScrScroll(const TRect &, TPoint)
voidMemScrScrollUp(TUint)
TBool RecalculateSize()
voidRedrawChars(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
enumTEikConsoleFlags { 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_CCEikConsoleScreen()

CEikConsoleScreen() constructor

~CEikConsoleScreen()

IMPORT_C~CEikConsoleScreen()

CEikConsoleScreen() destructor

Member Functions Documentation

Att()

TUint Att()const [inline]

Att() Attributes attributes

ClearChars(const TRect &, TUint)

IMPORT_C voidClearChars(const TRect &aRect,
TUintaCharacterAttributes
)

ClearChars() Clears characters within rectangle matching attributes

Parameters

const TRect & aRectRectangle in pixels
TUint aCharacterAttributesMatching character attributes

ClearScreen()

IMPORT_C voidClearScreen()[virtual]

ClearScreen() Clears the console screen

ClearToEndOfLine()

IMPORT_C voidClearToEndOfLine()[virtual]

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

ClipCursor()

voidClipCursor()[private]

ConsoleControl()

CEikConsoleControl *ConsoleControl()const [inline]

ConsoleControl() fetching console control

Returns console control

ConstructL(const TDesC &, TInt)

IMPORT_C voidConstructL(const TDesC &aTitle,
TIntaFlags
)

ConstructL() Constructs a console and sets title

Parameters

const TDesC & aTitleTitle of the console
TInt aFlagsFlags, for example EUseBackedUpWindow or ENoInitialCursor

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

IMPORT_C voidConstructL(const TDesC &aTitle,
const TSize &aSize,
TIntaFlags,
TEikConsWinUnitsaUnit = EEikConsWinInChars
)

ConstructL() Constructs a console and sets title and size

Parameters

const TDesC & aTitleTitle of the console
const TSize & aSizeSize of the console in pixels
TInt aFlagsFlags, for example EUseBackedUpWindow or ENoInitialCursor
TEikConsWinUnits aUnit = EEikConsWinInCharsUnit of the console

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

IMPORT_C voidConstructL(const TDesC &aTitle,
TPointaTopLeft,
const TSize &aSize,
TIntaFlags,
TEikConsWinUnitsaUnit = EEikConsWinInChars
)

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

Parameters

const TDesC & aTitleTitle of the console
TPoint aTopLeftTopLeft corner of the console window
const TSize & aSizeSize of the console in pixels
TInt aFlagsFlags, for example EUseBackedUpWindow or ENoInitialCursor
TEikConsWinUnits aUnit = EEikConsWinInCharsUnit of the console

Cr()

IMPORT_C voidCr()

Insert a CR

Create(const TDesC &, TSize)

IMPORT_C TIntCreate(const TDesC &aTitle,
TSizeaSize
)[virtual]

Create() Creates a console and sets title and size

returns error code

Parameters

const TDesC & aTitleTitle of the console
TSize aSizeSize of the console in pixels

CursorPos()

IMPORT_C TPointCursorPos()const [virtual]

CursorPos() Cursor position getter returns cursor position

Down(TUint)

IMPORT_C voidDown(TUintaCount = 1)

Move cursor down

Parameters

TUint aCount = 1Number of steps to move

DrawCursor()

IMPORT_C voidDrawCursor()

DrawCursor() Draws cursor

DrawCursorInSight()

IMPORT_C voidDrawCursorInSight()

DrawCursorInSight() Draws cursor and insight

DrawCursorWhereNeeded()

voidDrawCursorWhereNeeded()[private]

DrawInSight(TPoint)

IMPORT_C voidDrawInSight(TPointaPosition)

DrawInSight Moves topleft corner

Parameters

TPoint aPositionNew position for insight

FlushChars()

IMPORT_C voidFlushChars()

FlushChars() Updates the character buffers

Font()

IMPORT_C const TFontSpec &Font()const

Font() Gets the used font font specification

GetAnInSightPosition(TPoint)

TPoint GetAnInSightPosition(TPointaPosition)const [private]

Parameters

TPoint aPosition

HideCursor()

IMPORT_C TIntHideCursor()

HideCursor() Hides cursor

nonzero if cursor was not visible

HistorySize()

TUint HistorySize()const [inline]

Size of the history lines stored for history buffer

InvertOverlap(TPoint, TPoint, TPoint, TPoint)

voidInvertOverlap(TPointaStart,
TPointaEnd,
TPointbStart,
TPointbEnd
)[private]

Parameters

TPoint aStart
TPoint aEnd
TPoint bStart
TPoint bEnd

InvertRange(const TRect &)

voidInvertRange(const TRect &aRect)[private]

Parameters

const TRect & aRect

KeyCode()

IMPORT_C TKeyCodeKeyCode()const [virtual]

KeyCode() Not implemented

KeyModifiers()

IMPORT_C TUintKeyModifiers()const [virtual]

KeyModifiers() Not implemented

Left(TUint)

IMPORT_C voidLeft(TUintaCount = 1)

Move cursor left

Parameters

TUint aCount = 1Number of steps to move

Lf()

IMPORT_C voidLf()

Insert a linefeed

MemAttPtr(TPoint, TUint)

TPtr8 MemAttPtr(TPointaPos,
TUintaLen
)[private]

Parameters

TPoint aPos
TUint aLen

MemChrPtr(TPoint, TUint)

TPtr MemChrPtr(TPointaPos,
TUintaLen
)[private]

Parameters

TPoint aPos
TUint aLen

MemScrClr(const TRect &, TUint8)

voidMemScrClr(const TRect &aRect,
TUint8aCharacterAttributes
)[private]

Parameters

const TRect & aRect
TUint8 aCharacterAttributes

MemScrMove(TPoint, TPoint, TUint)

voidMemScrMove(TPointanOldPt,
TPointaNewPt,
TUintaLen
)[private]

Parameters

TPoint anOldPt
TPoint aNewPt
TUint aLen

MemScrPut(const TDesC &, TPoint, TUint8)

voidMemScrPut(const TDesC &aString,
TPointaPos,
TUint8aCharacterAttributes
)[private]

Parameters

const TDesC & aString
TPoint aPos
TUint8 aCharacterAttributes

MemScrScroll(const TRect &, TPoint)

voidMemScrScroll(const TRect &aRect,
TPointaVector
)[private]

Parameters

const TRect & aRect
TPoint aVector

MemScrScrollUp(TUint)

voidMemScrScrollUp(TUintaLines = 1)[private]

Parameters

TUint aLines = 1

MoveTopLeft(TPoint)

IMPORT_C voidMoveTopLeft(TPointaVector)

Moves topleft

Parameters

TPoint aVectornew position of topleft

Read(TRequestStatus &)

IMPORT_C voidRead(TRequestStatus &aStatus)[virtual]

Read() Not implemented

Parameters

TRequestStatus & aStatus

ReadCancel()

IMPORT_C voidReadCancel()[virtual]

ReadCancel() Not implemented

RecalculateSize()

TBool RecalculateSize()[private]

Redraw(const TRect &)

IMPORT_C voidRedraw(const TRect &aRect)

Redraw a rectangle

Parameters

const TRect & aRectRectangle to redraw

RedrawChars(TInt, TInt, TInt, TUint)

voidRedrawChars(TIntanX,
TIntanY,
TIntaLength,
TUintaCharacterAttributes
)[private]

Parameters

TInt anX
TInt anY
TInt aLength
TUint aCharacterAttributes

RetrieveL(const TRect &)

IMPORT_C HBufC *RetrieveL(const TRect &aRange)

RetrieveL() returns selected text text in descriptor

Parameters

const TRect & aRangeselection

Right(TUint)

IMPORT_C voidRight(TUintaCount = 1)

Move cursor right

Parameters

TUint aCount = 1Number of steps to move

ScrToVis(TPoint)

TPoint ScrToVis(TPointaPoint)[private]

Parameters

TPoint aPoint

ScrToVis(const TRect &)

TRect ScrToVis(const TRect &aRect)[private]

Parameters

const TRect & aRect

ScreenSize()

IMPORT_C TSizeScreenSize()const [virtual]

ScreenSize() Gets size of the screen

returns Size of the screen in pixels

ScrollChars(const TRect &, const TPoint &)

IMPORT_C voidScrollChars(const TRect &anArea,
const TPoint &aVector
)

Scroll characters

Parameters

const TRect & anAreaArea to scroll
const TPoint & aVectorHow much to scroll

SelectCursor()

IMPORT_C voidSelectCursor()

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

Selection()

IMPORT_C TRectSelection()

Selection() Get selection position selection position

SetAllPrintable(TUint)

IMPORT_C voidSetAllPrintable(TUintaFlag)

SetAllPrintable() sets all printable flag

Parameters

TUint aFlagflags

SetAtt(TUint)

IMPORT_C voidSetAtt(TUintaCharacterAttributes)

Set attributes

Parameters

TUint aCharacterAttributesAttributes for characters

SetAtt(TUint, TUint)

IMPORT_C voidSetAtt(TUintaForegroundGray16,
TUintaBackgroundGray16
)

Set attributes

Parameters

TUint aForegroundGray16Grey16 attributes for foreground
TUint aBackgroundGray16Grey16 attribuets for background

SetConsWin(CEikConsoleControl *)

IMPORT_C voidSetConsWin(CEikConsoleControl *aConsWin)

SetConsWin() Sets console window

Parameters

CEikConsoleControl * aConsWinConsole control

SetCursorHeight(TInt)

IMPORT_C voidSetCursorHeight(TIntaPercentage)[virtual]

SetCursorHeight changes cursor height

Parameters

TInt aPercentageCursor height relative to character height

SetCursorPosAbs(const TPoint &)

IMPORT_C voidSetCursorPosAbs(const TPoint &aPoint)[virtual]

SetCursorPosAbs Moving cursor to absolute position

Parameters

const TPoint & aPointPosition in absolute coordinates

SetCursorPosRel(const TPoint &)

IMPORT_C voidSetCursorPosRel(const TPoint &aPoint)[virtual]

SetCursorPosRel Moving cursor to relative position

Parameters

const TPoint & aPointPosition in relative coordinates

SetFontL(const TFontSpec &)

IMPORT_C voidSetFontL(const TFontSpec &aFontDesc)

SetFontL() Sets the font for console

Parameters

const TFontSpec & aFontDescfont specification

SetHistorySizeL(TUint, TUint)

IMPORT_C voidSetHistorySizeL(TUintaMaxChrExtra,
TUintaMaxAttExtra
)

Set history buffer size

Parameters

TUint aMaxChrExtralines allocated for history
TUint aMaxAttExtraattributed lines allocated for history

SetKeepCursorInSight(TUint)

IMPORT_C voidSetKeepCursorInSight(TUintaFlag)

SetKeepCursorInSight() sets cursor in sight flag

Parameters

TUint aFlagflags

SetPureCRLF(TUint)

IMPORT_C voidSetPureCRLF(TUintaFlag)

SetPureCRLF() sets pure flag

Parameters

TUint aFlagflags

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

IMPORT_C voidSetScrollBarVisibilityL(CEikScrollBarFrame::TScrollBarVisibilityaHBarVisibility,
CEikScrollBarFrame::TScrollBarVisibilityaVBarVisibility
)

SetScrollBarVisibilityL() sets scrollbar visibility

Parameters

CEikScrollBarFrame::TScrollBarVisibility aHBarVisibilityhorizontal scrollbar visibility
CEikScrollBarFrame::TScrollBarVisibility aVBarVisibilityvertical scrollbar visibility

SetScrollLock(TUint)

IMPORT_C voidSetScrollLock(TUintaFlag)

SetScrollLock() sets scroll lock flag

Parameters

TUint aFlagflags

SetSelection(const TRect &)

IMPORT_C voidSetSelection(const TRect &aRange)

SetSelection() Sets the selection position

Parameters

const TRect & aRangerange of the selection

SetTitle(const TDesC &)

IMPORT_C voidSetTitle(const TDesC &aTitle)[virtual]

SetTitle() Set title of the console

Parameters

const TDesC & aTitleTitle of the console

SetTitleL(const TDesC &)

IMPORT_C voidSetTitleL(const TDesC &aTitle)

SetTitle() Set title of the console

Parameters

const TDesC & aTitleTitle of the console

Title()

HBufC *Title()const [inline]

Title() Gets title of the console

returns Title of the console

Up(TUint)

IMPORT_C voidUp(TUintaCount = 1)

Move cursor up

Parameters

TUint aCount = 1Number of steps to move

UpdateScrollBars()

IMPORT_C TBoolUpdateScrollBars()

UpdateScrollBars() updates scrollbars

Write(const TDesC &)

IMPORT_C voidWrite(const TDesC &aDes)[virtual]

Write() Writes text to the console

Parameters

const TDesC & aDesText 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]