Marble::InhibitScreensaverPlugin Class Reference

#include <InhibitScreensaverPlugin.h>

Inheritance diagram for Marble::InhibitScreensaverPlugin:

Public Member Functions
	InhibitScreensaverPlugin ()
	InhibitScreensaverPlugin (const MarbleModel *marbleModel)
	~InhibitScreensaverPlugin ()
QStringList	backendTypes () const
QString	copyrightYears () const
QString	description () const
QString	guiString () const
QIcon	icon () const
void	initialize ()
bool	isInitialized () const
QString	name () const
QString	nameId () const
QList< PluginAuthor >	pluginAuthors () const
virtual bool	render (GeoPainter *painter, ViewportParams *viewport, const QString &renderPos="NONE", GeoSceneLayer *layer=0)
virtual QString	renderPolicy () const
virtual QStringList	renderPosition () const
QString	version () const
Public Member Functions inherited from Marble::RenderPlugin
	RenderPlugin (const MarbleModel *marbleModel)
virtual	~RenderPlugin ()
virtual const QList < QActionGroup * > *	actionGroups () const
bool	enabled () const
bool	isUserCheckable () const
const MarbleModel *	marbleModel () const
virtual RenderPlugin *	newInstance (const MarbleModel *marbleModel) const =0
virtual RenderType	renderType () const
virtual QString	runtimeTrace () const
virtual void	setSettings (const QHash< QString, QVariant > &settings)
virtual QHash< QString, QVariant >	settings () const
virtual const QList < QActionGroup * > *	toolbarActionGroups () const
bool	visible () const
Public Member Functions inherited from Marble::RenderPluginInterface
virtual	~RenderPluginInterface ()
Public Member Functions inherited from Marble::PluginInterface
virtual	~PluginInterface ()
virtual QString	aboutDataText () const
Public Member Functions inherited from Marble::LayerInterface
virtual	~LayerInterface ()
virtual qreal	zValue () const

Additional Inherited Members
Public Types inherited from Marble::RenderPlugin
enum	RenderType {   UnknownRenderType, TopLevelRenderType, PanelRenderType, OnlineRenderType,   ThemeRenderType }
Public Slots inherited from Marble::RenderPlugin
QAction *	action () const
void	restoreDefaultSettings ()
void	setEnabled (bool enabled)
bool	setSetting (const QString &key, const QVariant &value)
QVariant	setting (const QString &key)
QStringList	settingKeys ()
void	setUserCheckable (bool isUserCheckable)
void	setVisible (bool visible)
Signals inherited from Marble::RenderPlugin
void	actionGroupsChanged ()
void	enabledChanged (bool enable)
void	repaintNeeded (QRegion dirtyRegion=QRegion())
void	settingsChanged (QString nameId)
void	userCheckableChanged (bool isUserCheckable)
void	visibilityChanged (bool visible, const QString &nameId)
Protected Member Functions inherited from Marble::RenderPlugin
bool	eventFilter (QObject *, QEvent *)
Properties inherited from Marble::RenderPlugin
QString	description
bool	enabled
QString	name
QString	nameId
bool	userCheckable
QString	version
bool	visible

Detailed Description

A plugin that inhibits the screensaver as long as a position provider plugin is active.

Definition at line 25 of file InhibitScreensaverPlugin.h.

Constructor & Destructor Documentation

Marble::InhibitScreensaverPlugin::InhibitScreensaverPlugin

(

)

Definition at line 46 of file InhibitScreensaverPlugin.cpp.

Marble::InhibitScreensaverPlugin::InhibitScreensaverPlugin ( const MarbleModel *  marbleModel )

explicit

Definition at line 52 of file InhibitScreensaverPlugin.cpp.

Marble::InhibitScreensaverPlugin::~InhibitScreensaverPlugin

(

)

Definition at line 68 of file InhibitScreensaverPlugin.cpp.

Member Function Documentation

QStringList Marble::InhibitScreensaverPlugin::backendTypes ( ) const

virtual

Returns the name(s) of the backend that the plugin can render This method should return the name of the backend that the plugin can render.

