CEikConsoleControl Class Reference

class CEikConsoleControl : public CAknControl

Inherits from

Public Member Functions
CEikConsoleControl()
~CEikConsoleControl()
const TSize &CharSize()
IMPORT_C voidClearChars(const TRect &, TUint)
IMPORT_C voidConstructL(TInt)
IMPORT_C voidConstructL(TPoint, const TSize &, TInt, TEikConsWinUnits)
IMPORT_C voidDrawChars(const TDesC &, const TPoint &, TUint)
IMPORT_C voidDrawCursor(TPoint)
const TFontSpec &Font()
IMPORT_C voidGetColorUseListL(CArrayFix< TCoeColorUse > &)
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C voidHandleResourceChange(TInt)
IMPORT_C voidHandleScrollEventL(CEikScrollBar *, TEikScrollEvent)
IMPORT_C voidHideCursor()
IMPORT_C voidInvertChars(const TRect &)
IMPORT_C voidScrollChars(const TRect &, const TPoint &)
IMPORT_C voidSetCursorHeight(TUint)
IMPORT_C voidSetFontL(const TFontSpec &, const CFbsFont *)
IMPORT_C voidSetRedrawer(CEikConsoleScreen *)
IMPORT_C TIntSetScrollBarVisibilityL(CEikScrollBarFrame::TScrollBarVisibility, CEikScrollBarFrame::TScrollBarVisibility)
IMPORT_C voidUpdateArea()
IMPORT_C TBoolUpdateScrollbarsL(const TSize &, const TSize &, TPoint)
IMPORT_C TSizeVisibleSize()
Protected Member Functions
IMPORT_C CCoeControl *ComponentControl(TInt)
IMPORT_C TIntCountComponentControls()
IMPORT_C voidDraw(const TRect &)
IMPORT_C voidFocusChanged(TDrawNow)
IMPORT_C voidSizeChanged()
IMPORT_C voidWriteInternalStateL(RWriteStream &)
Private Member Functions
TPoint CharsToPixels(TPoint)
TRect CharsToPixels(const TRect &)
voidClearPixels(const TRect &, TRgb)
voidCreateScrollBarFrameLayout(TEikScrollBarFrameLayout &)
IMPORT_C void *ExtensionInterface(TUid)
voidInitFontSpecL()
voidInterpretAttribute(TUint)
voidInterpretColorBits(TUint)
CEikConsoleControl &M()
voidNextFontL()
TRect PixelsToChars(const TRect &)
IMPORT_C voidReserved_2()
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
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()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::ActivateL()
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ConstructFromResourceL(TResourceReader &)
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HasBorder()const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::InputCapabilities()const
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MakeVisible(TBool)
CCoeControl::MaximumWidth()const
CCoeControl::MinimumSize()
CCoeControl::MopSupplyObject(TTypeUid)
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAdjacent(TInt)
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
Inherited Enumerations
CCoeControl:TZoomType
Private Attributes
TRgb iBackGray16
TSize iCharSize
CEikConsoleScreen *iConsole
const CFont *iCurrentFont
TUint iCursorHeightPercentage
TUint iFontHeight
TUint iFontIsProportional
TFontSpec iFontSpec
TFontUnderline iFontUnderline
CEikScrollBarFrame::TScrollBarVisibility iHBarVisibility
TUint iLastAtt
TUint iLastFontFlags
TPoint iLastThumbPos
TRgb iPenGray16
TInt iRedrawing
CEikScrollBarFrame *iSBFrame
TTextCursor iTextCursor
CEikScrollBarFrame::TScrollBarVisibility iVBarVisibility
TSize iViewInChars
TSize iViewInPixels
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CEikConsoleControl()

IMPORT_CCEikConsoleControl()

Constructor

~CEikConsoleControl()

IMPORT_C~CEikConsoleControl()

Destructor

Member Functions Documentation

CharSize()

const TSize &CharSize()const [inline]

CharSize() gets character size

CharsToPixels(TPoint)

TPoint CharsToPixels(TPointaPoint)[private]

Parameters

TPoint aPoint

