Collapse all Symbian^3 Product Developer Library

CCalenCustomisationManager Class Reference

class CCalenCustomisationManager : public CBase

CCalenCustomisationManager manages customisations for calendar.

Inherits from

CCalenCustomisationManager
- CBase

Nested Classes and Structures

Public Member Functions
	~CCalenCustomisationManager()
IMPORT_C const RArray< TUid > &	ActivePlugins()
IMPORT_C TBool	CanBeEnabledDisabledL(TUid)
IMPORT_C MCalenPreview *	CustomPreviewPaneL(TRect &)
IMPORT_C void	DisableAllPluginsL()
IMPORT_C void	DoPluginLoadingL()
IMPORT_C MCalenCommandHandler *	GetCommandHandlerL(TInt)
IMPORT_C void	GetCustomViewsL(TUid, RPointerArray< CCalenView > &)
IMPORT_C void	GetHiddenViewIdL(TUid, RArray< TInt > &)
IMPORT_C void	GetPluginSettingsL(TUid, RPointerArray< CAknSettingItem > &)
IMPORT_C TUid	GetReplacePluginViewIdL(TUid)
void	HandleNotification(const TCalenNotification)
IMPORT_C TBool	HiddenView(TUid)
IMPORT_C CCoeControl *	Infobar(const TRect &)
IMPORT_C const TDesC &	Infobar()
IMPORT_C TBool	IsViewRomBased(TUid)
IMPORT_C CCalenCustomisationManager *	NewL(MCalenServicesFactory &, CCalenPluginStatusArray &, MCalenServices &, RPointerArray< CCalenViewInfo > &)
IMPORT_C void	OfferMenuPaneL(TInt, CEikMenuPane *)
IMPORT_C const RImplInfoPtrArray &	PluginInfoArray()
IMPORT_C CCoeControl *	PreviewPane(TRect &)
IMPORT_C void	SetPluginAvailabilityL(TUid, TBool)
IMPORT_C void	UnloadPluginsL(const RArray< TUid > &)
IMPORT_C const RPointerArray< CCalenViewInfo > &	Views()

Private Member Functions
	CCalenCustomisationManager(MCalenServicesFactory &, MCalenServices &, RPointerArray< CCalenViewInfo > &, CCalenPluginStatusArray &)
void	AddPluginL(CCalenCustomisation *, TUid)
void	CheckHiddenViewL(TUid, TUid)
void	ConstructL()
void	CreateActivePluginListL()
void	DisablePluginL(TUid)
void	DisablePluginOnFakeExitL(TUid)
void	DoImmediatePluginLoadingL(TBool)
void	EnablePluginL(TUid)
CCalenCustomisation *	FindPluginL(TUid)
void	HandleNotificationL(TCalenNotification)
void	LoadPluginL(TUid)
void	LoadPluginsBasedOnVariantL()
void	OfferMenuPaneToPluginsL(TInt, CEikMenuPane *)
TBool	PluginAvailabilityFinder(const TUid *, const TCalenPluginAvailability &)
TBool	PluginInfoFinder(const TUid *, const CImplementationInformation &)
RPointerArray< CCalenViewInfo > &	ViewInfoArray()

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

Public Member Type Definitions
typedef	RArray< CCalenCustomisationManager::TCalenPluginAvailability > CCalenPluginStatusArray

Private Attributes
RArray< TUid >	iActivePlugins
RArray< TUid >	iDefferedUnloadPluginList
CCalenGlobalData *	iGlobalData
RArray< TInt >	iHiddenViews
TUid	iInfoBarProviderUid
TPtrC	iInfoBarStr
RImplInfoPtrArray	iPluginInfo
CCalenPluginStatusArray &	iPluginSettingsStatus
RPointerArray< CPluginInfo >	iPlugins
TBool	iPluginsEnabledDisabled
TUid	iPreviewPaneProviderUid
RArray< TUid >	iRomBasedPlugins
MCalenServices &	iServices
MCalenServicesFactory &	iServicesFactory
CCalenSetting *	iSetting
TLinearOrder< CCalenViewInfo >	iSortOrder
RPointerArray< CCalenViewInfo > &	iViewInfoArray

