Collapse all Symbian^3 Product Developer Library

MAknListBoxTfxInternal Class Reference

class MAknListBoxTfxInternal

API used by the classes that implements the different types of listboxes. The API can be used to enable listbox effects.

Public Member Functions
void	AddNonDrawingRect(const TRect &)
TBool	BeginRedraw(TParticipantType, const TRect &, TInt)
void	Draw(const TRect &)
TBool	EffectsDisabled()
void	EndRedraw(TParticipantType, TInt)
void	EndViewRedraw(const TRect &)
TBool	Exist(TParticipantType, TInt)
void	HandleFocusChange(TBool)
void	Invalidate(TParticipantType, TInt)
void	JumpToStateAfter(TParticipantType)
TBool	NeedsUpdate(TParticipantType, TUint32, const TRect &)
void	Remove(TParticipantType, TInt)
void	ResetNonDrawingRects()
void	SetGc(CWindowGc &)
void	SetListType(TListBoxType)
void	SetMoveType(MAknListBoxTfxInternal::TMovementType)
TInt	SetPosition(TParticipantType, const TPoint &, TInt)
TBool	StartDrawing(TParticipantType)
void	StopDrawing()
TInt	VerifyKml()

Public Member Enumerations
enum	TListBoxType { EListBoxTypeMainPane = 0, EListBoxTypeGrid, EListBoxTypeSettingPage, EListBoxTypePopup, EListBoxTypeMenuPane, EListBoxTypeTreeList, EListBoxTypeIdle }
enum	TLongTapEvent { ELongTapStart, ELongTapFinish, ELongTapAbort }
enum	TMovementType { EListNoMovement = 0, EListScrollDown, EListScrollUp, EListWrapDown, EListWrapUp, EListMoveDown, EListMoveUp, EListWrapLeft, EListWrapRight, EListMoveLeft, EListMoveRight, EListStartUnknownMove, EListStopUnknownMove, EListContinueMove, EListTap, EListFastScroll, EListHitBorder, EListDrag }
enum	TParticipantType { EListView, EListItem, EListHighlight, EListZoomText, EListEverything = 100, EListNotSpecified, EListUpdateRect, EListTLMargin, EListBRMargin, EHighlightParticipant }

Member Functions Documentation

AddNonDrawingRect(const TRect &)

void

AddNonDrawingRect

(

const TRect &

aRect

)

[pure virtual]

Add an area that won't be drawn to.

Parameters

const TRect & aRect

BeginRedraw(TParticipantType, const TRect &, TInt)

TBool	BeginRedraw	(	TParticipantType	aType,
			const TRect &	aRect,
			TInt	aId = 0
		)	[pure virtual]

Begin redrawing a listbox participant bitmap. It's important that EndRedraw is called when the redraw is finished. If more than one BeginRedraw is called, it is only the first that has any effect, but EndRedraw must be called as many times as EndRedraw.

Parameters

TParticipantType aType	The type of the list participant to be drawn.
const TRect & aRect	The participant's rect.
TInt aId = 0	The index of the item.

Draw(const TRect &)

void

Draw

(

const TRect &

aRect

)

[pure virtual]

Draw the listbox.

Parameters

const TRect & aRect

The rect to draw.

EffectsDisabled()

TBool

EffectsDisabled

(

)

const [pure virtual]

Is effects disabled.

EndRedraw(TParticipantType, TInt)

void	EndRedraw	(	TParticipantType	aType,
			TInt	aId = 0
		)	[pure virtual]

End redrawing a listbox participant bitmap.

Parameters

TParticipantType aType	The type of the list participant that was drawn.
TInt aId = 0	The index of the item.

EndViewRedraw(const TRect &)

void

EndViewRedraw

(

const TRect &

aRect

)

[pure virtual]

End redrawing a listbox view participant bitmap.

Parameters

const TRect & aRect

Clipping rectangle (The area that can be drawn).

Exist(TParticipantType, TInt)

TBool	Exist	(	TParticipantType	aType,
			TInt	aId = 0
		)	const [pure virtual]

Checks if a participant exists.

Parameters

TParticipantType aType	The type of the participant (highlight, background or item).
TInt aId = 0

HandleFocusChange(TBool)

void

HandleFocusChange

(

TBool

aInFocus

)

[pure virtual]

Sets the focus of the listbox. Should be called when it gains or loses focus.

Parameters

TBool aInFocus

ETrue if the listbox has focus, EFalse if not.

Invalidate(TParticipantType, TInt)

void	Invalidate	(	TParticipantType	aType,
			TInt	aId = 0
		)	[pure virtual]