CharsToPixels(const TRect &)

TRect CharsToPixels(const TRect &aRect)[private]

Parameters

const TRect & aRect

ClearChars(const TRect &, TUint)

IMPORT_C voidClearChars(const TRect &anArea,
TUintaCharacterAttributes
)

ClearChars() clears characters

Parameters

const TRect & anAreaarea to be cleared
TUint aCharacterAttributesattributes of cleared characters

ClearPixels(const TRect &, TRgb)

voidClearPixels(const TRect &anArea,
TRgbaColor
)const [private]

Parameters

const TRect & anArea
TRgb aColor

ComponentControl(TInt)

IMPORT_C CCoeControl *ComponentControl(TIntaIndex)const [protected, virtual]

Component controls

Parameters

TInt aIndex

ConstructL(TInt)

IMPORT_C voidConstructL(TIntaFlags)

Parameters

TInt aFlags

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

IMPORT_C voidConstructL(TPointaTopLeft,
const TSize &aSize,
TIntaFlags,
TEikConsWinUnitsaUnit
)

Parameters

TPoint aTopLeft
const TSize & aSize
TInt aFlags
TEikConsWinUnits aUnit

CountComponentControls()

IMPORT_C TIntCountComponentControls()const [protected, virtual]

Component controls count

CreateScrollBarFrameLayout(TEikScrollBarFrameLayout &)

voidCreateScrollBarFrameLayout(TEikScrollBarFrameLayout &aLayout)const [private]

Parameters

TEikScrollBarFrameLayout & aLayout

Draw(const TRect &)

IMPORT_C voidDraw(const TRect &aRect)const [protected, virtual]

Draws the control

Parameters

const TRect & aRect

DrawChars(const TDesC &, const TPoint &, TUint)

IMPORT_C voidDrawChars(const TDesC &aString,
const TPoint &aPosition,
TUintaCharacterAttributes
)

DrawChars() draws characters

Parameters

const TDesC & aStringstring to be drawn
const TPoint & aPositionposition of the string
TUint aCharacterAttributesattributes of the drawn string

DrawCursor(TPoint)

IMPORT_C voidDrawCursor(TPointaPosition)

DrawCursor Draws cursor at position

Parameters

TPoint aPositionposition

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private, virtual]

Parameters

TUid aInterface

FocusChanged(TDrawNow)

IMPORT_C voidFocusChanged(TDrawNowaDrawNow)[protected, virtual]

Focus has changed

Parameters

TDrawNow aDrawNow

Font()

const TFontSpec &Font()const [inline]

Font() gets font specification

GetColorUseListL(CArrayFix< TCoeColorUse > &)

IMPORT_C voidGetColorUseListL(CArrayFix< TCoeColorUse > &aColorUseList)const [virtual]

GetColorUseListL provides color use list for the control

Gets the list of logical colors employed in the drawing of the control, paired with an explanation of how they are used. Appends the list to aColorUseList.

Since
ER5U

Parameters

CArrayFix< TCoeColorUse > & aColorUseList

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

HandlePointerEventL handles touch pointer events

Parameters

const TPointerEvent & aPointerEvent

HandleResourceChange(TInt)

IMPORT_C voidHandleResourceChange(TIntaType)[virtual]

HandleResourceChange handles several kinds of resource change events

Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.

Since
ER5U

Parameters

TInt aType

HandleScrollEventL(CEikScrollBar *, TEikScrollEvent)

IMPORT_C voidHandleScrollEventL(CEikScrollBar *aScrollBar,
TEikScrollEventaEventType
)

Handles scroll event

Parameters

CEikScrollBar * aScrollBarscrollbar to be used for the event
TEikScrollEvent aEventTypetype of the event that happened

HideCursor()

IMPORT_C voidHideCursor()

HideCursor hides cursor

InitFontSpecL()

voidInitFontSpecL()[private]

InterpretAttribute(TUint)

voidInterpretAttribute(TUintAnAtt)[private]

Parameters

TUint AnAtt

InterpretColorBits(TUint)

voidInterpretColorBits(TUintaCharacterAttributes)[private]

