• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdeedu API Reference
  • KDE Home
  • Contact Us
 

marble

  • Marble
  • AprsPlugin
Public Member Functions | List of all members
Marble::AprsPlugin Class Reference

#include <AprsPlugin.h>

Inheritance diagram for Marble::AprsPlugin:
Inheritance graph
[legend]

Public Member Functions

 AprsPlugin ()
 
 AprsPlugin (const MarbleModel *marbleModel)
 
 ~AprsPlugin ()
 
QAction * action () const
 
QStringList backendTypes () const
 
QDialog * configDialog ()
 
QString copyrightYears () const
 
QString description () const
 
QString guiString () const
 
QIcon icon () const
 
void initialize ()
 
bool isInitialized () const
 
QString name () const
 
QString nameId () const
 
QList< PluginAuthor > pluginAuthors () const
 
bool render (GeoPainter *painter, ViewportParams *viewport, const QString &renderPos, GeoSceneLayer *layer=0)
 
QString renderPolicy () const
 
QStringList renderPosition () const
 
void restartGatherers ()
 
void setSettings (const QHash< QString, QVariant > &settings)
 
QHash< QString, QVariant > settings () const
 
void stopGatherers ()
 
QString version () const
 
- Public Member Functions inherited from Marble::RenderPlugin
 RenderPlugin (const MarbleModel *marbleModel)
 
virtual ~RenderPlugin ()
 
virtual const QList
< QActionGroup * > * 
actionGroups () const
 
bool enabled () const
 
bool isUserCheckable () const
 
const MarbleModel * marbleModel () const
 
virtual RenderPlugin * newInstance (const MarbleModel *marbleModel) const =0
 
virtual RenderType renderType () const
 
virtual QString runtimeTrace () const
 
virtual const QList
< QActionGroup * > * 
toolbarActionGroups () const
 
bool visible () const
 
- Public Member Functions inherited from Marble::RenderPluginInterface
virtual ~RenderPluginInterface ()
 
- Public Member Functions inherited from Marble::PluginInterface
virtual ~PluginInterface ()
 
virtual QString aboutDataText () const
 
- Public Member Functions inherited from Marble::LayerInterface
virtual ~LayerInterface ()
 
virtual qreal zValue () const
 
- Public Member Functions inherited from Marble::DialogConfigurationInterface
virtual ~DialogConfigurationInterface ()
 

Additional Inherited Members

- Public Types inherited from Marble::RenderPlugin
enum  RenderType {
  UnknownRenderType, TopLevelRenderType, PanelRenderType, OnlineRenderType,
  ThemeRenderType
}
 
- Public Slots inherited from Marble::RenderPlugin
QAction * action () const
 
void restoreDefaultSettings ()
 
void setEnabled (bool enabled)
 
bool setSetting (const QString &key, const QVariant &value)
 
QVariant setting (const QString &key)
 
QStringList settingKeys ()
 
void setUserCheckable (bool isUserCheckable)
 
void setVisible (bool visible)
 
- Signals inherited from Marble::RenderPlugin
void actionGroupsChanged ()
 
void enabledChanged (bool enable)
 
void repaintNeeded (QRegion dirtyRegion=QRegion())
 
void settingsChanged (QString nameId)
 
void userCheckableChanged (bool isUserCheckable)
 
void visibilityChanged (bool visible, const QString &nameId)
 
- Protected Member Functions inherited from Marble::RenderPlugin
bool eventFilter (QObject *, QEvent *)
 
- Properties inherited from Marble::RenderPlugin
QString description
 
bool enabled
 
QString name
 
QString nameId
 
bool userCheckable
 
QString version
 
bool visible
 

Detailed Description

This class displays a layer of aprs (which aprs TBD).

Definition at line 38 of file AprsPlugin.h.

Constructor & Destructor Documentation

AprsPlugin::AprsPlugin ( )

Definition at line 43 of file AprsPlugin.cpp.

AprsPlugin::AprsPlugin ( const MarbleModel *  marbleModel)
explicit

Definition at line 51 of file AprsPlugin.cpp.

AprsPlugin::~AprsPlugin ( )

Definition at line 88 of file AprsPlugin.cpp.

Member Function Documentation

QAction * AprsPlugin::action ( ) const

Definition at line 449 of file AprsPlugin.cpp.

QStringList AprsPlugin::backendTypes ( ) const
virtual

Returns the name(s) of the backend that the plugin can render This method should return the name of the backend that the plugin can render.

The string has to be the same one that is given for the attribute in the layer element of the DGML file that backend is able to process. Examples to replace available default backends would be "vector" or "texture". To provide a completely new kind of functionality please choose your own unique string.

Implements Marble::RenderPluginInterface.

Definition at line 120 of file AprsPlugin.cpp.

QDialog * AprsPlugin::configDialog ( )
virtual

