S60 3rd Edition API Reference: MScreensaverPlugin Class Reference MScreensaverPlugin Class Reference API published in: S60 2nd Ed
Link against:
Capability Information Required Capabilities LocalServices Location NetworkServices PowerMgmt ReadDeviceData ReadUserData SwEvent UserEnvironment WriteDeviceData WriteUserData
Exceptions None
#include <screensaverplugin.h >
Inherited by CScreensaverPluginInterfaceDefinition .
Detailed Description
The base class for screensaver plugin modules.
Every plugin module must inherit and implement this class.
Constructor & Destructor Documentation
virtual MScreensaverPlugin::~MScreensaverPlugin ( ) [inline, virtual]
Member Function Documentation
virtual TInt MScreensaverPlugin::Capabilities ( ) [inline, virtual]
Screensaver plugin capabilities query.
The capabilitities reveal which functions the plugin implements, that can be used by calling PluginFunction() .
Returns: Bit mask of plugin capabilities. Note: Capabilites need to be defined as opaque_data in ECom plugin registration file as well.
virtual TInt MScreensaverPlugin::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:
aGc Graphics context for plugin module to draw to.
Returns: KErrNone if everything went ok. Otherwise system wide error code (doesn't have any effect in current version).
virtual TInt MScreensaverPlugin::HandleScreensaverEventL ( TScreensaverEvent aEvent , TAny * aData ) [pure virtual]
Handler function for screensaver events.
Parameters:
aEvent Event to be handled. aData Data related to the event. To be decided on a case-by-case basis.
Returns: KErrNone if OK, otherwise an error code.
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:
aHost Screensaver plugin host.
Returns: KErrNone if everything went ok. Otherwise system wide error code.
virtual const TDesC16& MScreensaverPlugin::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.
Returns: Descriptor containing the name of the plugin module.
virtual TInt MScreensaverPlugin::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:
aParam Parameters to the function. TBD function-by-function.
Returns: System wide error code. KErrNone on success.
