Marble::PluginInterface
#include <PluginInterface.h>
Public Member Functions | |
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.
Member Function Documentation
◆ aboutDataText()
|
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.
Definition at line 13 of file PluginInterface.cpp.
◆ description()
|
pure virtual |
Returns a user description of the plugin.
◆ icon()
|
pure virtual |
Returns an icon for the plugin.
Implemented in Marble::ParseRunnerPlugin, Marble::ReverseGeocodingRunnerPlugin, Marble::RoutingRunnerPlugin, and Marble::SearchRunnerPlugin.
◆ name()
|
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"
◆ nameId()
|
pure virtual |
Returns the unique name of the plugin.
Examples: "starrysky", "openrouteservice"
◆ pluginAuthors()
|
pure virtual |
- Since
- 0.26.0
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:04:15 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.