#include <HostipPlugin.h>

Inheritance diagram for Marble::HostipPlugin:

Public Member Functions
	HostipPlugin (QObject *parent=0)

bool	canWork () const

QString	copyrightYears () const

QString	description () const

QString	guiString () const

QString	name () const

QString	nameId () const

virtual SearchRunner *	newRunner () const

QList< PluginAuthor >	pluginAuthors () const

QString	version () const

Public Member Functions inherited from Marble::SearchRunnerPlugin
	SearchRunnerPlugin (QObject *parent=0)

virtual	~SearchRunnerPlugin ()

bool	canWorkOffline () const

virtual QIcon	icon () 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::SearchRunnerPlugin
void	setCanWorkOffline (bool canWorkOffline)

void	setSupportedCelestialBodies (const QStringList &celestialBodies)

Detailed Description

Definition at line 20 of file HostipPlugin.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 18 of file HostipPlugin.cpp.

Member Function Documentation

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

Definition at line 66 of file HostipPlugin.cpp.

QString Marble::HostipPlugin::copyrightYears ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 50 of file HostipPlugin.cpp.

QString Marble::HostipPlugin::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 45 of file HostipPlugin.cpp.

QString Marble::HostipPlugin::guiString ( ) const

virtual

Returns the string that should appear in the user interface.

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

Implements Marble::SearchRunnerPlugin.

Definition at line 30 of file HostipPlugin.cpp.

QString Marble::HostipPlugin::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 25 of file HostipPlugin.cpp.

QString Marble::HostipPlugin::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 35 of file HostipPlugin.cpp.

SearchRunner * Marble::HostipPlugin::newRunner ( ) const

virtual

Plugin factory method to create a new runner instance.