#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

RenderState	renderState () const

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 QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () 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) const

QStringList	settingKeys () const

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)

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from Marble::RenderPlugin
bool	eventFilter (QObject , QEvent )

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from Marble::RenderPlugin
QString	description

bool	enabled

QString	name

QString	nameId

bool	userCheckable

QString	version

bool	visible

Properties inherited from QObject
	objectName

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:

marble

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

marble

kdeedu API Reference

Search