Collapse all Symbian^3 Application Developer Library

MScreensaverPlugin Class Reference

class MScreensaverPlugin

The base class for screensaver plugin modules. Every plugin module must inherit and implement this class.

Public Member Functions
	~MScreensaverPlugin ()
TInt	Capabilities ()
TInt	Draw ( CWindowGc &)
TInt	HandleScreensaverEventL ( TScreensaverEvent , TAny *)
TInt	InitializeL ( MScreensaverPluginHost *)
const TDesC16 &	Name ()
TInt	PluginFunction ( TScPluginCaps , TAny *)

Constructor & Destructor Documentation

~MScreensaverPlugin()

~MScreensaverPlugin

(

)

[inline, virtual]

Virtual desctructor.

Member Functions Documentation

Capabilities()

TInt

Capabilities

(

)

[inline, virtual]

Screensaver plugin capabilities query. The capabilitities reveal which functions the plugin implements, that can be used by calling PluginFunction() .

Note:

Capabilites need to be defined as opaque_data in ECom plugin registration file as well.

Draw(CWindowGc &)

TInt

Draw

(

CWindowGc &

aGc

)

[pure virtual]

When a plugin module is active this method is called every time when refresh timer expires in screensaver application.

Parameters

CWindowGc & aGc

Graphics context for plugin module to draw to.

HandleScreensaverEventL(TScreensaverEvent, TAny *)

TInt	HandleScreensaverEventL	(	TScreensaverEvent	aEvent,
			TAny *	aData
		)	[pure virtual]

Handler function for screensaver events.

Parameters

TScreensaverEvent aEvent	Event to be handled.
TAny * aData	Data related to the event. To be decided on a case-by-case basis.

InitializeL(MScreensaverPluginHost *)

TInt

InitializeL

(

MScreensaverPluginHost *

aHost

)

[pure virtual]

Used to initialize the plugin module after creation. Name() function may be called without the plugin being initialized, to enable name query from modules that are not plugin hosts.

Parameters

MScreensaverPluginHost * aHost

Screensaver plugin host.

Name()

const TDesC16 &

Name

(

)

const [pure virtual]

Returns the name of plugin module. Returned name is displayed in the list of installed plugin modules in Themes application. If this function returns an empty name (KNullDesC), displayed name is taken from ECom registration resource.

PluginFunction(TScPluginCaps, TAny *)

TInt	PluginFunction	(	TScPluginCaps	,
			TAny *
		)	[inline, virtual]

Screensaver plugin function method. Only the functions returned by Capabilities() can be used, and only one function at a time.

aFunction

Parameters

TScPluginCaps
TAny *