Marble::MonavPlugin Class Reference

#include <MonavPlugin.h>

Inheritance diagram for Marble::MonavPlugin:

Public Types
enum	MonavRoutingDaemonVersion { Monav_0_2, Monav_0_3 }

Public Member Functions
	MonavPlugin (QObject *parent=0)
	~MonavPlugin ()
virtual bool	canWork () const
virtual ConfigWidget *	configWidget ()
QString	copyrightYears () const
QString	description () const
QString	guiString () const
MonavMapsModel *	installedMapsModel ()
QStringList	mapDirectoriesForRequest (const RouteRequest *request) const
QString	mapDirectoryForRequest (const RouteRequest *request) const
MonavRoutingDaemonVersion	monavVersion () const
QString	name () const
QString	nameId () const
virtual RoutingRunner *	newRunner () const
QList< PluginAuthor >	pluginAuthors () const
void	reloadMaps ()
virtual bool	supportsTemplate (RoutingProfilesModel::ProfileTemplate profileTemplate) const
virtual QHash< QString, QVariant >	templateSettings (RoutingProfilesModel::ProfileTemplate profileTemplate) const
QString	version () const
Public Member Functions inherited from Marble::RoutingRunnerPlugin
	RoutingRunnerPlugin (QObject *parent=0)
virtual	~RoutingRunnerPlugin ()
bool	canWorkOffline () const
virtual QIcon	icon () const
QString	statusMessage () const
bool	supportsCelestialBody (const QString &celestialBodyId) const
Public Member Functions inherited from Marble::PluginInterface
virtual	~PluginInterface ()
virtual QString	aboutDataText () const

Additional Inherited Members
Protected Member Functions inherited from Marble::RoutingRunnerPlugin
void	setCanWorkOffline (bool canWorkOffline)
void	setStatusMessage (const QString &message)
void	setSupportedCelestialBodies (const QStringList &celestialBodies)

Detailed Description

Definition at line 23 of file MonavPlugin.h.

Member Enumeration Documentation

enum Marble::MonavPlugin::MonavRoutingDaemonVersion

Enumerator
Monav_0_2
Monav_0_3

Definition at line 30 of file MonavPlugin.h.

Constructor & Destructor Documentation

Marble::MonavPlugin::MonavPlugin ( QObject *  parent = 0 )

explicit

Definition at line 221 of file MonavPlugin.cpp.

Marble::MonavPlugin::~MonavPlugin

(

)

Definition at line 240 of file MonavPlugin.cpp.

Member Function Documentation

bool Marble::MonavPlugin::canWork ( ) const

virtual

Returns.

true 

if the plugin is able to perform its claimed task.

The default implementation returns

true 

. This method can be overridden for example to indicate an incomplete installation.

Reimplemented from Marble::RoutingRunnerPlugin.

Definition at line 371 of file MonavPlugin.cpp.

RoutingRunnerPlugin::ConfigWidget * Marble::MonavPlugin::configWidget ( )

virtual

Method for getting a pointer to the configuration widget of the plugin.

Returns

The configuration widget or, if no configuration widget exists, 0.

Reimplemented from Marble::RoutingRunnerPlugin.

Definition at line 354 of file MonavPlugin.cpp.

QString Marble::MonavPlugin::copyrightYears ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 270 of file MonavPlugin.cpp.

QString Marble::MonavPlugin::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 265 of file MonavPlugin.cpp.

QString Marble::MonavPlugin::guiString ( ) const

virtual

Returns the string that should appear in the user interface.

For example, "OpenRouteService" should be returned for the OpenRouteService routing plugin.

Implements Marble::RoutingRunnerPlugin.

Definition at line 250 of file MonavPlugin.cpp.

MonavMapsModel * Marble::MonavPlugin::installedMapsModel

(

)

Definition at line 359 of file MonavPlugin.cpp.

QStringList Marble::MonavPlugin::mapDirectoriesForRequest

(

const RouteRequest *

request

)

const

Definition at line 325 of file MonavPlugin.cpp.

QString Marble::MonavPlugin::mapDirectoryForRequest

(

const RouteRequest *

request

)

const

Definition at line 291 of file MonavPlugin.cpp.

MonavPlugin::MonavRoutingDaemonVersion Marble::MonavPlugin::monavVersion

(

)

const

Definition at line 409 of file MonavPlugin.cpp.

QString Marble::MonavPlugin::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 245 of file MonavPlugin.cpp.

QString Marble::MonavPlugin::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 255 of file MonavPlugin.cpp.

RoutingRunner * Marble::MonavPlugin::newRunner ( ) const

virtual

Plugin factory method to create a new runner instance.

Method caller gets ownership of the returned object

Implements Marble::RoutingRunnerPlugin.

Definition at line 281 of file MonavPlugin.cpp.

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

virtual

Implements Marble::PluginInterface.

Definition at line 275 of file MonavPlugin.cpp.

void Marble::MonavPlugin::reloadMaps

(

)

Definition at line 365 of file MonavPlugin.cpp.

bool Marble::MonavPlugin::supportsTemplate ( RoutingProfilesModel::ProfileTemplate  profileTemplate ) const

virtual

True if the plugin supports the given routing profile template.

Reimplemented from Marble::RoutingRunnerPlugin.

Definition at line 377 of file MonavPlugin.cpp.

QHash< QString, QVariant > Marble::MonavPlugin::templateSettings ( RoutingProfilesModel::ProfileTemplate  profileTemplate ) const

virtual

Settings for the given routing profile template.

Reimplemented from Marble::RoutingRunnerPlugin.

Definition at line 384 of file MonavPlugin.cpp.

QString Marble::MonavPlugin::version ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 260 of file MonavPlugin.cpp.

---

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

• MonavPlugin.h
• MonavPlugin.cpp