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

marble

  • sources
  • kde-4.12
  • kdeedu
  • marble
  • src
  • plugins
  • render
  • routing
RoutingPlugin.h
Go to the documentation of this file.
1 //
2 // This file is part of the Marble Virtual Globe.
3 //
4 // This program is free software licensed under the GNU LGPL. You can
5 // find a copy of this license in LICENSE.txt in the top directory of
6 // the source code.
7 //
8 // Copyright 2010 Siddharth Srivastava <akssps011@gmail.com>
9 // Copyright 2010 Dennis Nienhüser <earthwings@gentoo.org>
10 //
11 
12 #ifndef MARBLE_ROUTINGPLUGIN_H
13 #define MARBLE_ROUTINGPLUGIN_H
14 
15 #include "AbstractFloatItem.h"
16 #include "DialogConfigurationInterface.h"
17 
18 namespace Marble
19 {
20 class RoutingPluginPrivate;
21 class PositionProviderPlugin;
22 
23 class RoutingPlugin : public AbstractFloatItem, public DialogConfigurationInterface
24 {
25  Q_OBJECT
26  Q_PLUGIN_METADATA( IID "org.kde.edu.marble.RoutingPlugin" )
27 
28  Q_INTERFACES( Marble::RenderPluginInterface )
29  Q_INTERFACES( Marble::DialogConfigurationInterface )
30 
31  MARBLE_PLUGIN( RoutingPlugin )
32 
33 public:
34  RoutingPlugin();
35 
36  explicit RoutingPlugin( const MarbleModel *marbleModel );
37 
38  ~RoutingPlugin();
39 
40  QStringList backendTypes() const;
41 
42  void initialize();
43 
44  bool isInitialized() const;
45 
46  QString name() const;
47 
48  QString guiString() const;
49 
50  QString nameId() const;
51 
52  QString version() const;
53 
54  QString description() const;
55 
56  QString copyrightYears() const;
57 
58  QList<PluginAuthor> pluginAuthors() const;
59 
60  QIcon icon() const;
61 
62  bool eventFilter( QObject *object, QEvent *event );
63 
64  virtual QHash<QString,QVariant> settings() const;
65 
66  virtual void setSettings( const QHash<QString,QVariant> &settings );
67 
68  QDialog *configDialog();
69 
70 private Q_SLOTS:
72  void writeSettings();
73 
74 private:
76  Q_PRIVATE_SLOT( d, void updateZoomButtons() )
77 
78 
79  Q_PRIVATE_SLOT( d, void updateZoomButtons( int ) )
80 
81 
82  Q_PRIVATE_SLOT( d, void reverseRoute() )
83 
84 
85  Q_PRIVATE_SLOT( d, void toggleGuidanceMode( bool enabled ) )
86 
87 
88  Q_PRIVATE_SLOT( d, void updateDestinationInformation() )
89 
90 
91  Q_PRIVATE_SLOT( d, void updateGpsButton( PositionProviderPlugin *activePlugin ) )
92 
93 
94  Q_PRIVATE_SLOT( d, void togglePositionTracking( bool enabled ) )
95 
96  Q_PRIVATE_SLOT( d, void updateGuidanceModeButton() )
97 
98 
99  Q_PRIVATE_SLOT( d, void readSettings() )
100 
101  friend class RoutingPluginPrivate;
102  RoutingPluginPrivate* const d;
103 };
104 
105 }
106 
107 #endif // MARBLE_ROUTINGPLUGIN_H
108 
Marble::RoutingPlugin::copyrightYears
QString copyrightYears() const
Definition: RoutingPlugin.cpp:474
Marble::RoutingPlugin::RoutingPluginPrivate
friend class RoutingPluginPrivate
Disable zoom buttons if needed.
Definition: RoutingPlugin.h:101
Marble::RenderPluginInterface
The class that specifies the Marble layer interface of a plugin.
Definition: RenderPluginInterface.h:30
Marble::RoutingPlugin::nameId
QString nameId() const
Returns the unique name of the plugin.
Definition: RoutingPlugin.cpp:459
Marble::RoutingPlugin::version
QString version() const
Definition: RoutingPlugin.cpp:464
Marble::DialogConfigurationInterface
This interface allows a plugin to provide a QWidget-based configuration dialog which is accessible wi...
Definition: DialogConfigurationInterface.h:31
QDialog
Marble::RoutingPlugin::icon
QIcon icon() const
Returns an icon for the plugin.
Definition: RoutingPlugin.cpp:486
Marble::RoutingPlugin::setSettings
virtual void setSettings(const QHash< QString, QVariant > &settings)
Set the settings of the plugin.
Definition: RoutingPlugin.cpp:574
Marble::RoutingPlugin::RoutingPlugin
RoutingPlugin()
Definition: RoutingPlugin.cpp:421
AbstractFloatItem.h
Marble::RoutingPlugin::initialize
void initialize()
Definition: RoutingPlugin.cpp:491
Marble::RoutingPlugin::eventFilter
bool eventFilter(QObject *object, QEvent *event)
Definition: RoutingPlugin.cpp:532
QObject
Marble::PositionProviderPlugin
The abstract class that provides position information.
Definition: PositionProviderPlugin.h:26
Marble::RoutingPlugin::isInitialized
bool isInitialized() const
Definition: RoutingPlugin.cpp:527
Marble::RoutingPlugin::backendTypes
QStringList backendTypes() const
Returns the name(s) of the backend that the plugin can render This method should return the name of t...
Definition: RoutingPlugin.cpp:444
Marble::AbstractFloatItem
The abstract class for float item plugins.
Definition: AbstractFloatItem.h:48
DialogConfigurationInterface.h
Marble::RoutingPlugin::pluginAuthors
QList< PluginAuthor > pluginAuthors() const
Definition: RoutingPlugin.cpp:479
Marble::RoutingPlugin::name
QString name() const
Returns the user-visible name of the plugin.
Definition: RoutingPlugin.cpp:449
Marble::RoutingPlugin::settings
virtual QHash< QString, QVariant > settings() const
Settings of the plugin.
Definition: RoutingPlugin.cpp:563
Marble::MarbleModel
The data model (not based on QAbstractModel) for a MarbleWidget.
Definition: MarbleModel.h:96
Marble::RoutingPlugin
Definition: RoutingPlugin.h:23
Marble::RoutingPlugin::guiString
QString guiString() const
String that should be displayed in GUI.
Definition: RoutingPlugin.cpp:454
Marble::RoutingPlugin::configDialog
QDialog * configDialog()
Returns a pointer to the configuration dialog of the plugin.
Definition: RoutingPlugin.cpp:585
Marble::RenderPlugin::enabled
bool enabled() const
is enabled
Marble::RoutingPlugin::~RoutingPlugin
~RoutingPlugin()
Definition: RoutingPlugin.cpp:439
Marble::RoutingPlugin::description
QString description() const
Returns a user description of the plugin.
Definition: RoutingPlugin.cpp:469
Marble::RenderPlugin::marbleModel
const MarbleModel * marbleModel() const
Access to the MarbleModel.
Definition: RenderPlugin.cpp:81
MARBLE_PLUGIN
#define MARBLE_PLUGIN(T)
Definition: RenderPlugin.h:337
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:38:52 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