Marble::PluginInterface Class Reference

#include <PluginInterface.h>

Inheritance diagram for Marble::PluginInterface:

Public Member Functions
virtual	~PluginInterface ()
virtual QString	aboutDataText () const
virtual QString	copyrightYears () const =0
virtual QString	description () const =0
virtual QIcon	icon () const =0
virtual QString	name () const =0
virtual QString	nameId () const =0
virtual QList< PluginAuthor >	pluginAuthors () const =0
virtual QString	version () const =0

Detailed Description

This class specifies interface of a Marble plugin.

Definition at line 45 of file PluginInterface.h.

Constructor & Destructor Documentation

Marble::PluginInterface::~PluginInterface ( )

virtual

Definition at line 16 of file PluginInterface.cpp.

Member Function Documentation

QString Marble::PluginInterface::aboutDataText ( ) const

virtual

Returns about text (credits) for external data the plugin uses.

The default implementation returns the empty string. Please override this method to give credits for all data from 3rd-partys.

Reimplemented in DeclarativeDataPlugin, Marble::WeatherPlugin, Marble::WikipediaPlugin, and Marble::SatellitesPlugin.

Definition at line 20 of file PluginInterface.cpp.

virtual QString Marble::PluginInterface::copyrightYears ( ) const

pure virtual

Implemented in Marble::StarsPlugin, Marble::GraticulePlugin, Marble::AnnotatePlugin, DeclarativeDataPlugin, Marble::CrosshairsPlugin, Marble::ElevationProfileFloatItem, Marble::EclipsesPlugin, Marble::OverviewMap, Marble::Speedometer, Marble::NavigationFloatItem, Marble::OpenCachingComPlugin, Marble::PositionMarker, Marble::AprsPlugin, Marble::GpsInfo, Marble::MeasureToolPlugin, Marble::ElevationProfileMarker, Marble::PhotoPlugin, Marble::CompassFloatItem, Marble::InhibitScreensaverPlugin, Marble::WeatherPlugin, Marble::RoutingPlugin, Marble::MapScaleFloatItem, Marble::EarthquakePlugin, Marble::SunPlugin, Marble::OpenDesktopPlugin, Marble::WikipediaPlugin, Marble::AtmospherePlugin, Marble::ProgressFloatItem, Marble::SatellitesPlugin, Marble::License, Marble::MonavPlugin, Marble::FoursquarePlugin, Marble::PostalCodePlugin, Marble::LocalOsmSearchPlugin, Marble::RoutinoPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::GpsdPositionProviderPlugin, Marble::GosmorePlugin, Marble::NominatimPlugin, Marble::NominatimPlugin, Marble::CycleStreetsPlugin, Marble::GosmorePlugin, Marble::HostipPlugin, Marble::LatLonPlugin, Marble::LocalDatabasePlugin, Marble::MapQuestPlugin, Marble::OSRMPlugin, Marble::OpenRouteServicePlugin, Marble::YoursPlugin, Marble::QtMobilityPositionProviderPlugin, Marble::RouteSimulationPositionProviderPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, Marble::JsonPlugin, Marble::FlightGearPositionProviderPlugin, Marble::CachePlugin, Marble::GpsbabelPlugin, Marble::GpxPlugin, Marble::KmlPlugin, Marble::LogfilePlugin, Marble::OsmPlugin, Marble::Pn2Plugin, Marble::PntPlugin, Marble::ShpPlugin, and Marble::PanoramioPlugin.

virtual QString Marble::PluginInterface::description ( ) const

pure virtual

Returns a user description of the plugin.