Constructor & Destructor Documentation

CCalenCustomisationManager(MCalenServicesFactory &, MCalenServices &, RPointerArray< CCalenViewInfo > &, CCalenPluginStatusArray &)

CCalenCustomisationManager	(	MCalenServicesFactory &	aFactory,
		MCalenServices &	aServices,
		RPointerArray< CCalenViewInfo > &	aViewArray,
		CCalenPluginStatusArray &	aPluginSettingsStatus
	)	[private]

Parameters

MCalenServicesFactory & aFactory
MCalenServices & aServices
RPointerArray< CCalenViewInfo > & aViewArray
CCalenPluginStatusArray & aPluginSettingsStatus

~CCalenCustomisationManager()

~CCalenCustomisationManager

(

)

Destructor.

Member Functions Documentation

ActivePlugins()

IMPORT_C const RArray< TUid > &

ActivePlugins

(

)

const

Returns a reference to an array of active plugins uids

AddPluginL(CCalenCustomisation *, TUid)

void	AddPluginL	(	CCalenCustomisation *	aPlugin,
			TUid	aUid
		)	[private]

Parameters

CCalenCustomisation * aPlugin
TUid aUid

CanBeEnabledDisabledL(TUid)

IMPORT_C TBool

CanBeEnabledDisabledL

(

TUid

aPluginUid

)

Returns if plugin can be enabled/disabled from settings

Parameters

TUid aPluginUid

CheckHiddenViewL(TUid, TUid)

void	CheckHiddenViewL	(	TUid	aViewUid,
			TUid	aPluginUid
		)	[private]

Parameters

TUid aViewUid
TUid aPluginUid

ConstructL()

void

ConstructL

(

)

[private]

CreateActivePluginListL()

void

CreateActivePluginListL

(

)

[private]

CustomPreviewPaneL(TRect &)

IMPORT_C MCalenPreview *

CustomPreviewPaneL

(

TRect &

aRect

)

Gets a custom preview pane from the appropriate customisation.

Parameters

TRect & aRect

DisableAllPluginsL()

IMPORT_C void

DisableAllPluginsL

(

)

Disable all plugins

DisablePluginL(TUid)

void

DisablePluginL

(

TUid

aPluginUid

)

[private]

Parameters

TUid aPluginUid

DisablePluginOnFakeExitL(TUid)

void

DisablePluginOnFakeExitL

(

TUid

aPluginUid

)

[private]

Disable plugin on fake exit

Parameters

TUid aPluginUid

DoImmediatePluginLoadingL(TBool)

void

DoImmediatePluginLoadingL

(

TBool

aLoadViewbasedPulgins = EFalse

)

[private]

Parameters

TBool aLoadViewbasedPulgins = EFalse

DoPluginLoadingL()

IMPORT_C void

DoPluginLoadingL

(

)

Reload all plugins

EnablePluginL(TUid)

void

EnablePluginL

(

TUid

aPluginUid

)

[private]

Parameters

TUid aPluginUid

FindPluginL(TUid)

CCalenCustomisation *

FindPluginL

(

TUid

aUid

)

[private]

Parameters

TUid aUid

GetCommandHandlerL(TInt)

IMPORT_C MCalenCommandHandler *

GetCommandHandlerL

(

TInt

aCommand

)

Get a command handler for a specific command

Parameters

TInt aCommand

Command to find a command handler for

GetCustomViewsL(TUid, RPointerArray< CCalenView > &)

IMPORT_C void	GetCustomViewsL	(	TUid	aPluginUid,
			RPointerArray< CCalenView > &	aViews
		)

