DeclarativeDataPlugin Class Reference

#include <DeclarativeDataPlugin.h>

Inheritance diagram for DeclarativeDataPlugin:

Signals
void	aboutDataTextChanged ()
void	authorsChanged ()
void	copyrightYearsChanged ()
void	dataRequest (qreal north, qreal south, qreal east, qreal west)
void	declarativeModelChanged ()
void	delegateChanged ()
void	descriptionChanged ()
void	guiStringChanged ()
void	nameChanged ()
void	nameIdChanged ()
void	planetChanged ()
void	versionChanged ()
Signals inherited from Marble::AbstractDataPlugin
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
	DeclarativeDataPlugin (const Marble::MarbleModel *marbleModel=0)
virtual	~DeclarativeDataPlugin ()
virtual QString	aboutDataText () const
QStringList	authors () const
virtual QString	copyrightYears () const
QVariant	declarativeModel ()
QDeclarativeComponent *	delegate ()
virtual QString	description () const
virtual QString	guiString () const
virtual QIcon	icon () const
virtual void	initialize ()
virtual bool	isInitialized () const
QString	name () const
virtual QString	nameId () const
Marble::RenderPlugin *	newInstance (const Marble::MarbleModel *marbleModel) const
QString	planet () const
virtual QList < Marble::PluginAuthor >	pluginAuthors () const
void	setAboutDataText (const QString &aboutDataText)
void	setAuthors (const QStringList &pluginAuthors)
void	setCopyrightYears (const QString &copyrightYears)
void	setDeclarativeModel (const QVariant &model)
void	setDelegate (QDeclarativeComponent *delegate)
void	setDescription (const QString description)
void	setGuiString (const QString &guiString)
void	setName (const QString &name)
void	setNameId (const QString &nameId)
void	setPlanet (const QString &planet)
void	setVersion (const QString &version)
virtual QString	version () const
Public Member Functions inherited from Marble::AbstractDataPlugin
	AbstractDataPlugin (const MarbleModel *marbleModel)
virtual	~AbstractDataPlugin ()
QStringList	backendTypes () const
QObject *	favoritesModel ()
bool	isFavoriteItemsOnly () 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
bool	isUserCheckable () const
const MarbleModel *	marbleModel () 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 Marble::RenderPluginInterface
virtual	~RenderPluginInterface ()
Public Member Functions inherited from Marble::PluginInterface
virtual	~PluginInterface ()
Public Member Functions inherited from Marble::LayerInterface
virtual	~LayerInterface ()
virtual qreal	zValue () const

Properties
QString	aboutDataText
QString	copyrightYears
QDeclarativeComponent	delegate
QString	description
QString	guiString
QVariant	model
QString	name
QString	nameId
QString	planet
QStringList	pluginAuthors
QString	version
Properties inherited from Marble::AbstractDataPlugin
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

Additional Inherited Members
Public Types inherited from Marble::RenderPlugin
enum	RenderType {   UnknownRenderType, TopLevelRenderType, PanelRenderType, OnlineRenderType,   ThemeRenderType }
Public Slots inherited from Marble::AbstractDataPlugin
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)
QStringList	settingKeys ()
void	setUserCheckable (bool isUserCheckable)
void	setVisible (bool visible)
Protected Member Functions inherited from Marble::RenderPlugin
bool	eventFilter (QObject *, QEvent *)

Detailed Description

Definition at line 25 of file DeclarativeDataPlugin.h.

Constructor & Destructor Documentation

DeclarativeDataPlugin::DeclarativeDataPlugin ( const Marble::MarbleModel *  marbleModel = 0 )

explicit

Definition at line 187 of file DeclarativeDataPlugin.cpp.

DeclarativeDataPlugin::~DeclarativeDataPlugin ( )

virtual

Definition at line 194 of file DeclarativeDataPlugin.cpp.

Member Function Documentation

virtual QString DeclarativeDataPlugin::aboutDataText ( ) const

virtual

Returns about text (credits) for external data the plugin uses.

The default implementation returns the empty string. Please override this method to give credits for all data from 3rd-partys.

Reimplemented from Marble::PluginInterface.

void DeclarativeDataPlugin::aboutDataTextChanged ( )

signal

QStringList DeclarativeDataPlugin::authors

(

)

const

Definition at line 247 of file DeclarativeDataPlugin.cpp.

void DeclarativeDataPlugin::authorsChanged ( )

signal

virtual QString DeclarativeDataPlugin::copyrightYears ( ) const

virtual

Implements Marble::PluginInterface.

void DeclarativeDataPlugin::copyrightYearsChanged ( )

signal

void DeclarativeDataPlugin::dataRequest ( qreal  north, qreal  south, qreal  east, qreal  west  )

signal

Additional data for the currently visible map region is requested.

QVariant DeclarativeDataPlugin::declarativeModel

(

)

Definition at line 382 of file DeclarativeDataPlugin.cpp.

void DeclarativeDataPlugin::declarativeModelChanged ( )

signal

QDeclarativeComponent* DeclarativeDataPlugin::delegate

(

)

void DeclarativeDataPlugin::delegateChanged ( )

signal

virtual QString DeclarativeDataPlugin::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

void DeclarativeDataPlugin::descriptionChanged ( )

signal

virtual QString DeclarativeDataPlugin::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.

void DeclarativeDataPlugin::guiStringChanged ( )

signal

QIcon DeclarativeDataPlugin::icon ( ) const

virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 261 of file DeclarativeDataPlugin.cpp.

void DeclarativeDataPlugin::initialize ( )

virtual

Implements Marble::RenderPluginInterface.

Definition at line 348 of file DeclarativeDataPlugin.cpp.

bool DeclarativeDataPlugin::isInitialized ( ) const

virtual

Reimplemented from Marble::AbstractDataPlugin.

Definition at line 356 of file DeclarativeDataPlugin.cpp.

QString DeclarativeDataPlugin::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.

void DeclarativeDataPlugin::nameChanged ( )

signal

virtual QString DeclarativeDataPlugin::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

void DeclarativeDataPlugin::nameIdChanged ( )

signal

Marble::RenderPlugin * DeclarativeDataPlugin::newInstance ( const Marble::MarbleModel *  marbleModel ) const

virtual

Creation a new instance of the plugin.

This method is used to create a new object of the current plugin using the marbleModel given.

Parameters

marbleModel

base model

Returns

new instance of current plugin

Note

Typically this method is implemented with the help of the MARBLE_PLUGIN() macro.

Implements Marble::RenderPlugin.

Definition at line 159 of file DeclarativeDataPlugin.cpp.

QString DeclarativeDataPlugin::planet

(

)

const

void DeclarativeDataPlugin::planetChanged ( )

signal

virtual QList<Marble::PluginAuthor> DeclarativeDataPlugin::pluginAuthors ( ) const

virtual

Implements Marble::PluginInterface.

void DeclarativeDataPlugin::setAboutDataText

(

const QString &

aboutDataText

)

Definition at line 327 of file DeclarativeDataPlugin.cpp.

void DeclarativeDataPlugin::setAuthors

(

const QStringList &

pluginAuthors

)

Definition at line 314 of file DeclarativeDataPlugin.cpp.

void DeclarativeDataPlugin::setCopyrightYears

(

const QString &

copyrightYears

)

Definition at line 298 of file DeclarativeDataPlugin.cpp.

void DeclarativeDataPlugin::setDeclarativeModel

(

const QVariant &

model

)

Todo:

: Listen for and reflect changes to the items in the model

Definition at line 361 of file DeclarativeDataPlugin.cpp.

void DeclarativeDataPlugin::setDelegate

(

QDeclarativeComponent *

delegate

)

Definition at line 340 of file DeclarativeDataPlugin.cpp.

void DeclarativeDataPlugin::setDescription

(

const QString

description

)

Definition at line 306 of file DeclarativeDataPlugin.cpp.

void DeclarativeDataPlugin::setGuiString

(

const QString &

guiString

)

Definition at line 274 of file DeclarativeDataPlugin.cpp.

void DeclarativeDataPlugin::setName

(

const QString &

name

)

Definition at line 266 of file DeclarativeDataPlugin.cpp.

void DeclarativeDataPlugin::setNameId

(

const QString &

nameId

)

Definition at line 282 of file DeclarativeDataPlugin.cpp.

void DeclarativeDataPlugin::setPlanet

(

const QString &

planet

)

Definition at line 204 of file DeclarativeDataPlugin.cpp.

void DeclarativeDataPlugin::setVersion

(

const QString &

version

)

Definition at line 290 of file DeclarativeDataPlugin.cpp.

virtual QString DeclarativeDataPlugin::version ( ) const

virtual

Implements Marble::PluginInterface.

void DeclarativeDataPlugin::versionChanged ( )

signal

Property Documentation

QString DeclarativeDataPlugin::aboutDataText

readwrite

Definition at line 38 of file DeclarativeDataPlugin.h.

QString DeclarativeDataPlugin::copyrightYears

readwrite

Definition at line 35 of file DeclarativeDataPlugin.h.

QQmlComponent * DeclarativeDataPlugin::delegate

readwrite

Definition at line 41 of file DeclarativeDataPlugin.h.

QString DeclarativeDataPlugin::description

readwrite

Definition at line 36 of file DeclarativeDataPlugin.h.

QString DeclarativeDataPlugin::guiString

readwrite

Definition at line 33 of file DeclarativeDataPlugin.h.

QVariant DeclarativeDataPlugin::model

readwrite

Definition at line 39 of file DeclarativeDataPlugin.h.

QString DeclarativeDataPlugin::name

readwrite

Definition at line 31 of file DeclarativeDataPlugin.h.

QString DeclarativeDataPlugin::nameId

readwrite

Definition at line 32 of file DeclarativeDataPlugin.h.

QString DeclarativeDataPlugin::planet

readwrite

Definition at line 30 of file DeclarativeDataPlugin.h.

QList< PluginAuthor > DeclarativeDataPlugin::pluginAuthors

readwrite

Definition at line 37 of file DeclarativeDataPlugin.h.

QString DeclarativeDataPlugin::version

readwrite

Definition at line 34 of file DeclarativeDataPlugin.h.

---

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

• DeclarativeDataPlugin.h
• DeclarativeDataPlugin.cpp