#include <AnnotatePlugin.h>

Inheritance diagram for Marble::AnnotatePlugin:

Public Slots
void	addOverlay ()

void	clearAnnotations ()

void	enableModel (bool enabled)

void	loadAnnotationFile ()

void	saveAnnotationFile ()

void	setAddingOverlay (bool)

void	setAddingPlacemark (bool)

void	setAddingPolygonHole (bool)

void	setDrawingPolygon (bool)

void	setMergingNodes (bool)

void	setRemovingItems (bool)

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
void	itemRemoved ()

void	overlayAdded ()

void	placemarkAdded ()

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)

Public Member Functions
	AnnotatePlugin (const MarbleModel *model=0)

virtual	~AnnotatePlugin ()

virtual const QList < QActionGroup * > *	actionGroups () const

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

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

QString	renderPolicy () const

QStringList	renderPosition () const

virtual QString	runtimeTrace () const

virtual const QList < QActionGroup * > *	toolbarActionGroups () const

QString	version () const

Public Member Functions inherited from Marble::RenderPlugin
	RenderPlugin (const MarbleModel *marbleModel)

virtual	~RenderPlugin ()

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 void	setSettings (const QHash< QString, QVariant > &settings)

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

Protected Member Functions
bool	eventFilter (QObject watched, QEvent event)

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)

Additional Inherited Members
Public Types inherited from Marble::RenderPlugin
enum	RenderType { UnknownRenderType, TopLevelRenderType, PanelRenderType, OnlineRenderType, ThemeRenderType }

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)

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

This class specifies the Marble layer interface of a plugin which annotates maps with polygons and placemarks.

Definition at line 49 of file AnnotatePlugin.h.

Constructor & Destructor Documentation

Marble::AnnotatePlugin::AnnotatePlugin ( const MarbleModel * model = 0 )

explicit

Definition at line 56 of file AnnotatePlugin.cpp.

Marble::AnnotatePlugin::~AnnotatePlugin ( )

virtual

Definition at line 91 of file AnnotatePlugin.cpp.

Member Function Documentation

const QList< QActionGroup * > * Marble::AnnotatePlugin::actionGroups ( ) const

virtual

Getting all actions.

This method is used by the main window to get all of the actions that this plugin defines. There is no guarantee where the main window will place the actions but it will generally be in a Menu. The returned QList should also contain all of the actions returned by

See also: toolbarActions().

Returns: a list of grouped actions

Reimplemented from Marble::RenderPlugin.

Definition at line 187 of file AnnotatePlugin.cpp.

void Marble::AnnotatePlugin::addOverlay ( )

slot

Definition at line 294 of file AnnotatePlugin.cpp.

QStringList Marble::AnnotatePlugin::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 101 of file AnnotatePlugin.cpp.

void Marble::AnnotatePlugin::clearAnnotations ( )

slot

Definition at line 378 of file AnnotatePlugin.cpp.

QString Marble::AnnotatePlugin::copyrightYears ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 141 of file AnnotatePlugin.cpp.

QString Marble::AnnotatePlugin::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 131 of file AnnotatePlugin.cpp.

void Marble::AnnotatePlugin::enableModel ( bool enabled )

slot

Definition at line 210 of file AnnotatePlugin.cpp.

bool Marble::AnnotatePlugin::eventFilter	(	QObject *	watched,
		QEvent *	event
	)

protectedvirtual

Reimplemented from Marble::RenderPlugin.

Definition at line 468 of file AnnotatePlugin.cpp.

QString Marble::AnnotatePlugin::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 121 of file AnnotatePlugin.cpp.

QIcon Marble::AnnotatePlugin::icon ( ) const

virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 153 of file AnnotatePlugin.cpp.

void Marble::AnnotatePlugin::initialize ( )

virtual

Implements Marble::RenderPluginInterface.

Definition at line 159 of file AnnotatePlugin.cpp.

bool Marble::AnnotatePlugin::isInitialized ( ) const

virtual

Implements Marble::RenderPluginInterface.

Definition at line 177 of file AnnotatePlugin.cpp.

void Marble::AnnotatePlugin::itemRemoved ( )

signal

void Marble::AnnotatePlugin::loadAnnotationFile ( )

slot

Definition at line 417 of file AnnotatePlugin.cpp.

QString Marble::AnnotatePlugin::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 116 of file AnnotatePlugin.cpp.

QString Marble::AnnotatePlugin::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 126 of file AnnotatePlugin.cpp.

void Marble::AnnotatePlugin::overlayAdded ( )

signal

void Marble::AnnotatePlugin::placemarkAdded ( )

signal

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

virtual

Implements Marble::PluginInterface.

Definition at line 146 of file AnnotatePlugin.cpp.

bool Marble::AnnotatePlugin::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 197 of file AnnotatePlugin.cpp.

QString Marble::AnnotatePlugin::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 106 of file AnnotatePlugin.cpp.

QStringList Marble::AnnotatePlugin::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 111 of file AnnotatePlugin.cpp.

QString Marble::AnnotatePlugin::runtimeTrace ( ) const

virtual

Returns a debug line for perfo/tracing issues.

Reimplemented from Marble::RenderPlugin.

Definition at line 182 of file AnnotatePlugin.cpp.

void Marble::AnnotatePlugin::saveAnnotationFile ( )

slot

Definition at line 400 of file AnnotatePlugin.cpp.

void Marble::AnnotatePlugin::setAddingOverlay ( bool enabled )

slot

Definition at line 273 of file AnnotatePlugin.cpp.

void Marble::AnnotatePlugin::setAddingPlacemark ( bool enabled )

slot

Definition at line 225 of file AnnotatePlugin.cpp.

void Marble::AnnotatePlugin::setAddingPolygonHole ( bool enabled )

slot

Definition at line 259 of file AnnotatePlugin.cpp.

void Marble::AnnotatePlugin::setDrawingPolygon ( bool enabled )

slot

Definition at line 230 of file AnnotatePlugin.cpp.

void Marble::AnnotatePlugin::setMergingNodes ( bool enabled )

slot

Definition at line 278 of file AnnotatePlugin.cpp.

void Marble::AnnotatePlugin::setRemovingItems ( bool enabled )

slot

Definition at line 289 of file AnnotatePlugin.cpp.

const QList< QActionGroup * > * Marble::AnnotatePlugin::toolbarActionGroups ( ) const

virtual

Getting all actions which should be placed in the toolbar.

This method returns a subset of the actions returned by

See also: actions() which are intended to be placed in a more prominent place such as a toolbar above the Marble Widget. You are not guaranteed that they will be in an actual toolbar but they will be visible and discoverable

Returns: a list of grouped toolbar actions

Reimplemented from Marble::RenderPlugin.

Definition at line 192 of file AnnotatePlugin.cpp.

QString Marble::AnnotatePlugin::version ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 136 of file AnnotatePlugin.cpp.

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

marble

Public Slots

Signals

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

marble

kdeedu API Reference

Search