GetCustomViews returns custom views info in an array for a given plugin. NOTE: The contents of the array are owned by the caller - caller must guarantee to call ResetAndDestroy on the array in all cases.

Parameters

TUid aPluginUid
RPointerArray< CCalenView > & aViews

GetHiddenViewIdL(TUid, RArray< TInt > &)

IMPORT_C void	GetHiddenViewIdL	(	TUid	aPluginUid,
			RArray< TInt > &	aHiddenViews
		)

Fills the list of views hidden by a particular plugin

Parameters

TUid aPluginUid
RArray< TInt > & aHiddenViews

GetPluginSettingsL(TUid, RPointerArray< CAknSettingItem > &)

IMPORT_C void	GetPluginSettingsL	(	TUid	aPluginUid,
			RPointerArray< CAknSettingItem > &	aSettingArray
		)

Gets settings from the given plugin. NOTE: The contents of the array are owned by the caller - caller must guarantee to call ResetAndDestroy on the array in all cases.

Parameters

TUid aPluginUid
RPointerArray< CAknSettingItem > & aSettingArray

GetReplacePluginViewIdL(TUid)

IMPORT_C TUid

GetReplacePluginViewIdL

(

TUid

aHiddenViewId

)

Returns plugin view uid that is hidking the input view

Parameters

TUid aHiddenViewId

HandleNotification(const TCalenNotification)

void

HandleNotification

(

const TCalenNotification

aNotification

)

Parameters

const TCalenNotification aNotification

HandleNotificationL(TCalenNotification)

void

HandleNotificationL

(

TCalenNotification

aNotification

)

[private]

Parameters

TCalenNotification aNotification

HiddenView(TUid)

IMPORT_C TBool

HiddenView

(

TUid

aHiddenView

)

const

Returns ETrue if a view has been hidden by a plugin,

Parameters

TUid aHiddenView

Infobar(const TRect &)

IMPORT_C CCoeControl *

Infobar

(

const TRect &

aRect

)

Gets a info bar from the appropriate customisation.

Parameters

const TRect & aRect

Infobar()

IMPORT_C const TDesC &

Infobar

(

)

Gets a info bar from the appropriate customisation.

IsViewRomBased(TUid)

IMPORT_C TBool

IsViewRomBased

(

TUid

aViewUid

)

const

Returns if a view is provided by a rom based plugin

Parameters

TUid aViewUid

LoadPluginL(TUid)

void

LoadPluginL

(

TUid

aPluginUid

)

[private]

Parameters

TUid aPluginUid

LoadPluginsBasedOnVariantL()

void

LoadPluginsBasedOnVariantL

(

)

[private]

NewL(MCalenServicesFactory &, CCalenPluginStatusArray &, MCalenServices &, RPointerArray< CCalenViewInfo > &)

IMPORT_C CCalenCustomisationManager *	NewL	(	MCalenServicesFactory &	aFactory,
			CCalenPluginStatusArray &	aPluginSettingsStatus,
			MCalenServices &	aServices,
			RPointerArray< CCalenViewInfo > &	aViewArray
		)	[static]

Returns a new CCalenCustomisationManager object.

Parameters

MCalenServicesFactory & aFactory
CCalenPluginStatusArray & aPluginSettingsStatus
MCalenServices & aServices
RPointerArray< CCalenViewInfo > & aViewArray

OfferMenuPaneL(TInt, CEikMenuPane *)

IMPORT_C void	OfferMenuPaneL	(	TInt	aResourceId,
			CEikMenuPane *	aMenuPane
		)

Offers the menu pane to customisations for modification.

Parameters

TInt aResourceId
CEikMenuPane * aMenuPane

OfferMenuPaneToPluginsL(TInt, CEikMenuPane *)

void	OfferMenuPaneToPluginsL	(	TInt	aResourceId,
			CEikMenuPane *	aMenuPane
		)	[private]

Parameters

TInt aResourceId
CEikMenuPane * aMenuPane

