Collapse all Symbian^3 Product Developer Library

MDiagPlugin Class Reference

class MDiagPlugin

Abstract class that repsesents a diagnostics plug-in.

Since: S60 v5.0

Public Member Functions
	~MDiagPlugin()
CGulIcon *	CreateIconL()
TAny *	CustomOperationL(TUid, TAny *)
TAny *	GetCustomL(TUid, TAny *)
HBufC *	GetDescriptionL()
void	GetLogicalDependenciesL(CPtrCArray &)
HBufC *	GetPluginNameL(TNameLayoutType)
TBool	IsSupported()
TBool	IsVisible()
TUint	Order()
TUid	ParentUid()
const TDesC &	ServiceLogicalName()
void	SetDtorIdKey(TUid)
void	TestSessionBeginL(MDiagEngineCommon &, TBool, TAny *)
void	TestSessionEndL(MDiagEngineCommon &, TBool, TAny *)
TPluginType	Type()
TUid	Uid()

Public Member Enumerations
enum	TNameLayoutType { ENameLayoutListSingle, ENameLayoutPopupNoteWaitWindow, ENameLayoutListLargeGraphic, ENameLayoutHeadingPane, ENameLayoutPopupInfoPane, ENameLayoutTitlePane, ENameLayoutListSingleGraphic, ENameLayoutListDoubleGraphic }
enum	TPluginType { ETypeTestPlugin, ETypeSuitePlugin }

Constructor & Destructor Documentation

~MDiagPlugin()

~MDiagPlugin

(

)

[inline, virtual]

Virtual destructor. This ensures that when the interface is deleted, compiler will look up virtual table to find correct destructor.

Member Functions Documentation

CreateIconL()

CGulIcon *

CreateIconL

(

)

const [pure virtual]

Create an icon that represents the plug-in.

CustomOperationL(TUid, TAny *)

TAny *	CustomOperationL	(	TUid	aUid,
			TAny *	aParam
		)	[pure virtual]

Reserved for future use/plugin's custom functionality.

Parameters

TUid aUid	Unique identifier of the operation.
TAny * aParam	Custom parameter.

GetCustomL(TUid, TAny *)

TAny *	GetCustomL	(	TUid	aUid,
			TAny *	aParam
		)	[pure virtual]

Reserved for future use/plugin's custom functionality.

Parameters

TUid aUid
TAny * aParam	Custom parameter.

GetDescriptionL()

HBufC *

GetDescriptionL

(

)

const [pure virtual]

Get localised description of the test. Description should be used to explain the test for the user. It can contain comments that this service needs for example access point and it creates costs or that the duration might be long.

GetLogicalDependenciesL(CPtrCArray &)

void

GetLogicalDependenciesL

(

CPtrCArray &

aArray

)

const [pure virtual]

Get logical dependencies. One plug-in can have multiple dependencies to other plug-ins.

ServiceLogicalName.

Parameters

CPtrCArray & aArray

An array of logical names.

GetPluginNameL(TNameLayoutType)

HBufC *

GetPluginNameL

(

TNameLayoutType

aLayoutType

)

const [pure virtual]

Method for getting the name of the plugin. Name returned should be based on the layout requested, and it should fit within the layout.

TNameLayoutType

Parameters

TNameLayoutType aLayoutType

- Layout where text will be displayed in.

IsSupported()

TBool

IsSupported

(

)

const [pure virtual]

Method for checking, if plugin is supported. Overwrite this function to enable or disable your plugin dynamically. If EFalse, plug-in will not be loaded by plugin pool.

IsVisible()

TBool

IsVisible

(

)

const [pure virtual]

Method for checking, if plugin should be visible. (for example shown in listbox). Overwrite this function to show or hide your plugin dynamically.

Order()

TUint

Order

(

)

const [pure virtual]

Get the order number that this plug-in should appear in its parent list.

ParentUid()

TUid

ParentUid

(

)

const [pure virtual]

Get UID of the parent.

ServiceLogicalName()

const TDesC &

ServiceLogicalName

(

)

const [pure virtual]

Get the name of the service that the plug-in provides. Service name is defined in the ECOM resource file, thus, it is not localized.

SetDtorIdKey(TUid)

void

SetDtorIdKey

(

TUid

aDtorIdKey

)

[pure virtual]

Set ECom Destructor ID Key.

Parameters

TUid aDtorIdKey

Uid returned by REComSession::CreateImplementationL()

TestSessionBeginL(MDiagEngineCommon &, TBool, TAny *)

void	TestSessionBeginL	(	MDiagEngineCommon &	aEngine,
			TBool	aSkipDependencyCheck,
			TAny *	aCustomParams
		)	[pure virtual]

Initialization Step. This method is called before any plugin are executed. This can be used to clean up any left over data from previous execution sessions. All plug-ins in execution plan will have a chance to clean up before any plug-ins are run. This is a synchrouns method.

Parameters

MDiagEngineCommon & aEngine	- Reference to engine.
TBool aSkipDependencyCheck	- If ETrue, plug-in will be executed even if dependencies are not executed.
TAny * aCustomParams	Custom parameters for plug-ins. It can used to pass arbitrary data from application to the plug-ins. Owership is not transferred and plug-in must not delete this parameter. Ownership is not transferred since client does not always know the type of pointer.

TestSessionEndL(MDiagEngineCommon &, TBool, TAny *)

void	TestSessionEndL	(	MDiagEngineCommon &	aEngine,
			TBool	aSkipDependencyCheck,
			TAny *	aCustomParams
		)	[pure virtual]

Cleanup Step. This method is called after all plug-ins in the execution plan is completed to clean up any left over data from current sesison. This can be used to clean up any data that provides dependent service created for its dependencies. This is a synchrouns method.

Parameters

MDiagEngineCommon & aEngine	- Reference to engine.
TBool aSkipDependencyCheck	- If ETrue, plug-in as executed even if dependencies are not executed.
TAny * aCustomParams	Custom parameters for plug-ins. It can used to pass arbitrary data from application to the plug-ins. Owership is not transferred and plug-in must not delete this parameter. Ownership is not transferred since client does not always know the type of pointer.

Type()

TPluginType

Type

(

)

const [pure virtual]

Return the type of the plug-in.

TPluginType.

Uid()

TUid

Uid

(

)

const [pure virtual]

Get UID of this plug-in.

Member Enumerations Documentation

Enum TNameLayoutType

Layout type of name being requested.

Enumerators

ENameLayoutListSingle
ENameLayoutPopupNoteWaitWindow
ENameLayoutListLargeGraphic
ENameLayoutHeadingPane
ENameLayoutPopupInfoPane
ENameLayoutTitlePane
ENameLayoutListSingleGraphic
ENameLayoutListDoubleGraphic

Enum TPluginType

Indicates is the plug-in a suite or a test plug-in

Enumerators

ETypeTestPlugin
ETypeSuitePlugin