Marble::SearchRunnerPlugin Class Reference

#include <SearchRunnerPlugin.h>

Inheritance diagram for Marble::SearchRunnerPlugin:

Public Member Functions
	SearchRunnerPlugin (QObject *parent=0)
virtual	~SearchRunnerPlugin ()
virtual bool	canWork () const
bool	canWorkOffline () const
virtual QString	guiString () const =0
virtual QIcon	icon () const
virtual SearchRunner *	newRunner () const =0
bool	supportsCelestialBody (const QString &celestialBodyId) 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	setSupportedCelestialBodies (const QStringList &celestialBodies)

Detailed Description

A plugin for Marble to execute a placemark search.

Definition at line 25 of file SearchRunnerPlugin.h.

Constructor & Destructor Documentation

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

explicit

Constructor with optional parent object.

Definition at line 34 of file SearchRunnerPlugin.cpp.

Marble::SearchRunnerPlugin::~SearchRunnerPlugin ( )

virtual

Destructor.

Definition at line 40 of file SearchRunnerPlugin.cpp.

Member Function Documentation

bool Marble::SearchRunnerPlugin::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::HostipPlugin.

Definition at line 74 of file SearchRunnerPlugin.cpp.

bool Marble::SearchRunnerPlugin::canWorkOffline

(

)

const

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

Definition at line 69 of file SearchRunnerPlugin.cpp.

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

pure virtual

Returns the string that should appear in the user interface.

For example, "Nominatim" should be returned for the Nominatim search plugin.

Implemented in Marble::LocalOsmSearchPlugin, Marble::NominatimPlugin, Marble::NominatimPlugin, Marble::HostipPlugin, Marble::LatLonPlugin, and Marble::LocalDatabasePlugin.

QIcon Marble::SearchRunnerPlugin::icon ( ) const

virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 45 of file SearchRunnerPlugin.cpp.

virtual SearchRunner* Marble::SearchRunnerPlugin::newRunner ( ) const

pure virtual

Plugin factory method to create a new runner instance.

Method caller gets ownership of the returned object

Implemented in Marble::LocalOsmSearchPlugin, Marble::NominatimPlugin, Marble::NominatimPlugin, Marble::HostipPlugin, Marble::LatLonPlugin, and Marble::LocalDatabasePlugin.

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

protected

Definition at line 64 of file SearchRunnerPlugin.cpp.

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

protected

Definition at line 59 of file SearchRunnerPlugin.cpp.

bool Marble::SearchRunnerPlugin::supportsCelestialBody

(

const QString &

celestialBodyId

)

const

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

Definition at line 50 of file SearchRunnerPlugin.cpp.

---

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

• SearchRunnerPlugin.h
• SearchRunnerPlugin.cpp