#include <CrosshairsPlugin.h>

Inheritance diagram for Marble::CrosshairsPlugin:

Public Member Functions
	CrosshairsPlugin ()

	CrosshairsPlugin (const MarbleModel *marbleModel)

	~CrosshairsPlugin ()

QStringList	backendTypes () const

QDialog *	configDialog ()

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

bool	render (GeoPainter painter, ViewportParams viewport, const QString &renderPos, GeoSceneLayer *layer=0)

QString	renderPolicy () const

QStringList	renderPosition () const

virtual RenderType	renderType () const

void	setSettings (const QHash< QString, QVariant > &settings)

QHash< QString, QVariant >	settings () 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 QString	runtimeTrace () 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

Public Member Functions inherited from Marble::DialogConfigurationInterface
virtual	~DialogConfigurationInterface ()

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

The class that specifies the Marble layer interface of a plugin.

Definition at line 39 of file CrosshairsPlugin.h.

Constructor & Destructor Documentation

Marble::CrosshairsPlugin::CrosshairsPlugin ( )

Definition at line 30 of file CrosshairsPlugin.cpp.

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

explicit

Definition at line 36 of file CrosshairsPlugin.cpp.

Marble::CrosshairsPlugin::~CrosshairsPlugin ( )

Definition at line 46 of file CrosshairsPlugin.cpp.

Member Function Documentation

QStringList Marble::CrosshairsPlugin::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 52 of file CrosshairsPlugin.cpp.

QDialog * Marble::CrosshairsPlugin::configDialog ( )

virtual

Returns a pointer to the configuration dialog of the plugin.

Returns: : Pointer to the configuration dialog, which must be non-zero.

Implements Marble::DialogConfigurationInterface.

Definition at line 125 of file CrosshairsPlugin.cpp.

QString Marble::CrosshairsPlugin::copyrightYears ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 97 of file CrosshairsPlugin.cpp.

QString Marble::CrosshairsPlugin::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 92 of file CrosshairsPlugin.cpp.

QString Marble::CrosshairsPlugin::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 77 of file CrosshairsPlugin.cpp.

QIcon Marble::CrosshairsPlugin::icon ( ) const

virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 109 of file CrosshairsPlugin.cpp.

void Marble::CrosshairsPlugin::initialize ( )

virtual

Implements Marble::RenderPluginInterface.

Definition at line 114 of file CrosshairsPlugin.cpp.

bool Marble::CrosshairsPlugin::isInitialized ( ) const

virtual

Implements Marble::RenderPluginInterface.

Definition at line 120 of file CrosshairsPlugin.cpp.

QString Marble::CrosshairsPlugin::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 72 of file CrosshairsPlugin.cpp.

QString Marble::CrosshairsPlugin::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 82 of file CrosshairsPlugin.cpp.

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

virtual

Implements Marble::PluginInterface.

Definition at line 102 of file CrosshairsPlugin.cpp.

bool Marble::CrosshairsPlugin::render	(	GeoPainter *	painter,
		ViewportParams *	viewport,
		const QString &	renderPos,
		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 200 of file CrosshairsPlugin.cpp.

QString Marble::CrosshairsPlugin::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 57 of file CrosshairsPlugin.cpp.

QStringList Marble::CrosshairsPlugin::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 62 of file CrosshairsPlugin.cpp.

RenderPlugin::RenderType Marble::CrosshairsPlugin::renderType ( ) const

virtual

Render type of the plugin.

Function for returning the type of plugin this is for. This affects where in the menu tree the action() is placed.

See also: RenderType

Returns: : The type of render plugin this is

Reimplemented from Marble::RenderPlugin.

Definition at line 67 of file CrosshairsPlugin.cpp.

void Marble::CrosshairsPlugin::setSettings ( const QHash< QString, QVariant > & settings )

virtual

Set the settings of the plugin.

Usually this is called at startup to restore saved settings.

Parameters

new	plugin's settings

See also: settings

Reimplemented from Marble::RenderPlugin.

Definition at line 153 of file CrosshairsPlugin.cpp.

QHash< QString, QVariant > Marble::CrosshairsPlugin::settings ( ) const

virtual

Settings of the plugin.

Settings is the map (hash table) of plugin's settings This method is called to determine the current settings of the plugin for serialization, e.g. when closing the application.

Returns: plugin's settings

See also: setSettings

Reimplemented from Marble::RenderPlugin.

Definition at line 144 of file CrosshairsPlugin.cpp.

QString Marble::CrosshairsPlugin::version ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 87 of file CrosshairsPlugin.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