#include <RoutinoPlugin.h>

Inheritance diagram for Marble::RoutinoPlugin:

Public Member Functions
	RoutinoPlugin (QObject *parent=0)

virtual bool	canWork () const

ConfigWidget *	configWidget ()

QString	copyrightYears () const

QString	description () const

QString	guiString () const

QString	name () const

QString	nameId () const

virtual RoutingRunner *	newRunner () const

QList< PluginAuthor >	pluginAuthors () const

bool	supportsTemplate (RoutingProfilesModel::ProfileTemplate profileTemplate) const

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 RoutinoPlugin.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 20 of file RoutinoPlugin.cpp.

Member Function Documentation

bool Marble::RoutinoPlugin::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 166 of file RoutinoPlugin.cpp.

RoutingRunnerPlugin::ConfigWidget * Marble::RoutinoPlugin::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 122 of file RoutinoPlugin.cpp.

QString Marble::RoutinoPlugin::copyrightYears ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 52 of file RoutinoPlugin.cpp.

QString Marble::RoutinoPlugin::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 47 of file RoutinoPlugin.cpp.

QString Marble::RoutinoPlugin::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 32 of file RoutinoPlugin.cpp.

QString Marble::RoutinoPlugin::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 27 of file RoutinoPlugin.cpp.

QString Marble::RoutinoPlugin::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 37 of file RoutinoPlugin.cpp.

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

virtual

Plugin factory method to create a new runner instance.