Marble::PositionMarker Class Reference

#include <PositionMarker.h>

Inheritance diagram for Marble::PositionMarker:

Public Slots
void	chooseColor ()
void	chooseCustomCursor ()
void	readSettings ()
void	resizeCursor (int step)
void	setPosition (const GeoDataCoordinates &position)
void	writeSettings ()
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)

Public Member Functions
	PositionMarker ()
	PositionMarker (const MarbleModel *marbleModel)
	~PositionMarker ()
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 void	setSettings (const QHash< QString, QVariant > &settings)
virtual QHash< QString, QVariant >	settings () const
QString	version () const
virtual qreal	zValue () 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 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 ()
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 }
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

Definition at line 35 of file PositionMarker.h.

Constructor & Destructor Documentation

Marble::PositionMarker::PositionMarker

(

)

Definition at line 40 of file PositionMarker.cpp.

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

explicit

Definition at line 47 of file PositionMarker.cpp.

Marble::PositionMarker::~PositionMarker

(

)

Definition at line 66 of file PositionMarker.cpp.

Member Function Documentation

QStringList Marble::PositionMarker::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 82 of file PositionMarker.cpp.

void Marble::PositionMarker::chooseColor ( )

slot

Definition at line 427 of file PositionMarker.cpp.

void Marble::PositionMarker::chooseCustomCursor ( )

slot

Definition at line 390 of file PositionMarker.cpp.

QDialog * Marble::PositionMarker::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 131 of file PositionMarker.cpp.

QString Marble::PositionMarker::copyrightYears ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 112 of file PositionMarker.cpp.

QString Marble::PositionMarker::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 107 of file PositionMarker.cpp.

QString Marble::PositionMarker::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 92 of file PositionMarker.cpp.

QIcon Marble::PositionMarker::icon ( ) const

virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 126 of file PositionMarker.cpp.

void Marble::PositionMarker::initialize ( )

virtual

Implements Marble::RenderPluginInterface.

Definition at line 161 of file PositionMarker.cpp.

bool Marble::PositionMarker::isInitialized ( ) const

virtual

Implements Marble::RenderPluginInterface.

Definition at line 171 of file PositionMarker.cpp.

QString Marble::PositionMarker::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 87 of file PositionMarker.cpp.

QString Marble::PositionMarker::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 97 of file PositionMarker.cpp.

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

virtual

Implements Marble::PluginInterface.

Definition at line 117 of file PositionMarker.cpp.

void Marble::PositionMarker::readSettings ( )

slot

Definition at line 321 of file PositionMarker.cpp.

bool Marble::PositionMarker::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 176 of file PositionMarker.cpp.

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

QStringList Marble::PositionMarker::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 72 of file PositionMarker.cpp.

void Marble::PositionMarker::resizeCursor ( int  step )

slot

Definition at line 457 of file PositionMarker.cpp.

void Marble::PositionMarker::setPosition ( const GeoDataCoordinates &  position )

slot

Definition at line 374 of file PositionMarker.cpp.

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

virtual

Set the settings of the item.

Reimplemented from Marble::RenderPlugin.

Definition at line 301 of file PositionMarker.cpp.

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

virtual

Returns

: The settings of the item.

Reimplemented from Marble::RenderPlugin.

Definition at line 287 of file PositionMarker.cpp.

QString Marble::PositionMarker::version ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 102 of file PositionMarker.cpp.

void Marble::PositionMarker::writeSettings ( )

slot

Definition at line 358 of file PositionMarker.cpp.

qreal Marble::PositionMarker::zValue ( ) const

virtual

Returns the z value of the layer (default: 0.0).

If two layers are painted at the same render position, the one with the higher z value is painted on top. If both have the same z value, their paint order is undefined.

Reimplemented from Marble::LayerInterface.

Definition at line 471 of file PositionMarker.cpp.

---

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

• PositionMarker.h
• PositionMarker.cpp