The string has to be the same one that is given for the attribute in the layer element of the DGML file that backend is able to process. Examples to replace available default backends would be "vector" or "texture". To provide a completely new kind of functionality please choose your own unique string.

Implements Marble::RenderPluginInterface.

Definition at line 73 of file InhibitScreensaverPlugin.cpp.

QString Marble::InhibitScreensaverPlugin::copyrightYears ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 109 of file InhibitScreensaverPlugin.cpp.

QString Marble::InhibitScreensaverPlugin::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 104 of file InhibitScreensaverPlugin.cpp.

QString Marble::InhibitScreensaverPlugin::guiString ( ) const

virtual

String that should be displayed in GUI.

Using a "&" you can suggest key shortcuts

Example: "&Stars"

Returns

string for gui usage

Implements Marble::RenderPlugin.

Definition at line 89 of file InhibitScreensaverPlugin.cpp.

QIcon Marble::InhibitScreensaverPlugin::icon ( ) const

virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 120 of file InhibitScreensaverPlugin.cpp.

void Marble::InhibitScreensaverPlugin::initialize ( )

virtual

Implements Marble::RenderPluginInterface.

Definition at line 125 of file InhibitScreensaverPlugin.cpp.

bool Marble::InhibitScreensaverPlugin::isInitialized ( ) const

virtual

Implements Marble::RenderPluginInterface.

Definition at line 138 of file InhibitScreensaverPlugin.cpp.

QString Marble::InhibitScreensaverPlugin::name ( ) const

virtual

Returns the user-visible name of the plugin.

The user-visible name should be context free, i.e. the name should provide enough information as to what the plugin is about in the context of Marble.

Example: "Starry Sky Background", "OpenRouteService Routing"

Implements Marble::PluginInterface.

Definition at line 84 of file InhibitScreensaverPlugin.cpp.

QString Marble::InhibitScreensaverPlugin::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 94 of file InhibitScreensaverPlugin.cpp.

QList< PluginAuthor > Marble::InhibitScreensaverPlugin::pluginAuthors ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 114 of file InhibitScreensaverPlugin.cpp.

bool Marble::InhibitScreensaverPlugin::render ( GeoPainter *  painter, ViewportParams *  viewport, const QString &  renderPos = "NONE", GeoSceneLayer *  layer = 0  )

virtual

Renders the content provided by the layer on the viewport.

Parameters

painter	painter object allowing to paint on the map
viewport	metadata, such as current projection, screen dimension, etc.
renderPos	current render position
layer	deprecated, always zero (NULL)

Returns

true Returns whether the rendering has been successful

Implements Marble::LayerInterface.

Definition at line 163 of file InhibitScreensaverPlugin.cpp.

QString Marble::InhibitScreensaverPlugin::renderPolicy ( ) const

virtual

Return how the plugin settings should be used.

FIXME: Document this Possible Values: "ALWAYS" – the plugin renders at the preferred position no matter what got specified in the DGML file. "SPECIFIED" – renders only in case it got specified in the DGML file. "SPECIFIED_ALWAYS" – In case it got specified in the DGML file render according to the specification otherwise choose the preferred position

Implements Marble::RenderPluginInterface.

Definition at line 169 of file InhibitScreensaverPlugin.cpp.

QStringList Marble::InhibitScreensaverPlugin::renderPosition ( ) const

virtual

Preferred level in the layer stack for the rendering.

Gives a preferred level in the existing layer stack where the render() method of this plugin should get executed. Possible Values: "NONE" "STARS" "BEHIND_TARGET" "SURFACE" "HOVERS_ABOVE_SURFACE" "ATMOSPHERE" "ORBIT" "ALWAYS_ON_TOP" "FLOAT_ITEM" "USER_TOOLS"

Implements Marble::LayerInterface.

Definition at line 78 of file InhibitScreensaverPlugin.cpp.

QString Marble::InhibitScreensaverPlugin::version ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 99 of file InhibitScreensaverPlugin.cpp.

---

The documentation for this class was generated from the following files:

• InhibitScreensaverPlugin.h
• InhibitScreensaverPlugin.cpp