Invalidate a participant, forces the image to be updated next time it is drawn.

Parameters

TParticipantType aType	The type of the participant (highlight, background or item).
TInt aId = 0

JumpToStateAfter(TParticipantType)

void

JumpToStateAfter

(

TParticipantType

aType

)

[pure virtual]

Tell the listbox to jump to state after a special participant has been drawn.

Parameters

TParticipantType aType

The type of the list participant that triggers the jump.

NeedsUpdate(TParticipantType, TUint32, const TRect &)

TBool	NeedsUpdate	(	TParticipantType	aType,
			TUint32	aIndex,
			const TRect &	aRect
		)	[pure virtual]

Check if a certain listbox participant needs to be redrawn.

Parameters

TParticipantType aType	The type of the participant (highlight, background or item).
TUint32 aIndex
const TRect & aRect

Remove(TParticipantType, TInt)

void	Remove	(	TParticipantType	aType,
			TInt	aId = 0
		)	[pure virtual]

Remove the following participant bitmap.

Parameters

TParticipantType aType	The type of the list participant to remove, ie. item, highlight, background, or zoomtext.
TInt aId = 0	The index of the item, only used for list items.

ResetNonDrawingRects()

void

ResetNonDrawingRects

(

)

[pure virtual]

Reset areas that won't be drawn to.

SetGc(CWindowGc &)

void

SetGc

(

CWindowGc &

aGc

)

[pure virtual]

Set window gc.

Parameters

CWindowGc & aGc

The new gc that shall be used.

SetListType(TListBoxType)

void

SetListType

(

TListBoxType

aListBoxType

)

[pure virtual]

Set the type of listbox.

Parameters

TListBoxType aListBoxType

The type of the listbox.

SetMoveType(MAknListBoxTfxInternal::TMovementType)

void

SetMoveType

(

MAknListBoxTfxInternal::TMovementType

aMoveType

)

[pure virtual]

Set the type of the current movement.

Parameters

MAknListBoxTfxInternal::TMovementType aMoveType

The type of the current movement.

SetPosition(TParticipantType, const TPoint &, TInt)

TInt	SetPosition	(	TParticipantType	aType,
			const TPoint &	aPoint,
			TInt	aId = 0
		)	[pure virtual]

Change position of a participant without redrawing it.

Parameters

TParticipantType aType
const TPoint & aPoint
TInt aId = 0

StartDrawing(TParticipantType)

TBool

StartDrawing

(

TParticipantType

aType

)

[pure virtual]

Start actual drawing to the listbox participant. This should be called between BeginRedraw and EndRedraw. Everything that is drawn to the listbox gc must be drawn between StartDrawing and StopDrawing, otherwise effects are disabled.

Parameters

TParticipantType aType

The type of the list participant to be drawn.

StopDrawing()

void

StopDrawing

(

)

[pure virtual]

Stop actual drawing to the listbox participant. This should be called between BeginRedraw and EndRedraw. Everything that is drawn to the listbox gc must be drawn between StartDrawing and StopDrawing, otherwise effects are disabled.

VerifyKml()

TInt

VerifyKml

(

)

const [pure virtual]

Verify that the server is running and KML is available.

Member Enumerations Documentation

Enum TListBoxType

Types of lists.

Enumerators

EListBoxTypeMainPane = 0	All regular main pane lists, as well as settings lists.
EListBoxTypeGrid	Grids.
EListBoxTypeSettingPage	Lists in setting pages.
EListBoxTypePopup	Lists in popups.
EListBoxTypeMenuPane	Options menu.
EListBoxTypeTreeList	Tree List
EListBoxTypeIdle

Enum TLongTapEvent

Enumerators

ELongTapStart
ELongTapFinish
ELongTapAbort

Enum TMovementType

The type of movement in a listbox.

Enumerators

EListNoMovement = 0
EListScrollDown
EListScrollUp
EListWrapDown
EListWrapUp
EListMoveDown
EListMoveUp
EListWrapLeft
EListWrapRight
EListMoveLeft
EListMoveRight
EListStartUnknownMove
EListStopUnknownMove
EListContinueMove
EListTap
EListFastScroll
EListHitBorder
EListDrag

Enum TParticipantType

The type of a listbox participant: view, highlight or list item.

Enumerators

EListView	View (background) of the list.
EListItem	List items, ie. the entries in the list.
EListHighlight	Highlight.
EListZoomText	Zoomed text box.
EListEverything = 100	Can be used in Remove to remove all participants.
EListNotSpecified
EListUpdateRect
EListTLMargin
EListBRMargin
EHighlightParticipant