Collapse all Symbian^3 Application Developer Library

CAiUiController Class Reference

class CAiUiController : public CBase

UI Controller ECom interface for Active Idle.

Since: Series 60 3.2

Inherits from

CAiUiController
- CBase

Public Member Functions
	~CAiUiController ()
void	ActivateUI ()
MAiContentObserver &	GetContentObserver ()
void	GetSettingsL (const THsPublisherInfo &, RAiSettingsItemArray &)
void	LoadUIDefinitionL ()
MAiMainUiController *	MainInterface ()
CAiUiController *	NewL ( TUid )
CAiUiController *	NewL (const TDesC8 &)
MAiSecondaryUiController *	SecondaryInterface ()
void	SetEventHandler ( MAiFwEventHandler &)
void	SetStateHandler (MAiFwStateHandler &)

Inherited Functions
	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()

Private Attributes
TUid	iDestructKey

Constructor & Destructor Documentation

~CAiUiController()

~CAiUiController

(

)

[inline]

Destructor.

Member Functions Documentation

ActivateUI()

void

ActivateUI

(

)

[pure virtual]

Activate UI managed by this UI controller.

Since: Series 60 3.2

GetContentObserver()

MAiContentObserver &

GetContentObserver

(

)

[pure virtual]

Returns content observer interface implemented by this UI controller.

Since: Series 60 3.2

GetSettingsL(const THsPublisherInfo &, RAiSettingsItemArray &)

void	GetSettingsL	(	const THsPublisherInfo &	aPublisherInfo,
			RAiSettingsItemArray &	aSettings
		)	[pure virtual]

Retrieves plug-in settings specified in this UI controller's UI definition.

Parameters

const THsPublisherInfo & aPublisherInfo	Publisher info of the plug-in for which to retrieve settings for.
RAiSettingsItemArray & aSettings	array to get settings items to.

LoadUIDefinitionL()

void

LoadUIDefinitionL

(

)

[pure virtual]

Instructs this UI controller to load its UI definition.

Since: Series 60 3.2

MainInterface()

MAiMainUiController *

MainInterface

(

)

[pure virtual]

Returns the main UI Controller interface, or NULL if this is not the main UI controller.

NewL(TUid)

CAiUiController *

NewL

(

TUid

aImpUid

)

[static, inline]

Static factory method.

Since: Series 60 3.2

Parameters

TUid aImpUid

NewL(const TDesC8 &)

CAiUiController *

NewL

(

const TDesC8 &

aMime

)

[static, inline]

Static factory method.

Since: Series 60 3.2

Parameters

const TDesC8 & aMime

SecondaryInterface()

MAiSecondaryUiController *

SecondaryInterface

(

)

[pure virtual]

Returns the secondary UI Controller interface, or NULL if this is not a secondary UI controller.

SetEventHandler(MAiFwEventHandler &)

void

SetEventHandler

(

MAiFwEventHandler &

aEventHandler

)

[pure virtual]

Sets the Active Idle Framework event handler for this UI Controller.

Since: Series 60 3.2

Parameters

MAiFwEventHandler & aEventHandler

Framework event handler for this UI controller. Set to NULL to disable event callbacks from this UI Controller.

SetStateHandler(MAiFwStateHandler &)

void

SetStateHandler

(

MAiFwStateHandler &

aStateHandler

)

[pure virtual]

Sets plugin state handler

Since: S60 5.2

Parameters

MAiFwStateHandler & aStateHandler

Member Data Documentation

TUid iDestructKey

TUid

iDestructKey

[private]

An identifier used during destruction