Collapse all Symbian^3 Application Developer Library

MActivePalette2Observer Class Reference

class MActivePalette2Observer

Interface for an Active Palette 2 observer. The AP will use this interface to inform the client app about certain events, and to request services.

Public Member Functions
void	ActivePaletteUpdated (void)
void	NotifyItemComplete (const TActivePalette2EventData &, const TDesC8 &, TInt )
void	NotifyItemFocused ( TInt , TInt )
void	NotifyItemSelected (const TActivePalette2EventData &)
void	NotifyMessage (const TActivePalette2EventData &, TInt , const TDesC8 &, TInt )
void	Redraw (const TRect &)

Member Functions Documentation

ActivePaletteUpdated(void)

void

ActivePaletteUpdated

(

void

)

[pure virtual]

Informs the observer that the AP has been updated in some way. Includes animations. Only called if SetGc() has previously been called on the AP with a non-NULL parameter, and if the AP in use is a CCoeControl .

Parameters

void

NotifyItemComplete(const TActivePalette2EventData &, const TDesC8 &, TInt)

void	NotifyItemComplete	(	const TActivePalette2EventData &	aEvent,
			const TDesC8 &	aDataDes,
			TInt	aDataInt
		)	[pure virtual]

Called when the user has selected an item from the AP, after the relevant plugin has completed processing the event

Parameters

const TActivePalette2EventData & aEvent	The event data
const TDesC8 & aDataDes	Data descriptor
TInt aDataInt	Data integer

NotifyItemFocused(TInt, TInt)

void	NotifyItemFocused	(	TInt	aPrevItem,
			TInt	aFocusedItem
		)	[pure virtual]

Called when a new item is focused

Parameters

TInt aPrevItem	Item ID of previously focused item
TInt aFocusedItem	Item ID of newly focused item

NotifyItemSelected(const TActivePalette2EventData &)

void

NotifyItemSelected

(

const TActivePalette2EventData &

aEvent

)

[pure virtual]

Called when the user has selected an item from the AP, before the plugin is informed

Parameters

const TActivePalette2EventData & aEvent

The event data

NotifyMessage(const TActivePalette2EventData &, TInt, const TDesC8 &, TInt)

void	NotifyMessage	(	const TActivePalette2EventData &	aEvent,
			TInt	aMessageID,
			const TDesC8 &	aDataDes,
			TInt	aDataInt
		)	[pure virtual]

Called when a plugin generates a message for the client app.

Parameters

const TActivePalette2EventData & aEvent	The event data
TInt aMessageID	The ID of the message
const TDesC8 & aDataDes	Data descriptor
TInt aDataInt	Data integer

Redraw(const TRect &)

void

Redraw

(

const TRect &

aArea

)

[pure virtual]

Request for the client app to redraw the given area underneath the AP. Used to support semi-transparency. It is important that this completes quickly. This will only be called if a CCoeControl-derived AP is in use.

Parameters

const TRect & aArea

The area to redraw.