Collapse all Symbian^3 Application Developer Library

MAiFwEventHandler Class Reference

class MAiFwEventHandler

Active Idle Framework internal event handling interface. Events from UI controllers are forwarded to this interface for processing on the Active Idle Framework side.

Since: S60 3.2

Public Member Functions
void	AppEnvReadyL ()
void	HandleActivateUI ()
void	HandlePluginEvent (const TDesC &)
void	HandlePluginEventL (const THsPublisherInfo &, const TDesC &)
void	HandleUiReadyEventL ( CAiUiController &)
void	HandleUiShutdown ( CAiUiController &)
TBool	HasMenuItemL (const THsPublisherInfo &, const TDesC &)
TBool	QueryIsMenuOpen ()
TBool	RefreshContent (const TDesC &)
TBool	RefreshContent (const THsPublisherInfo &, const TDesC &)
TBool	SuspendContent (const THsPublisherInfo &, const TDesC &)

Member Functions Documentation

AppEnvReadyL()

void

AppEnvReadyL

(

)

[pure virtual]

Application environment ready callback. Main UI controller calls this method when application framework is initialized.

Since: S60 3.2

HandleActivateUI()

void

HandleActivateUI

(

)

[pure virtual]

UI activation event handler.

Since: S60 3.2

HandlePluginEvent(const TDesC &)

void

HandlePluginEvent

(

const TDesC &

aParam

)

[pure virtual]

Active Idle Framework Plug-in event handler. UI controllers forward events that are targeted to Active Idle Content Publisher Plug-ins to this method.

Since: S60 3.2

Parameters

const TDesC & aParam

event parameters from the UI model.

HandlePluginEventL(const THsPublisherInfo &, const TDesC &)

void	HandlePluginEventL	(	const THsPublisherInfo &	aPublisherInfo,
			const TDesC &	aParam
		)	[pure virtual]

Active Idle Framework Plug-in event handler. UI controllers forward events that are targeted to Active Idle Content Publisher Plug-ins to this method.

Since: S60 5.2

Parameters

const THsPublisherInfo & aPublisherInfo	publisher info.
const TDesC & aParam	event parameters from the UI model.

HandleUiReadyEventL(CAiUiController &)

void

HandleUiReadyEventL

(

CAiUiController &

aUiController

)

[pure virtual]

UI ready event handler.

Since: S60 3.2

Parameters

CAiUiController & aUiController

Active Idle UI Controller which manages the UI that is ready.

HandleUiShutdown(CAiUiController &)

void

HandleUiShutdown

(

CAiUiController &

aUiController

)

[pure virtual]

UI shutdown event handler.

Since: S60 3.2

Parameters

CAiUiController & aUiController

Active Idle UI Controller which manages the UI that was shut down.

HasMenuItemL(const THsPublisherInfo &, const TDesC &)

TBool	HasMenuItemL	(	const THsPublisherInfo &	aPublisherInfo,
			const TDesC &	aMenuItem
		)	[pure virtual]

Queries if a Content Publiseher Plug-in has settings

Since: S60 5.2

Parameters

const THsPublisherInfo & aPublisherInfo	publisher info.
const TDesC & aMenuItem	menuitem type.

QueryIsMenuOpen()

TBool

QueryIsMenuOpen

(

)

[pure virtual]

Service to check if menu is open.

Since: S60 3.2

RefreshContent(const TDesC &)

TBool

RefreshContent

(

const TDesC &

aContentCid

)

[pure virtual]

Refresh content request. UI controller can use this interface to request a content publisher plug-in to refresh (re-publish) a specific content item.

Since: S60 3.2

Parameters

const TDesC & aContentCid

Textual identifier of the content to refresh.

RefreshContent(const THsPublisherInfo &, const TDesC &)

TBool	RefreshContent	(	const THsPublisherInfo &	aPublisherInfo,
			const TDesC &	aContentCid
		)	[pure virtual]

Refresh content request. UI controller can use this interface to request a content publisher plug-in to refresh (re-publish) a specific content item.

Since: S60 5.2

Parameters

const THsPublisherInfo & aPublisherInfo	publisher info.
const TDesC & aContentCid	Textual identifier of the content to refresh.

SuspendContent(const THsPublisherInfo &, const TDesC &)

TBool	SuspendContent	(	const THsPublisherInfo &	aPublisherInfo,
			const TDesC &	aContentCid
		)	[pure virtual]

Suspend content request. UI controller can use this interface to request a content publisher plug-in to suspend a specific content item.

Since: S60 5.2

Parameters

const THsPublisherInfo & aPublisherInfo	publisher info.
const TDesC & aContentCid	Textual identifier of the content to refresh.