Plugin may use this function to enquire display properties. Should be called e.g. in response to EScreensaverEventDisplayChanged to retrieve the new information.

Cancels the effect of SetActiveDisplayArea method. The whole display area is activated.

Queries screensaver color in current environment (includes partial modes supported by display hardware).

Returns payload associated with given screensaver indicator. For list of supported indcicator indices see definition of TScreensaverIndicatorIndex. Also see definition of TIndicatorPayload class.

Notifies plugin host that plugin module is going to take care of drawing indicator view and host shouldn't display them anymore. If not overridden, normal screensaver will display when there are indicators to show. Overriding the indicators does not mean they _have_ to be drawn by the plugin, but that screensaver will not try to do it.

Returns the current timeout value of refresh timer.

With this method the plugin may request screen backlight to be turned on or off.

With this method the plugin may request a one-shot timeout event (EScreensaverEventTimeout) after the specified amount of seconds has passed. If the plugin only wants to be displayed for a certain time, this can be used instead of defining a timer in the plugin. Note that the maximum time is about 35 minutes (TTimeIntervalMicroSeconds32). If the screensaver is stopped before the time has passed, the timer will be canceled and callback not issued. The timer is also cancelled after the timeout has occurred. New timeout requests also cancel any pending timeouts before issuing a new one. A time value of 0 just cancels a pending timeout.

With this method the plugin can revert to the default screensaver. The plugin will be unloaded, and not used any more until the user re-selects the plugin to be the active screensaver. Should be used when the plugin encounters an unrecoverable error, such as a missing file or expired DRM, and will not be able to run any more. NOTE: A plugin should not expect any events after calling this function.

This method is used for activating so called screensaver partial mode. Partial mode area specifies an area on the screen where screensaver plugin module is going to draw during next refresh period. When partial mode is activated the screen segments outside given area are physically turned off to decrease power consumption. Whether partial mode is supported or not depends on actual display hardware. It is also possible that some devices support only limited number of colors in partial mode area. The actual size of the partial mode area may be restricted by the display hardware, and differ from the size requested. Note that both minimum and/or maximum size may be restricted. If partial mode is not supported this method does nothing (that's always the case in WINS environment).

Should use the rect-version from S60 v3.0 on

This method is used for activating so called screensaver partial mode. Partial mode area specifies an area on the screen where screensaver plugin module is going to draw during next refresh period. When partial mode is activated the screen segments outside given area are physically turned off to decrease power consumption. Whether partial mode is supported or not depends on actual display hardware. It is also possible that some devices support only limited number of colors in partial mode area. The actual size of the partial mode area may be restricted by the display hardware, and differ from the size requested. Note that both minimum and/or maximum size may be restricted. If partial mode is not supported this method does nothing (that's always the case in WINS environment).

Sets timeout value for refresh timer. Plugin module's draw method is called every time when refresh timer expires.

Returns boolean value indicating whether standard indicator drawing is used or not.

This method suspends plugin module drawing for given time. During that time standard screensaver view is drawn.

With this method the plugin may request Draw() timer to be turned on or off. When on (the default) the plugins Draw() function is called in intervals specified in SetRefreshTimerValue().

Sets screensaver application to use standard indicator view. This is default mode for indicator drawing.