#include <mw/screensaverplugin.h>
| class MScreensaverPlugin |
| Public Member Functions | |
|---|---|
| virtual | ~MScreensaverPlugin() |
| virtual TInt | Capabilities() |
| pure virtual TInt | Draw(CWindowGc &) |
| pure virtual TInt | HandleScreensaverEventL(TScreensaverEvent, TAny *) |
| pure virtual TInt | InitializeL(MScreensaverPluginHost *) |
| pure virtual const TDesC16 & | Name() |
| virtual TInt | PluginFunction(TScPluginCaps, TAny *) |
The base class for screensaver plugin modules. Every plugin module must inherit and implement this class.
| TInt | Capabilities | ( | ) | [inline, virtual] |
Screensaver plugin capabilities query. The capabilitities reveal which functions the plugin implements, that can be used by calling PluginFunction().
Capabilites need to be defined as opaque_data in ECom plugin registration file as well.
Returns: Bit mask of plugin capabilities.
When a plugin module is active this method is called every time when refresh timer expires in screensaver application.
| Parameter | Description |
|---|---|
| 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).
| TInt | HandleScreensaverEventL | ( | TScreensaverEvent | aEvent, |
| TAny * | aData | |||
| ) | [pure virtual] | |||
Handler function for screensaver events.
| Parameter | Description |
|---|---|
| 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.
| 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.
| Parameter | Description |
|---|---|
| aHost | Screensaver plugin host. |
Returns: KErrNone if everything went ok. Otherwise system wide error code.
| 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.
Returns: Descriptor containing the name of the plugin module.
| 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
Returns: System wide error code. KErrNone on success.