Implemented in Marble::StarsPlugin, Marble::GraticulePlugin, DeclarativeDataPlugin, Marble::AnnotatePlugin, Marble::CrosshairsPlugin, Marble::ElevationProfileFloatItem, Marble::FITemplateFloatItem, Marble::EclipsesPlugin, Marble::twitterPlugin, Marble::OverviewMap, Marble::NavigationFloatItem, Marble::OpenCachingComPlugin, Marble::PositionMarker, Marble::AprsPlugin, Marble::GpsInfo, Marble::Speedometer, Marble::MeasureToolPlugin, Marble::ElevationProfileMarker, Marble::PhotoPlugin, Marble::CompassFloatItem, Marble::InhibitScreensaverPlugin, Marble::WeatherPlugin, Marble::WikipediaPlugin, Marble::RoutingPlugin, Marble::MapScaleFloatItem, Marble::OpenCachingPlugin, Marble::EarthquakePlugin, Marble::SunPlugin, Marble::FileViewFloatItem, Marble::OpenDesktopPlugin, Marble::SatellitesPlugin, Marble::ProgressFloatItem, Marble::AtmospherePlugin, Marble::License, Marble::MonavPlugin, Marble::PanoramioPlugin, Marble::GeoCluePositionProviderPlugin, Marble::FoursquarePlugin, Marble::PostalCodePlugin, Marble::LocalOsmSearchPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::RoutinoPlugin, Marble::GpsdPositionProviderPlugin, Marble::GosmorePlugin, Marble::NominatimPlugin, Marble::NominatimPlugin, Marble::QtMobilityPositionProviderPlugin, Marble::RouteSimulationPositionProviderPlugin, Marble::CycleStreetsPlugin, Marble::GosmorePlugin, Marble::HostipPlugin, Marble::LatLonPlugin, Marble::LocalDatabasePlugin, Marble::MapQuestPlugin, Marble::OSRMPlugin, Marble::OpenRouteServicePlugin, Marble::YoursPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, Marble::FlightGearPositionProviderPlugin, Marble::JsonPlugin, Marble::CachePlugin, Marble::GpsbabelPlugin, Marble::GpxPlugin, Marble::KmlPlugin, Marble::LogfilePlugin, Marble::OsmPlugin, Marble::Pn2Plugin, Marble::PntPlugin, and Marble::ShpPlugin.

virtual QIcon Marble::PluginInterface::icon ( ) const

pure virtual

Returns an icon for the plugin.

Implemented in Marble::StarsPlugin, DeclarativeDataPlugin, Marble::GraticulePlugin, Marble::AnnotatePlugin, Marble::CrosshairsPlugin, Marble::ElevationProfileFloatItem, Marble::RoutingRunnerPlugin, Marble::FITemplateFloatItem, Marble::EclipsesPlugin, Marble::OverviewMap, Marble::ReverseGeocodingRunnerPlugin, Marble::NavigationFloatItem, Marble::OpenCachingComPlugin, Marble::PositionMarker, Marble::AprsPlugin, Marble::GpsInfo, Marble::Speedometer, Marble::twitterPlugin, Marble::SearchRunnerPlugin, Marble::MeasureToolPlugin, Marble::WeatherPlugin, Marble::ElevationProfileMarker, Marble::PhotoPlugin, Marble::CompassFloatItem, Marble::InhibitScreensaverPlugin, Marble::WikipediaPlugin, Marble::RoutingPlugin, Marble::ParseRunnerPlugin, Marble::MapScaleFloatItem, Marble::EarthquakePlugin, Marble::SunPlugin, Marble::OpenDesktopPlugin, Marble::ProgressFloatItem, Marble::OpenCachingPlugin, Marble::SatellitesPlugin, Marble::FileViewFloatItem, Marble::License, Marble::AtmospherePlugin, Marble::FoursquarePlugin, Marble::PostalCodePlugin, Marble::PanoramioPlugin, Marble::GeoCluePositionProviderPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::GpsdPositionProviderPlugin, Marble::QtMobilityPositionProviderPlugin, Marble::RouteSimulationPositionProviderPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, and Marble::FlightGearPositionProviderPlugin.

virtual QString Marble::PluginInterface::name ( ) const

pure 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"

