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.

Member Functions Documentation

ActivePaletteUpdated(void)

voidActivePaletteUpdated(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)

voidNotifyItemComplete(const TActivePalette2EventData &aEvent,
const TDesC8 &aDataDes,
TIntaDataInt
)[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 & aEventThe event data
const TDesC8 & aDataDesData descriptor
TInt aDataIntData integer

NotifyItemFocused(TInt, TInt)

voidNotifyItemFocused(TIntaPrevItem,
TIntaFocusedItem
)[pure virtual]

Called when a new item is focused

Parameters

TInt aPrevItemItem ID of previously focused item
TInt aFocusedItemItem ID of newly focused item

NotifyItemSelected(const TActivePalette2EventData &)

voidNotifyItemSelected(const TActivePalette2EventData &aEvent)[pure virtual]

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

Parameters

const TActivePalette2EventData & aEventThe event data

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

voidNotifyMessage(const TActivePalette2EventData &aEvent,
TIntaMessageID,
const TDesC8 &aDataDes,
TIntaDataInt
)[pure virtual]

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

Parameters

const TActivePalette2EventData & aEventThe event data
TInt aMessageIDThe ID of the message
const TDesC8 & aDataDesData descriptor
TInt aDataIntData integer

Redraw(const TRect &)

voidRedraw(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 & aAreaThe area to redraw.