Marble::RoutingRunnerPlugin Class Reference

#include <RoutingRunnerPlugin.h>

Inheritance diagram for Marble::RoutingRunnerPlugin:

Classes
class	ConfigWidget

Public Member Functions
	RoutingRunnerPlugin (QObject *parent=0)
virtual	~RoutingRunnerPlugin ()
virtual bool	canWork () const
bool	canWorkOffline () const
virtual ConfigWidget *	configWidget ()
virtual QString	guiString () const =0
virtual QIcon	icon () const
virtual RoutingRunner *	newRunner () const =0
QString	statusMessage () const
bool	supportsCelestialBody (const QString &celestialBodyId) const
virtual bool	supportsTemplate (RoutingProfilesModel::ProfileTemplate profileTemplate) const
virtual QHash< QString, QVariant >	templateSettings (RoutingProfilesModel::ProfileTemplate profileTemplate) const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const
Public Member Functions inherited from Marble::PluginInterface
virtual	~PluginInterface ()
virtual QString	aboutDataText () const
virtual QString	copyrightYears () const =0
virtual QString	description () const =0
virtual QString	name () const =0
virtual QString	nameId () const =0
virtual QList< PluginAuthor >	pluginAuthors () const =0
virtual QString	version () const =0

Protected Member Functions
void	setCanWorkOffline (bool canWorkOffline)
void	setStatusMessage (const QString &message)
void	setSupportedCelestialBodies (const QStringList &celestialBodies)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

A plugin for Marble to execute a routing task.

Definition at line 33 of file RoutingRunnerPlugin.h.

Constructor & Destructor Documentation

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

explicit

Constructor with optional parent object.

Definition at line 36 of file RoutingRunnerPlugin.cpp.

Marble::RoutingRunnerPlugin::~RoutingRunnerPlugin ( )

virtual

Destructor.

Definition at line 42 of file RoutingRunnerPlugin.cpp.

Member Function Documentation

bool Marble::RoutingRunnerPlugin::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 in Marble::MonavPlugin, Marble::RoutinoPlugin, Marble::GosmorePlugin, and Marble::GosmorePlugin.

Definition at line 76 of file RoutingRunnerPlugin.cpp.

bool Marble::RoutingRunnerPlugin::canWorkOffline

(

)

const

True if the plugin can execute its tasks without network access.

Definition at line 71 of file RoutingRunnerPlugin.cpp.

RoutingRunnerPlugin::ConfigWidget * Marble::RoutingRunnerPlugin::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 in Marble::MonavPlugin, Marble::RoutinoPlugin, Marble::CycleStreetsPlugin, Marble::MapQuestPlugin, and Marble::OpenRouteServicePlugin.

Definition at line 81 of file RoutingRunnerPlugin.cpp.

virtual QString Marble::RoutingRunnerPlugin::guiString ( ) const

pure virtual

Returns the string that should appear in the user interface.

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

Implemented in Marble::MonavPlugin, Marble::RoutinoPlugin, Marble::GosmorePlugin, Marble::CycleStreetsPlugin, Marble::GosmorePlugin, Marble::MapQuestPlugin, Marble::OSRMPlugin, Marble::OpenRouteServicePlugin, and Marble::YoursPlugin.

QIcon Marble::RoutingRunnerPlugin::icon ( ) const

virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 47 of file RoutingRunnerPlugin.cpp.

virtual RoutingRunner* Marble::RoutingRunnerPlugin::newRunner ( ) const

pure virtual

Plugin factory method to create a new runner instance.

Method caller gets ownership of the returned object

Implemented in Marble::MonavPlugin, Marble::RoutinoPlugin, Marble::GosmorePlugin, Marble::CycleStreetsPlugin, Marble::GosmorePlugin, Marble::MapQuestPlugin, Marble::OSRMPlugin, Marble::OpenRouteServicePlugin, and Marble::YoursPlugin.

void Marble::RoutingRunnerPlugin::setCanWorkOffline ( bool  canWorkOffline )

protected

Definition at line 66 of file RoutingRunnerPlugin.cpp.

void Marble::RoutingRunnerPlugin::setStatusMessage ( const QString &  message )

protected

Definition at line 101 of file RoutingRunnerPlugin.cpp.

void Marble::RoutingRunnerPlugin::setSupportedCelestialBodies ( const QStringList &  celestialBodies )

protected

Definition at line 61 of file RoutingRunnerPlugin.cpp.

QString Marble::RoutingRunnerPlugin::statusMessage

(

)

const

A status message showing whether the plugin will be able to deliver results.

Definition at line 96 of file RoutingRunnerPlugin.cpp.

bool Marble::RoutingRunnerPlugin::supportsCelestialBody

(

const QString &

celestialBodyId

)

const

True if the plugin supports its tasks on the given planet.

Definition at line 52 of file RoutingRunnerPlugin.cpp.

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

virtual

True if the plugin supports the given routing profile template.

Reimplemented in Marble::MonavPlugin, Marble::RoutinoPlugin, Marble::CycleStreetsPlugin, Marble::MapQuestPlugin, Marble::OpenRouteServicePlugin, Marble::GosmorePlugin, Marble::OSRMPlugin, and Marble::YoursPlugin.

Definition at line 86 of file RoutingRunnerPlugin.cpp.

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

virtual

Settings for the given routing profile template.

Reimplemented in Marble::MonavPlugin, Marble::RoutinoPlugin, Marble::MapQuestPlugin, and Marble::OpenRouteServicePlugin.

Definition at line 91 of file RoutingRunnerPlugin.cpp.

---

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

• RoutingRunnerPlugin.h
• RoutingRunnerPlugin.cpp