Marble::OpenCachingComPlugin Class Reference

#include <OpenCachingComPlugin.h>

Inheritance diagram for Marble::OpenCachingComPlugin:

Public Member Functions
	OpenCachingComPlugin ()
	OpenCachingComPlugin (const MarbleModel *marbleModel)
QStringList	backendTypes () const
QDialog *	configDialog ()
QString	copyrightYears () const
QString	description () const
QString	guiString () const
QIcon	icon () const
virtual void	initialize ()
virtual bool	isInitialized () const
QString	name () const
QString	nameId () const
QList< PluginAuthor >	pluginAuthors () const
QString	version () const
Public Member Functions inherited from Marble::AbstractDataPlugin
	AbstractDataPlugin (const MarbleModel *marbleModel)
virtual	~AbstractDataPlugin ()
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 RenderPlugin *	newInstance (const MarbleModel *marbleModel) const =0
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 ()
virtual QString	aboutDataText () const
Public Member Functions inherited from Marble::LayerInterface
virtual	~LayerInterface ()
virtual qreal	zValue () const

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)
Protected Member Functions inherited from Marble::RenderPlugin
bool	eventFilter (QObject *, QEvent *)
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

Plugin to display geocaches from opencaching.com on the map.

Definition at line 33 of file OpenCachingComPlugin.h.

Constructor & Destructor Documentation

Marble::OpenCachingComPlugin::OpenCachingComPlugin

(

)

Definition at line 16 of file OpenCachingComPlugin.cpp.

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

explicit

Definition at line 21 of file OpenCachingComPlugin.cpp.

Member Function Documentation

QStringList Marble::OpenCachingComPlugin::backendTypes ( ) const

virtual

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

Reimplemented from Marble::AbstractDataPlugin.

Definition at line 42 of file OpenCachingComPlugin.cpp.

QDialog* Marble::OpenCachingComPlugin::configDialog

(

)

QString Marble::OpenCachingComPlugin::copyrightYears ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 72 of file OpenCachingComPlugin.cpp.

QString Marble::OpenCachingComPlugin::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 67 of file OpenCachingComPlugin.cpp.

QString Marble::OpenCachingComPlugin::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 52 of file OpenCachingComPlugin.cpp.

QIcon Marble::OpenCachingComPlugin::icon ( ) const

virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 83 of file OpenCachingComPlugin.cpp.

void Marble::OpenCachingComPlugin::initialize ( )

virtual

Implements Marble::RenderPluginInterface.

Definition at line 29 of file OpenCachingComPlugin.cpp.

bool Marble::OpenCachingComPlugin::isInitialized ( ) const

virtual

Reimplemented from Marble::AbstractDataPlugin.

Definition at line 37 of file OpenCachingComPlugin.cpp.

QString Marble::OpenCachingComPlugin::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 47 of file OpenCachingComPlugin.cpp.

QString Marble::OpenCachingComPlugin::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 57 of file OpenCachingComPlugin.cpp.

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

virtual

Implements Marble::PluginInterface.

Definition at line 77 of file OpenCachingComPlugin.cpp.

QString Marble::OpenCachingComPlugin::version ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 62 of file OpenCachingComPlugin.cpp.

---

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

• OpenCachingComPlugin.h
• OpenCachingComPlugin.cpp