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

marble

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

#include <RoutingPlugin.h>

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

Public Member Functions

 RoutingPlugin ()
 
 RoutingPlugin (const MarbleModel *marbleModel)
 
 ~RoutingPlugin ()
 
QStringList backendTypes () const
 
QDialog * configDialog ()
 
QString copyrightYears () const
 
QString description () const
 
bool eventFilter (QObject *object, QEvent *event)
 
QString guiString () const
 
QIcon icon () const
 
void initialize ()
 
bool isInitialized () const
 
QString name () const
 
QString nameId () const
 
QList< PluginAuthor > pluginAuthors () const
 
virtual void setSettings (const QHash< QString, QVariant > &settings)
 
virtual QHash< QString, QVariant > settings () const
 
QString version () const
 
- Public Member Functions inherited from Marble::AbstractFloatItem
 AbstractFloatItem (const MarbleModel *marbleModel, const QPointF &point=QPointF(10.0, 10.0), const QSizeF &size=QSizeF(150.0, 50.0))
 
virtual ~AbstractFloatItem ()
 
QFont font () const
 
QPen pen () const
 
bool positionLocked () const
 
bool render (GeoPainter *painter, ViewportParams *viewport, const QString &renderPos="FLOAT_ITEM", GeoSceneLayer *layer=0)
 
virtual QString renderPolicy () const
 
virtual QStringList renderPosition () const
 
virtual RenderType renderType () const
 
void setFont (const QFont &font)
 
void setPen (const QPen &pen)
 
void setVisible (bool visible)
 
bool visible () 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 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::FrameGraphicsItem
 FrameGraphicsItem (MarbleGraphicsItem *parent=0)
 
virtual ~FrameGraphicsItem ()
 
QBrush background () const
 
QBrush borderBrush () const
 
Qt::PenStyle borderStyle () const
 
qreal borderWidth () const
 
QRectF contentRect () const
 
QSizeF contentSize () const
 
FrameType frame () const
 
qreal margin () const
 
qreal marginBottom () const
 
qreal marginLeft () const
 
qreal marginRight () const
 
qreal marginTop () const
 
qreal padding () const
 
QRectF paintedRect () const
 
void setBackground (const QBrush &background)
 
void setBorderBrush (const QBrush &brush)
 
void setBorderStyle (Qt::PenStyle style)
 
void setBorderWidth (qreal width)
 
void setContentSize (const QSizeF &size)
 
void setFrame (FrameType type)
 
void setMargin (qreal margin)
 
void setMarginBottom (qreal marginBottom)
 
void setMarginLeft (qreal marginLeft)
 
void setMarginRight (qreal marginRight)
 
void setMarginTop (qreal marginTop)
 
void setPadding (qreal width)
 
- Public Member Functions inherited from Marble::ScreenGraphicsItem
 ScreenGraphicsItem (MarbleGraphicsItem *parent=0)
 
virtual ~ScreenGraphicsItem ()
 
QList< QPointF > absolutePositions () const
 
GraphicsItemFlags flags () const
 
QPointF position () const
 
QPointF positivePosition () const
 
void setFlags (GraphicsItemFlags flags)
 
void setPosition (const QPointF &position)
 
- Public Member Functions inherited from Marble::MarbleGraphicsItem
virtual ~MarbleGraphicsItem ()
 
CacheMode cacheMode () const
 
bool contains (const QPointF &point) const
 
void hide ()
 
AbstractMarbleGraphicsLayout * layout () const
 
bool paintEvent (QPainter *painter, const ViewportParams *viewport)
 
void setCacheMode (CacheMode mode)
 
void setLayout (AbstractMarbleGraphicsLayout *layout)
 
virtual void setProjection (const ViewportParams *viewport)
 
void setSize (const QSizeF &size)
 
void setVisible (bool visible)
 
void show ()
 
QSizeF size () const
 
bool visible () 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 Types inherited from Marble::FrameGraphicsItem
enum  FrameType { NoFrame, RectFrame, RoundedRectFrame, ShadowFrame }
 
- Public Types inherited from Marble::ScreenGraphicsItem
enum  GraphicsItemFlag { ItemIsMovable = 0x1, ItemIsHideable = 0x2 }
 