PluginAvailabilityFinder(const TUid *, const TCalenPluginAvailability &)

TBool	PluginAvailabilityFinder	(	const TUid *	aUid,
			const TCalenPluginAvailability &	aArrayItem
		)	[private, static]

Parameters

const TUid * aUid
const TCalenPluginAvailability & aArrayItem

PluginInfoArray()

IMPORT_C const RImplInfoPtrArray &

PluginInfoArray

(

)

const

Returns a const reference to the plugin information array.

PluginInfoFinder(const TUid *, const CImplementationInformation &)

TBool	PluginInfoFinder	(	const TUid *	aUid,
			const CImplementationInformation &	aArrayItem
		)	[private, static]

Parameters

const TUid * aUid
const CImplementationInformation & aArrayItem

PreviewPane(TRect &)

IMPORT_C CCoeControl *

PreviewPane

(

TRect &

aRect

)

Gets a preview pane from the appropriate customisation.

Parameters

TRect & aRect

SetPluginAvailabilityL(TUid, TBool)

IMPORT_C void	SetPluginAvailabilityL	(	TUid	aPluginUid,
			TBool	aEnabled
		)

Disables the given plugin. Does nothing if the plugin can't be found.

Parameters

TUid aPluginUid
TBool aEnabled

UnloadPluginsL(const RArray< TUid > &)

IMPORT_C void

UnloadPluginsL

(

const RArray< TUid > &

aPlugins

)

When a plugin is disabled it can not be unloaded until any views etc it has provided have been deleted. This function is called when it is safe to unload the plugin.

Parameters

const RArray< TUid > & aPlugins

ViewInfoArray()

RPointerArray< CCalenViewInfo > &

ViewInfoArray

(

)

[private]

Views()

IMPORT_C const RPointerArray< CCalenViewInfo > &

Views

(

)

const

Returns a const reference to the views array.

Member Type Definitions Documentation

Typedef CCalenPluginStatusArray

typedef RArray< CCalenCustomisationManager::TCalenPluginAvailability >

CCalenPluginStatusArray

Member Data Documentation

RArray< TUid > iActivePlugins

RArray< TUid >

iActivePlugins

[private]

RArray< TUid > iDefferedUnloadPluginList

RArray< TUid >

iDefferedUnloadPluginList

[private]

CCalenGlobalData * iGlobalData

CCalenGlobalData *

iGlobalData

[private]

RArray< TInt > iHiddenViews

RArray< TInt >

iHiddenViews

[private]

TUid iInfoBarProviderUid

TUid

iInfoBarProviderUid

[private]

TPtrC iInfoBarStr

TPtrC

iInfoBarStr

[private]

RImplInfoPtrArray iPluginInfo

RImplInfoPtrArray

iPluginInfo

[private]

CCalenPluginStatusArray & iPluginSettingsStatus

CCalenPluginStatusArray &

iPluginSettingsStatus

[private]

RPointerArray< CPluginInfo > iPlugins

RPointerArray< CPluginInfo >

iPlugins

[private]

TBool iPluginsEnabledDisabled

TBool

iPluginsEnabledDisabled

[private]

TUid iPreviewPaneProviderUid

TUid

iPreviewPaneProviderUid

[private]

RArray< TUid > iRomBasedPlugins

RArray< TUid >

iRomBasedPlugins

[private]

MCalenServices & iServices

MCalenServices &

iServices

[private]

MCalenServicesFactory & iServicesFactory

MCalenServicesFactory &

iServicesFactory

[private]

CCalenSetting * iSetting

CCalenSetting *

iSetting

[private]

TLinearOrder< CCalenViewInfo > iSortOrder

TLinearOrder< CCalenViewInfo >

iSortOrder

[private]

RPointerArray< CCalenViewInfo > & iViewInfoArray

RPointerArray< CCalenViewInfo > &

iViewInfoArray

[private]