Implemented in Marble::StarsPlugin, Marble::GraticulePlugin, Marble::AnnotatePlugin, Marble::FITemplateFloatItem, Marble::CrosshairsPlugin, Marble::EclipsesPlugin, Marble::ElevationProfileFloatItem, DeclarativeDataPlugin, Marble::twitterPlugin, Marble::AprsPlugin, Marble::OverviewMap, Marble::MeasureToolPlugin, Marble::NavigationFloatItem, Marble::OpenCachingComPlugin, Marble::PositionMarker, Marble::GpsInfo, Marble::Speedometer, Marble::OpenCachingPlugin, Marble::ElevationProfileMarker, Marble::PhotoPlugin, Marble::CompassFloatItem, Marble::InhibitScreensaverPlugin, Marble::SatellitesPlugin, Marble::WeatherPlugin, Marble::RoutingPlugin, Marble::FileViewFloatItem, Marble::MapScaleFloatItem, Marble::WikipediaPlugin, Marble::EarthquakePlugin, Marble::License, Marble::SunPlugin, Marble::OpenDesktopPlugin, Marble::ProgressFloatItem, Marble::AtmospherePlugin, Marble::GeoCluePositionProviderPlugin, Marble::PanoramioPlugin, Marble::MonavPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::GpsdPositionProviderPlugin, Marble::QtMobilityPositionProviderPlugin, Marble::RouteSimulationPositionProviderPlugin, Marble::FoursquarePlugin, Marble::PostalCodePlugin, Marble::LocalOsmSearchPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, Marble::RoutinoPlugin, Marble::FlightGearPositionProviderPlugin, Marble::GosmorePlugin, Marble::NominatimPlugin, Marble::NominatimPlugin, Marble::CycleStreetsPlugin, Marble::GosmorePlugin, Marble::HostipPlugin, Marble::LatLonPlugin, Marble::LocalDatabasePlugin, Marble::MapQuestPlugin, Marble::OSRMPlugin, Marble::OpenRouteServicePlugin, Marble::YoursPlugin, Marble::JsonPlugin, Marble::CachePlugin, Marble::GpsbabelPlugin, Marble::GpxPlugin, Marble::KmlPlugin, Marble::LogfilePlugin, Marble::OsmPlugin, Marble::Pn2Plugin, Marble::PntPlugin, and Marble::ShpPlugin.

virtual QString Marble::PluginInterface::nameId ( ) const

pure virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implemented in Marble::StarsPlugin, Marble::GraticulePlugin, Marble::AnnotatePlugin, Marble::FITemplateFloatItem, Marble::CrosshairsPlugin, DeclarativeDataPlugin, Marble::ElevationProfileFloatItem, Marble::EclipsesPlugin, Marble::twitterPlugin, Marble::OverviewMap, Marble::NavigationFloatItem, Marble::OpenCachingComPlugin, Marble::PositionMarker, Marble::AprsPlugin, Marble::GpsInfo, Marble::Speedometer, Marble::MeasureToolPlugin, Marble::ElevationProfileMarker, Marble::PhotoPlugin, Marble::CompassFloatItem, Marble::InhibitScreensaverPlugin, Marble::WeatherPlugin, Marble::RoutingPlugin, Marble::FileViewFloatItem, Marble::MapScaleFloatItem, Marble::WikipediaPlugin, Marble::EarthquakePlugin, Marble::SatellitesPlugin, Marble::SunPlugin, Marble::OpenDesktopPlugin, Marble::License, Marble::ProgressFloatItem, Marble::AtmospherePlugin, Marble::MonavPlugin, Marble::GeoCluePositionProviderPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::FoursquarePlugin, Marble::PostalCodePlugin, Marble::LocalOsmSearchPlugin, Marble::GpsdPositionProviderPlugin, Marble::RoutinoPlugin, Marble::QtMobilityPositionProviderPlugin, Marble::RouteSimulationPositionProviderPlugin, Marble::GosmorePlugin, Marble::NominatimPlugin, Marble::NominatimPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, Marble::CycleStreetsPlugin, Marble::GosmorePlugin, Marble::HostipPlugin, Marble::LatLonPlugin, Marble::LocalDatabasePlugin, Marble::MapQuestPlugin, Marble::OSRMPlugin, Marble::OpenRouteServicePlugin, Marble::YoursPlugin, Marble::FlightGearPositionProviderPlugin, Marble::JsonPlugin, Marble::PanoramioPlugin, Marble::CachePlugin, Marble::GpsbabelPlugin, Marble::GpxPlugin, Marble::KmlPlugin, Marble::LogfilePlugin, Marble::OsmPlugin, Marble::Pn2Plugin, Marble::PntPlugin, and Marble::ShpPlugin.

virtual QList<PluginAuthor> Marble::PluginInterface::pluginAuthors ( ) const

pure virtual

