Collapse all Symbian^3 Application Developer Library

CEikConsoleControl Class Reference

class CEikConsoleControl : public CAknControl

Inherits from

CEikConsoleControl
- CAknControl
  - CCoeControl
    - CBase

Public Member Functions
	CEikConsoleControl ()
	~CEikConsoleControl ()
const TSize &	CharSize ()
IMPORT_C void	ClearChars (const TRect &, TUint )
IMPORT_C void	ConstructL ( TInt )
IMPORT_C void	ConstructL ( TPoint , const TSize &, TInt , TEikConsWinUnits )
IMPORT_C void	DrawChars (const TDesC &, const TPoint &, TUint )
IMPORT_C void	DrawCursor ( TPoint )
const TFontSpec &	Font ()
IMPORT_C void	GetColorUseListL ( CArrayFix < TCoeColorUse > &)
IMPORT_C void	HandlePointerEventL (const TPointerEvent &)
IMPORT_C void	HandleResourceChange ( TInt )
IMPORT_C void	HandleScrollEventL ( CEikScrollBar *, TEikScrollEvent )
IMPORT_C void	HideCursor ()
IMPORT_C void	InvertChars (const TRect &)
IMPORT_C void	ScrollChars (const TRect &, const TPoint &)
IMPORT_C void	SetCursorHeight ( TUint )
IMPORT_C void	SetFontL (const TFontSpec &, const CFbsFont *)
IMPORT_C void	SetRedrawer ( CEikConsoleScreen *)
IMPORT_C TInt	SetScrollBarVisibilityL ( CEikScrollBarFrame::TScrollBarVisibility , CEikScrollBarFrame::TScrollBarVisibility )
IMPORT_C void	UpdateArea ()
IMPORT_C TBool	UpdateScrollbarsL (const TSize &, const TSize &, TPoint )
IMPORT_C TSize	VisibleSize ()

Protected Member Functions
IMPORT_C CCoeControl *	ComponentControl ( TInt )
IMPORT_C TInt	CountComponentControls ()
IMPORT_C void	Draw (const TRect &)
IMPORT_C void	FocusChanged ( TDrawNow )
IMPORT_C void	SizeChanged ()
IMPORT_C void	WriteInternalStateL ( RWriteStream &)

Private Member Functions
TPoint	CharsToPixels ( TPoint )
TRect	CharsToPixels (const TRect &)
void	ClearPixels (const TRect &, TRgb )
void	CreateScrollBarFrameLayout ( TEikScrollBarFrameLayout &)
IMPORT_C void *	ExtensionInterface ( TUid )
void	InitFontSpecL ()
void	InterpretAttribute ( TUint )
void	InterpretColorBits ( TUint )
CEikConsoleControl &	M ()
void	NextFontL ()
TRect	PixelsToChars (const TRect &)
IMPORT_C void	Reserved_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_C

CEikConsoleControl

(

)

Constructor

~CEikConsoleControl()

IMPORT_C

~CEikConsoleControl

(

)

Destructor

Member Functions Documentation

CharSize()

const TSize &

CharSize

(

)

const [inline]

CharSize() gets character size

CharsToPixels(TPoint)

TPoint

CharsToPixels

(

TPoint

aPoint

)

[private]

Parameters

TPoint aPoint

CharsToPixels(const TRect &)

TRect

CharsToPixels

(

const TRect &

aRect

)

[private]

Parameters

const TRect & aRect

ClearChars(const TRect &, TUint)

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

ClearChars() clears characters

Parameters

const TRect & anArea	area to be cleared
TUint aCharacterAttributes	attributes of cleared characters

ClearPixels(const TRect &, TRgb)

void	ClearPixels	(	const TRect &	anArea,
			TRgb	aColor
		)	const [private]

Parameters

const TRect & anArea
TRgb aColor

ComponentControl(TInt)

IMPORT_C CCoeControl *

ComponentControl

(

TInt

aIndex

)

const [protected, virtual]

Component controls

Parameters

TInt aIndex

ConstructL(TInt)

IMPORT_C void

ConstructL

(

TInt

aFlags

)

Parameters

TInt aFlags

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

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

Parameters

TPoint aTopLeft
const TSize & aSize
TInt aFlags
TEikConsWinUnits aUnit

CountComponentControls()

IMPORT_C TInt

CountComponentControls

(

)

const [protected, virtual]

Component controls count

CreateScrollBarFrameLayout(TEikScrollBarFrameLayout &)

void

CreateScrollBarFrameLayout

(

TEikScrollBarFrameLayout &

aLayout

)