Returns a pointer to the configuration dialog of the plugin.

Returns
: Pointer to the configuration dialog, which must be non-zero.

Implements Marble::DialogConfigurationInterface.

Definition at line 263 of file AprsPlugin.cpp.

QString AprsPlugin::copyrightYears ( ) const
virtual

Implements Marble::PluginInterface.

Definition at line 160 of file AprsPlugin.cpp.

QString AprsPlugin::description ( ) const
virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 155 of file AprsPlugin.cpp.

QString AprsPlugin::guiString ( ) const
virtual

String that should be displayed in GUI.

Using a "&" you can suggest key shortcuts

Example: "&Stars"

Returns
string for gui usage

Implements Marble::RenderPlugin.

Definition at line 140 of file AprsPlugin.cpp.

QIcon AprsPlugin::icon ( ) const
virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 171 of file AprsPlugin.cpp.

void AprsPlugin::initialize ( )
virtual

Implements Marble::RenderPluginInterface.

Definition at line 255 of file AprsPlugin.cpp.

bool AprsPlugin::isInitialized ( ) const
virtual

Implements Marble::RenderPluginInterface.

Definition at line 409 of file AprsPlugin.cpp.

QString AprsPlugin::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 135 of file AprsPlugin.cpp.

QString AprsPlugin::nameId ( ) const
virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 145 of file AprsPlugin.cpp.

QList< PluginAuthor > AprsPlugin::pluginAuthors ( ) const
virtual

Implements Marble::PluginInterface.

Definition at line 165 of file AprsPlugin.cpp.

bool AprsPlugin::render ( GeoPainter *  painter,
ViewportParams *  viewport,
const QString &  renderPos,
GeoSceneLayer *  layer = 0 
)
virtual

Renders the content provided by the layer on the viewport.

Parameters
painterpainter object allowing to paint on the map
viewportmetadata, such as current projection, screen dimension, etc.
renderPoscurrent render position
layerdeprecated, always zero (NULL)
Returns
true Returns whether the rendering has been successful

Implements Marble::LayerInterface.

Definition at line 414 of file AprsPlugin.cpp.

QString AprsPlugin::renderPolicy ( ) const
virtual

Return how the plugin settings should be used.

FIXME: Document this Possible Values: "ALWAYS" – the plugin renders at the preferred position no matter what got specified in the DGML file. "SPECIFIED" – renders only in case it got specified in the DGML file. "SPECIFIED_ALWAYS" – In case it got specified in the DGML file render according to the specification otherwise choose the preferred position

Implements Marble::RenderPluginInterface.

Definition at line 125 of file AprsPlugin.cpp.

QStringList AprsPlugin::renderPosition ( ) const
virtual

Preferred level in the layer stack for the rendering.

Gives a preferred level in the existing layer stack where the render() method of this plugin should get executed. Possible Values: "NONE" "STARS" "BEHIND_TARGET" "SURFACE" "HOVERS_ABOVE_SURFACE" "ATMOSPHERE" "ORBIT" "ALWAYS_ON_TOP" "FLOAT_ITEM" "USER_TOOLS"

Implements Marble::LayerInterface.

Definition at line 130 of file AprsPlugin.cpp.

void AprsPlugin::restartGatherers ( )

Definition at line 211 of file AprsPlugin.cpp.

void AprsPlugin::setSettings ( const QHash< QString, QVariant > &  settings)
virtual

Set the settings of the plugin.

Usually this is called at startup to restore saved settings.

Parameters
newplugin's settings
See also
settings

Reimplemented from Marble::RenderPlugin.

Definition at line 385 of file AprsPlugin.cpp.

QHash< QString, QVariant > AprsPlugin::settings ( ) const
virtual

Settings of the plugin.

Settings is the map (hash table) of plugin's settings This method is called to determine the current settings of the plugin for serialization, e.g. when closing the application.

Returns
plugin's settings
See also
setSettings

Reimplemented from Marble::RenderPlugin.

Definition at line 365 of file AprsPlugin.cpp.

void AprsPlugin::stopGatherers ( )

Definition at line 176 of file AprsPlugin.cpp.

QString AprsPlugin::version ( ) const
virtual

Implements Marble::PluginInterface.

Definition at line 150 of file AprsPlugin.cpp.


The documentation for this class was generated from the following files:
  • AprsPlugin.h
  • AprsPlugin.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:38:55 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

marble

Skip menu "marble"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdeedu API Reference

Skip menu "kdeedu API Reference"
  • Analitza
  •     lib
  • kalgebra
  • kalzium
  •   libscience
  • kanagram
  • kig
  •   lib
  • klettres
  • kstars
  • libkdeedu
  •   keduvocdocument
  • marble
  • parley
  • rocs
  •   App
  •   RocsCore
  •   VisualEditor
  •   stepcore

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal