#include <AbstractDataPlugin.h>

Inheritance diagram for Marble::AbstractDataPlugin:

Public Slots
void	handleViewportChange (const ViewportParams *viewport)

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	changedNumberOfItems (quint32 number)

void	favoriteItemsOnlyChanged ()

void	favoritesModelChanged ()

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
	AbstractDataPlugin (const MarbleModel *marbleModel)

virtual	~AbstractDataPlugin ()

QStringList	backendTypes () const

QObject *	favoritesModel ()

bool	isFavoriteItemsOnly () const

bool	isInitialized () const

AbstractDataPluginModel *	model ()

const AbstractDataPluginModel *	model () const

quint32	numberOfItems () const

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

QString	renderPolicy () const

QStringList	renderPosition () const

virtual RenderType	renderType () const

void	setDelegate (QDeclarativeComponent delegate, QGraphicsItem parent)

void	setFavoriteItemsOnly (bool favoriteOnly)

void	setModel (AbstractDataPluginModel *model)

void	setNumberOfItems (quint32 number)

QList< AbstractDataPluginItem * >	whichItemAt (const QPoint &curpos)

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

virtual	~RenderPlugin ()

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

bool	enabled () const

virtual QString	guiString () const =0

bool	isUserCheckable () const

const MarbleModel *	marbleModel () const

virtual RenderPlugin *	newInstance (const MarbleModel *marbleModel) const =0

RenderState	renderState () 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 ()

virtual void	initialize ()=0

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

virtual QString	aboutDataText () const

virtual QString	copyrightYears () const =0

virtual QString	description () const =0

virtual QIcon	icon () const =0

virtual QString	name () const =0

virtual QString	nameId () const =0

virtual QList< PluginAuthor >	pluginAuthors () const =0

virtual QString	version () const =0

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

virtual qreal	zValue () const

Properties
bool	favoriteItemsOnly

QObject	favoritesModel

int	numberOfItems

Properties inherited from Marble::RenderPlugin
QString	description

bool	enabled

QString	name

QString	nameId

bool	userCheckable

QString	version

bool	visible

Properties inherited from QObject
	objectName

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)

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)

Detailed Description

An abstract class for plugins that show data that has a geo coordinate.

This is the abstract class for plugins that show data on Marble map. It takes care of painting all items it gets from the corresponding AbstractDataPluginModel that has to be set on initialisation.

The user has to set the nameId as well as the number of items to fetch. Additionally it should be useful to set standard values via setEnabled (often true) and setVisible (often false) in the constructor of a subclass.

Definition at line 45 of file AbstractDataPlugin.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 69 of file AbstractDataPlugin.cpp.

Marble::AbstractDataPlugin::~AbstractDataPlugin ( )

virtual

Definition at line 76 of file AbstractDataPlugin.cpp.

Member Function Documentation

QStringList Marble::AbstractDataPlugin::backendTypes ( ) const

virtual

Returns the name(s) of the backend that the plugin can render.

Implements Marble::RenderPluginInterface.

Reimplemented in Marble::OpenCachingComPlugin.

Definition at line 86 of file AbstractDataPlugin.cpp.

void Marble::AbstractDataPlugin::changedNumberOfItems ( quint32 number )

signal

void Marble::AbstractDataPlugin::favoriteItemsOnlyChanged ( )

signal

QObject* Marble::AbstractDataPlugin::favoritesModel ( )

void Marble::AbstractDataPlugin::favoritesModelChanged ( )

signal

void Marble::AbstractDataPlugin::handleViewportChange ( const ViewportParams * viewport )

slot

Definition at line 206 of file AbstractDataPlugin.cpp.

bool Marble::AbstractDataPlugin::isFavoriteItemsOnly ( ) const

Definition at line 196 of file AbstractDataPlugin.cpp.

bool Marble::AbstractDataPlugin::isInitialized ( ) const

virtual

Implements Marble::RenderPluginInterface.

Reimplemented in DeclarativeDataPlugin, Marble::OpenCachingComPlugin, and Marble::OpenCachingPlugin.

Definition at line 81 of file AbstractDataPlugin.cpp.

AbstractDataPluginModel * Marble::AbstractDataPlugin::model ( )

Returns: The model associated with the plugin.

Definition at line 124 of file AbstractDataPlugin.cpp.

const AbstractDataPluginModel * Marble::AbstractDataPlugin::model ( ) const

Definition at line 129 of file AbstractDataPlugin.cpp.

quint32 Marble::AbstractDataPlugin::numberOfItems ( ) const

Returns: The number of items to be shown at the same time.

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

virtual

Renders the content provided by the plugin on the viewport.

Returns: true Returns whether the rendering has been successful

Implements Marble::LayerInterface.

Definition at line 101 of file AbstractDataPlugin.cpp.

QString Marble::AbstractDataPlugin::renderPolicy ( ) const

virtual

Return how the plugin settings should be used.

Implements Marble::RenderPluginInterface.

Definition at line 91 of file AbstractDataPlugin.cpp.

QStringList Marble::AbstractDataPlugin::renderPosition ( ) const

virtual

Preferred level in the layer stack for the rendering.

Implements Marble::LayerInterface.

Definition at line 96 of file AbstractDataPlugin.cpp.

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

virtual

Function for returning the type of plugin this is for.

This affects where in the menu tree the action() is placed.

Returns: : The type of render plugin this is.

Reimplemented from Marble::RenderPlugin.

Definition at line 175 of file AbstractDataPlugin.cpp.

void Marble::AbstractDataPlugin::setDelegate	(	QDeclarativeComponent *	delegate,
		QGraphicsItem *	parent
	)

Definition at line 180 of file AbstractDataPlugin.cpp.

void Marble::AbstractDataPlugin::setFavoriteItemsOnly ( bool favoriteOnly )

Convenience method to set the favorite item state on the current model.

Definition at line 189 of file AbstractDataPlugin.cpp.

void Marble::AbstractDataPlugin::setModel ( AbstractDataPluginModel * model )

Set the model of the plugin.

Definition at line 134 of file AbstractDataPlugin.cpp.

void Marble::AbstractDataPlugin::setNumberOfItems ( quint32 number )

Set the number of items to be shown at the same time.

Definition at line 156 of file AbstractDataPlugin.cpp.

QList< AbstractDataPluginItem * > Marble::AbstractDataPlugin::whichItemAt ( const QPoint & curpos )

This function returns all items at the position curpos.

Depending on where they have been painted the last time.

Returns: The items at the given position.

Definition at line 165 of file AbstractDataPlugin.cpp.

Property Documentation

bool Marble::AbstractDataPlugin::favoriteItemsOnly

readwrite

Definition at line 49 of file AbstractDataPlugin.h.

QObject * Marble::AbstractDataPlugin::favoritesModel

read

Todo:: FIXME Qt Quick segfaults if using the real class here instead of QObject

Definition at line 51 of file AbstractDataPlugin.h.

quint32 Marble::AbstractDataPlugin::numberOfItems

readwrite

Definition at line 52 of file AbstractDataPlugin.h.

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

marble

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation

marble

kdeedu API Reference

Search