Marble::PluginInterface

Search for usage in LXR

Marble::PluginInterface Class Referenceabstract

#include <PluginInterface.h>

Inheritance diagram for Marble::PluginInterface:

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 QVector< PluginAuthor > pluginAuthors () const =0
 
virtual QString version () const =0
 

Detailed Description

This class specifies interface of a Marble plugin.

Definition at line 46 of file PluginInterface.h.

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.

Definition at line 15 of file PluginInterface.cpp.

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

Returns a user description of the plugin.

virtual QIcon Marble::PluginInterface::icon ( ) const
pure virtual
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"

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

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

virtual QVector<PluginAuthor> Marble::PluginInterface::pluginAuthors ( ) const
pure virtual
Since
0.26.0

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Dec 7 2021 23:11:03 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.