const [private]

Parameters

TEikScrollBarFrameLayout & aLayout

Draw(const TRect &)

IMPORT_C void

Draw

(

const TRect &

aRect

)

const [protected, virtual]

Draws the control

Parameters

const TRect & aRect

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

IMPORT_C void	DrawChars	(	const TDesC &	aString,
			const TPoint &	aPosition,
			TUint	aCharacterAttributes
		)

DrawChars() draws characters

Parameters

const TDesC & aString	string to be drawn
const TPoint & aPosition	position of the string
TUint aCharacterAttributes	attributes of the drawn string

DrawCursor(TPoint)

IMPORT_C void

DrawCursor

(

TPoint

aPosition

)

DrawCursor Draws cursor at position

Parameters

TPoint aPosition

position

ExtensionInterface(TUid)

IMPORT_C void *

ExtensionInterface

(

TUid

aInterface

)

[private, virtual]

From CAknControl

Parameters

TUid aInterface

FocusChanged(TDrawNow)

IMPORT_C void

FocusChanged

(

TDrawNow

aDrawNow

)

[protected, virtual]

Focus has changed

Parameters

TDrawNow aDrawNow

Font()

const TFontSpec &

Font

(

)

const [inline]

Font() gets font specification

GetColorUseListL(CArrayFix< TCoeColorUse > &)

IMPORT_C void

GetColorUseListL

(

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 void

HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

[virtual]

HandlePointerEventL handles touch pointer events

Parameters

const TPointerEvent & aPointerEvent

HandleResourceChange(TInt)

IMPORT_C void

HandleResourceChange

(

TInt

aType

)

[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 void	HandleScrollEventL	(	CEikScrollBar *	aScrollBar,
			TEikScrollEvent	aEventType
		)

Handles scroll event

Parameters

CEikScrollBar * aScrollBar	scrollbar to be used for the event
TEikScrollEvent aEventType	type of the event that happened

HideCursor()

IMPORT_C void

HideCursor

(

)

HideCursor hides cursor

InitFontSpecL()

void

InitFontSpecL

(

)

[private]

InterpretAttribute(TUint)

void

InterpretAttribute

(

TUint

AnAtt

)

[private]

Parameters

TUint AnAtt

InterpretColorBits(TUint)

void

InterpretColorBits

(

TUint

aCharacterAttributes

)

[private]

Parameters

TUint aCharacterAttributes

InvertChars(const TRect &)

IMPORT_C void

InvertChars

(

const TRect &

anArea

)

InsertChars() inserts character area

Parameters

const TRect & anArea

area to be inserted

M()

CEikConsoleControl &

(

)

const [private, inline]

NextFontL()

void

NextFontL

(

)

[private]

PixelsToChars(const TRect &)

TRect

PixelsToChars

(

const TRect &

aRect

)

[private]

Parameters

const TRect & aRect

Reserved_2()

IMPORT_C void

Reserved_2

(

)

[private, virtual]

ScrollChars(const TRect &, const TPoint &)

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

ScrollChars scrolls character area

Parameters

const TRect & anArea	area to be scrolled
const TPoint & aVector	direction to be scrolled

SetCursorHeight(TUint)

IMPORT_C void

SetCursorHeight

(

TUint

aPercentage

)

SetCursorHeight() Sets cursor height

Parameters

TUint aPercentage

value 0..100%

SetFontL(const TFontSpec &, const CFbsFont *)

IMPORT_C void	SetFontL	(	const TFontSpec &	aFontSpec,
			const CFbsFont *	aFont
		)

SetFontL() sets the console font

Parameters

const TFontSpec & aFontSpec	font specification
const CFbsFont * aFont	font instance

SetRedrawer(CEikConsoleScreen *)

IMPORT_C void

SetRedrawer

(

CEikConsoleScreen *

aConsole

)

SetRedrawer

Parameters

CEikConsoleScreen * aConsole

console screen

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

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

sets scrollbar visibility

Parameters

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

SizeChanged()

IMPORT_C void

SizeChanged

(

)

[protected, virtual]

Size has changed

UpdateArea()

IMPORT_C void

UpdateArea

(

)

Updates an area

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

IMPORT_C TBool	UpdateScrollbarsL	(	const TSize &	aDataSize,
			const TSize &	aVisibleSize,
			TPoint	aPos
		)

Updates scrollbar

Parameters

const TSize & aDataSize	size of the data
const TSize & aVisibleSize	how much of the data is visible on the console
TPoint aPos	position of the visible area relative to whole data