Implemented in Marble::StarsPlugin, Marble::GraticulePlugin, DeclarativeDataPlugin, Marble::AnnotatePlugin, Marble::CrosshairsPlugin, Marble::ElevationProfileFloatItem, Marble::EclipsesPlugin, Marble::OverviewMap, Marble::NavigationFloatItem, Marble::OpenCachingComPlugin, Marble::PositionMarker, Marble::AprsPlugin, Marble::GpsInfo, Marble::MeasureToolPlugin, Marble::Speedometer, Marble::ElevationProfileMarker, Marble::PhotoPlugin, Marble::CompassFloatItem, Marble::InhibitScreensaverPlugin, Marble::WeatherPlugin, Marble::RoutingPlugin, Marble::MapScaleFloatItem, Marble::WikipediaPlugin, Marble::EarthquakePlugin, Marble::SunPlugin, Marble::OpenDesktopPlugin, Marble::AtmospherePlugin, Marble::ProgressFloatItem, Marble::SatellitesPlugin, Marble::License, Marble::MonavPlugin, Marble::FoursquarePlugin, Marble::PostalCodePlugin, Marble::LocalOsmSearchPlugin, Marble::RoutinoPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::GosmorePlugin, Marble::NominatimPlugin, Marble::NominatimPlugin, Marble::GpsdPositionProviderPlugin, Marble::CycleStreetsPlugin, Marble::GosmorePlugin, Marble::HostipPlugin, Marble::LatLonPlugin, Marble::LocalDatabasePlugin, Marble::MapQuestPlugin, Marble::OSRMPlugin, Marble::OpenRouteServicePlugin, Marble::YoursPlugin, Marble::QtMobilityPositionProviderPlugin, Marble::RouteSimulationPositionProviderPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, Marble::JsonPlugin, Marble::CachePlugin, Marble::GpsbabelPlugin, Marble::GpxPlugin, Marble::KmlPlugin, Marble::LogfilePlugin, Marble::OsmPlugin, Marble::Pn2Plugin, Marble::PntPlugin, Marble::ShpPlugin, Marble::FlightGearPositionProviderPlugin, and Marble::PanoramioPlugin.

virtual QString Marble::PluginInterface::version ( ) const

pure virtual

Implemented in Marble::StarsPlugin, Marble::GraticulePlugin, Marble::AnnotatePlugin, DeclarativeDataPlugin, Marble::CrosshairsPlugin, Marble::ElevationProfileFloatItem, Marble::EclipsesPlugin, Marble::OverviewMap, Marble::NavigationFloatItem, Marble::OpenCachingComPlugin, Marble::PositionMarker, Marble::AprsPlugin, Marble::GpsInfo, Marble::Speedometer, Marble::MeasureToolPlugin, Marble::ElevationProfileMarker, Marble::PhotoPlugin, Marble::CompassFloatItem, Marble::InhibitScreensaverPlugin, Marble::WeatherPlugin, Marble::RoutingPlugin, Marble::MapScaleFloatItem, Marble::WikipediaPlugin, Marble::EarthquakePlugin, Marble::SatellitesPlugin, Marble::SunPlugin, Marble::OpenDesktopPlugin, Marble::ProgressFloatItem, Marble::License, Marble::AtmospherePlugin, Marble::MonavPlugin, Marble::PlacemarkPositionProviderPlugin, Marble::FoursquarePlugin, Marble::PostalCodePlugin, Marble::LocalOsmSearchPlugin, Marble::GpsdPositionProviderPlugin, Marble::RoutinoPlugin, Marble::QtMobilityPositionProviderPlugin, Marble::RouteSimulationPositionProviderPlugin, Marble::GosmorePlugin, Marble::NominatimPlugin, Marble::NominatimPlugin, Marble::MaemoPositionProviderPlugin, Marble::WlocatePositionProviderPlugin, Marble::CycleStreetsPlugin, Marble::GosmorePlugin, Marble::HostipPlugin, Marble::LatLonPlugin, Marble::LocalDatabasePlugin, Marble::MapQuestPlugin, Marble::OSRMPlugin, Marble::OpenRouteServicePlugin, Marble::YoursPlugin, Marble::FlightGearPositionProviderPlugin, Marble::JsonPlugin, Marble::PanoramioPlugin, Marble::CachePlugin, Marble::GpsbabelPlugin, Marble::GpxPlugin, Marble::KmlPlugin, Marble::LogfilePlugin, Marble::OsmPlugin, Marble::Pn2Plugin, Marble::PntPlugin, and Marble::ShpPlugin.

---

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

• PluginInterface.h
• PluginInterface.cpp