Parameters

TUint aCharacterAttributes

InvertChars(const TRect &)

IMPORT_C voidInvertChars(const TRect &anArea)

InsertChars() inserts character area

Parameters

const TRect & anAreaarea to be inserted

M()

CEikConsoleControl &M()const [private, inline]

NextFontL()

voidNextFontL()[private]

PixelsToChars(const TRect &)

TRect PixelsToChars(const TRect &aRect)[private]

Parameters

const TRect & aRect

Reserved_2()

IMPORT_C voidReserved_2()[private, virtual]

ScrollChars(const TRect &, const TPoint &)

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

ScrollChars scrolls character area

Parameters

const TRect & anAreaarea to be scrolled
const TPoint & aVectordirection to be scrolled

SetCursorHeight(TUint)

IMPORT_C voidSetCursorHeight(TUintaPercentage)

SetCursorHeight() Sets cursor height

Parameters

TUint aPercentagevalue 0..100%

SetFontL(const TFontSpec &, const CFbsFont *)

IMPORT_C voidSetFontL(const TFontSpec &aFontSpec,
const CFbsFont *aFont
)

SetFontL() sets the console font

Parameters

const TFontSpec & aFontSpecfont specification
const CFbsFont * aFontfont instance

SetRedrawer(CEikConsoleScreen *)

IMPORT_C voidSetRedrawer(CEikConsoleScreen *aConsole)

SetRedrawer

Parameters

CEikConsoleScreen * aConsoleconsole screen

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

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

sets scrollbar visibility

Parameters

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

SizeChanged()

IMPORT_C voidSizeChanged()[protected, virtual]

Size has changed

UpdateArea()

IMPORT_C voidUpdateArea()

Updates an area

UpdateScrollbarsL(const TSize &, const TSize &, TPoint)

IMPORT_C TBoolUpdateScrollbarsL(const TSize &aDataSize,
const TSize &aVisibleSize,
TPointaPos
)

Updates scrollbar

Parameters

const TSize & aDataSizesize of the data
const TSize & aVisibleSizehow much of the data is visible on the console
TPoint aPosposition of the visible area relative to whole data

VisibleSize()

IMPORT_C TSizeVisibleSize()const

VisibibleSize() gets visible size

WriteInternalStateL(RWriteStream &)

IMPORT_C voidWriteInternalStateL(RWriteStream &aWriteStream)const [protected, virtual]

Writes internal state

Parameters

RWriteStream & aWriteStream

Member Data Documentation

TRgb iBackGray16

TRgb iBackGray16[private]

TSize iCharSize

TSize iCharSize[private]

CEikConsoleScreen * iConsole

CEikConsoleScreen *iConsole[private]

const CFont * iCurrentFont

const CFont *iCurrentFont[private]

TUint iCursorHeightPercentage

TUint iCursorHeightPercentage[private]

TUint iFontHeight

TUint iFontHeight[private]

TUint iFontIsProportional

TUint iFontIsProportional[private]

TFontSpec iFontSpec

TFontSpec iFontSpec[private]

TFontUnderline iFontUnderline

TFontUnderline iFontUnderline[private]

CEikScrollBarFrame::TScrollBarVisibility iHBarVisibility

CEikScrollBarFrame::TScrollBarVisibility iHBarVisibility[private]

TUint iLastAtt

TUint iLastAtt[private]

TUint iLastFontFlags

TUint iLastFontFlags[private]

TPoint iLastThumbPos

TPoint iLastThumbPos[private]

TRgb iPenGray16

TRgb iPenGray16[private]

TInt iRedrawing

TInt iRedrawing[private]

CEikScrollBarFrame * iSBFrame

CEikScrollBarFrame *iSBFrame[private]

TTextCursor iTextCursor

TTextCursor iTextCursor[private]

CEikScrollBarFrame::TScrollBarVisibility iVBarVisibility

CEikScrollBarFrame::TScrollBarVisibility iVBarVisibility[private]

TSize iViewInChars

TSize iViewInChars[private]

TSize iViewInPixels

TSize iViewInPixels[private]