- Public Types inherited from Marble::MarbleGraphicsItem
enum  CacheMode { NoCache, ItemCoordinateCache, DeviceCoordinateCache }
 
- Public Slots inherited from Marble::AbstractFloatItem
void hide ()
 
void setPositionLocked (bool lock)
 
void show ()
 
- 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::AbstractFloatItem
virtual void changeViewport (ViewportParams *viewport)
 
QMenu * contextMenu ()
 
virtual void contextMenuEvent (QWidget *w, QContextMenuEvent *e)
 
virtual void toolTipEvent (QHelpEvent *e)
 
- Protected Member Functions inherited from Marble::RenderPlugin
bool eventFilter (QObject *, QEvent *)
 
- Protected Member Functions inherited from Marble::FrameGraphicsItem
virtual QPainterPath backgroundShape () const
 
virtual void paint (QPainter *painter)
 
virtual void paintBackground (QPainter *painter)
 
virtual void paintContent (QPainter *painter)
 
- Protected Member Functions inherited from Marble::ScreenGraphicsItem
 ScreenGraphicsItem (ScreenGraphicsItemPrivate *d_ptr)
 
- Protected Member Functions inherited from Marble::MarbleGraphicsItem
 MarbleGraphicsItem (MarbleGraphicsItemPrivate *d_ptr)
 
void update ()
 
- Protected Attributes inherited from Marble::MarbleGraphicsItem
MarbleGraphicsItemPrivate *const d
 
- Properties inherited from Marble::RenderPlugin
QString description
 
bool enabled
 
QString name
 
QString nameId
 
bool userCheckable
 
QString version
 
bool visible
 

Detailed Description

Definition at line 23 of file RoutingPlugin.h.

Constructor & Destructor Documentation

Marble::RoutingPlugin::RoutingPlugin ( )

Definition at line 421 of file RoutingPlugin.cpp.

Marble::RoutingPlugin::RoutingPlugin ( const MarbleModel *  marbleModel)
explicit

Definition at line 427 of file RoutingPlugin.cpp.

Marble::RoutingPlugin::~RoutingPlugin ( )

Definition at line 439 of file RoutingPlugin.cpp.

Member Function Documentation

QStringList Marble::RoutingPlugin::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 444 of file RoutingPlugin.cpp.

QDialog * Marble::RoutingPlugin::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 585 of file RoutingPlugin.cpp.

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

Implements Marble::PluginInterface.

Definition at line 474 of file RoutingPlugin.cpp.

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

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 469 of file RoutingPlugin.cpp.

bool Marble::RoutingPlugin::eventFilter ( QObject *  object,
QEvent *  event 
)
virtual

Reimplemented from Marble::AbstractFloatItem.

Definition at line 532 of file RoutingPlugin.cpp.

QString Marble::RoutingPlugin::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 454 of file RoutingPlugin.cpp.

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

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 486 of file RoutingPlugin.cpp.

void Marble::RoutingPlugin::initialize ( )
virtual
Todo:
: The maemo styling of the progressbar adds a black background and some frame which are even painted when no background painting is requested like WidgetItem does. This looks really bad on a float item. Using a different style here, but that is only a workaround.

Implements Marble::RenderPluginInterface.

Definition at line 491 of file RoutingPlugin.cpp.

bool Marble::RoutingPlugin::isInitialized ( ) const
virtual

Implements Marble::RenderPluginInterface.

Definition at line 527 of file RoutingPlugin.cpp.

QString Marble::RoutingPlugin::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 449 of file RoutingPlugin.cpp.

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

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 459 of file RoutingPlugin.cpp.

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

Implements Marble::PluginInterface.

Definition at line 479 of file RoutingPlugin.cpp.

void Marble::RoutingPlugin::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::AbstractFloatItem.

Definition at line 574 of file RoutingPlugin.cpp.

QHash< QString, QVariant > Marble::RoutingPlugin::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::AbstractFloatItem.

Definition at line 563 of file RoutingPlugin.cpp.

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

Implements Marble::PluginInterface.

Definition at line 464 of file RoutingPlugin.cpp.


The documentation for this class was generated from the following files:
  • RoutingPlugin.h
  • RoutingPlugin.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:38:57 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