Marble::OpenDesktopPlugin Class Reference

#include <OpenDesktopPlugin.h>

Inheritance diagram for Marble::OpenDesktopPlugin:

Public Member Functions
	OpenDesktopPlugin ()
	OpenDesktopPlugin (const MarbleModel *marbleModel)
QDialog *	configDialog ()
QString	copyrightYears () const
QString	description () const
QString	guiString () const
QIcon	icon () const
virtual void	initialize ()
QString	name () const
QString	nameId () const
QList< PluginAuthor >	pluginAuthors () const
void	setSettings (const QHash< QString, QVariant > &settings)
QHash< QString, QVariant >	settings () const
QString	version () const
Public Member Functions inherited from Marble::AbstractDataPlugin
	AbstractDataPlugin (const MarbleModel *marbleModel)
virtual	~AbstractDataPlugin ()
QStringList	backendTypes () const
QObject *	favoritesModel ()
bool	isFavoriteItemsOnly () const
bool	isInitialized () 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 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 ()

Protected Member Functions
bool	eventFilter (QObject *object, QEvent *event)
Protected Member Functions inherited from Marble::RenderPlugin
bool	eventFilter (QObject *, QEvent *)

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)
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)
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

Detailed Description

Definition at line 25 of file OpenDesktopPlugin.h.

Constructor & Destructor Documentation

OpenDesktopPlugin::OpenDesktopPlugin

(

)

Definition at line 22 of file OpenDesktopPlugin.cpp.

OpenDesktopPlugin::OpenDesktopPlugin ( const MarbleModel *  marbleModel )

explicit

Definition at line 29 of file OpenDesktopPlugin.cpp.

Member Function Documentation

QDialog * OpenDesktopPlugin::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 85 of file OpenDesktopPlugin.cpp.

QString OpenDesktopPlugin::copyrightYears ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 69 of file OpenDesktopPlugin.cpp.

QString OpenDesktopPlugin::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 64 of file OpenDesktopPlugin.cpp.

bool OpenDesktopPlugin::eventFilter ( QObject *  object, QEvent *  event  )

protected

Definition at line 115 of file OpenDesktopPlugin.cpp.

QString OpenDesktopPlugin::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 49 of file OpenDesktopPlugin.cpp.

QIcon OpenDesktopPlugin::icon ( ) const

virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 80 of file OpenDesktopPlugin.cpp.

void OpenDesktopPlugin::initialize ( )

virtual

Implements Marble::RenderPluginInterface.

Definition at line 38 of file OpenDesktopPlugin.cpp.

QString OpenDesktopPlugin::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 44 of file OpenDesktopPlugin.cpp.

QString OpenDesktopPlugin::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 54 of file OpenDesktopPlugin.cpp.

QList< PluginAuthor > OpenDesktopPlugin::pluginAuthors ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 74 of file OpenDesktopPlugin.cpp.

void OpenDesktopPlugin::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 129 of file OpenDesktopPlugin.cpp.

QHash< QString, QVariant > OpenDesktopPlugin::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 106 of file OpenDesktopPlugin.cpp.

QString OpenDesktopPlugin::version ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 59 of file OpenDesktopPlugin.cpp.

---

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

• OpenDesktopPlugin.h
• OpenDesktopPlugin.cpp