• 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
  • inhibit-screensaver
InhibitScreensaverPlugin.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 Dennis Nienhüser <earthwings@gentoo.org>
9 //
10 
11 #ifndef INHIBITSCREENSAVERPLUGIN_H
12 #define INHIBITSCREENSAVERPLUGIN_H
13 
14 #include "RenderPlugin.h"
15 
16 namespace Marble
17 {
18 class PositionProviderPlugin;
19 class InhibitScreensaverPluginPrivate;
20 
25 class InhibitScreensaverPlugin : public RenderPlugin
26 {
27 
28 Q_OBJECT
29  Q_PLUGIN_METADATA( IID "org.kde.edu.marble.InhibitScreensaverPlugin" )
30 Q_INTERFACES( Marble::RenderPluginInterface )
31 
32 MARBLE_PLUGIN( InhibitScreensaverPlugin )
33 
34 public:
35  InhibitScreensaverPlugin();
36 
37  explicit InhibitScreensaverPlugin( const MarbleModel *marbleModel );
38 
39  ~InhibitScreensaverPlugin();
40 
41  QStringList backendTypes() const;
42 
43  void initialize();
44 
45  bool isInitialized() const;
46 
47  QString name() const;
48 
49  QString guiString() const;
50 
51  QString nameId() const;
52 
53  QString version() const;
54 
55  QString description() const;
56 
57  QString copyrightYears() const;
58 
59  QList<PluginAuthor> pluginAuthors() const;
60 
61  QIcon icon() const;
62 
63  virtual QStringList renderPosition() const;
64 
65  virtual bool render( GeoPainter *painter, ViewportParams *viewport,
66  const QString& renderPos = "NONE", GeoSceneLayer * layer = 0 );
67 
68  virtual QString renderPolicy() const;
69 
70 private Q_SLOTS:
71  void updateScreenSaverState( PositionProviderPlugin *activePlugin );
72 
73  void inhibitScreenSaver();
74 
75 private:
76  InhibitScreensaverPluginPrivate* const d;
77 };
78 
79 }
80 
81 #endif // INHIBITSCREENSAVERPLUGIN_H
Marble::RenderPluginInterface
The class that specifies the Marble layer interface of a plugin.
Definition: RenderPluginInterface.h:30
Marble::InhibitScreensaverPlugin::icon
QIcon icon() const
Returns an icon for the plugin.
Definition: InhibitScreensaverPlugin.cpp:120
Marble::InhibitScreensaverPlugin::version
QString version() const
Definition: InhibitScreensaverPlugin.cpp:99
Marble::GeoPainter
A painter that allows to draw geometric primitives on the map.
Definition: GeoPainter.h:98
Marble::InhibitScreensaverPlugin::initialize
void initialize()
Definition: InhibitScreensaverPlugin.cpp:125
Marble::InhibitScreensaverPlugin::name
QString name() const
Returns the user-visible name of the plugin.
Definition: InhibitScreensaverPlugin.cpp:84
Marble::PositionProviderPlugin
The abstract class that provides position information.
Definition: PositionProviderPlugin.h:26
Marble::GeoSceneLayer
Layer of a GeoScene document.
Definition: GeoSceneLayer.h:43
Marble::InhibitScreensaverPlugin::renderPosition
virtual QStringList renderPosition() const
Preferred level in the layer stack for the rendering.
Definition: InhibitScreensaverPlugin.cpp:78
Marble::InhibitScreensaverPlugin::guiString
QString guiString() const
String that should be displayed in GUI.
Definition: InhibitScreensaverPlugin.cpp:89
Marble::InhibitScreensaverPlugin::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: InhibitScreensaverPlugin.cpp:73
Marble::InhibitScreensaverPlugin::copyrightYears
QString copyrightYears() const
Definition: InhibitScreensaverPlugin.cpp:109
Marble::ViewportParams
A public class that controls what is visible in the viewport of a Marble map.
Definition: ViewportParams.h:44
Marble::InhibitScreensaverPlugin::~InhibitScreensaverPlugin
~InhibitScreensaverPlugin()
Definition: InhibitScreensaverPlugin.cpp:68
Marble::InhibitScreensaverPlugin::description
QString description() const
Returns a user description of the plugin.
Definition: InhibitScreensaverPlugin.cpp:104
Marble::MarbleModel
The data model (not based on QAbstractModel) for a MarbleWidget.
Definition: MarbleModel.h:96
Marble::InhibitScreensaverPlugin::isInitialized
bool isInitialized() const
Definition: InhibitScreensaverPlugin.cpp:138
Marble::InhibitScreensaverPlugin::nameId
QString nameId() const
Returns the unique name of the plugin.
Definition: InhibitScreensaverPlugin.cpp:94
RenderPlugin.h
Marble::InhibitScreensaverPlugin::InhibitScreensaverPlugin
InhibitScreensaverPlugin()
Definition: InhibitScreensaverPlugin.cpp:46
Marble::InhibitScreensaverPlugin::renderPolicy
virtual QString renderPolicy() const
Return how the plugin settings should be used.
Definition: InhibitScreensaverPlugin.cpp:169
Marble::InhibitScreensaverPlugin::pluginAuthors
QList< PluginAuthor > pluginAuthors() const
Definition: InhibitScreensaverPlugin.cpp:114
Marble::RenderPlugin::marbleModel
const MarbleModel * marbleModel() const
Access to the MarbleModel.
Definition: RenderPlugin.cpp:81
Marble::InhibitScreensaverPlugin
A plugin that inhibits the screensaver as long as a position provider plugin is active.
Definition: InhibitScreensaverPlugin.h:25
Marble::RenderPlugin
The abstract class that creates a renderable item.
Definition: RenderPlugin.h:43
Marble::InhibitScreensaverPlugin::render
virtual bool render(GeoPainter *painter, ViewportParams *viewport, const QString &renderPos="NONE", GeoSceneLayer *layer=0)
Renders the content provided by the layer on the viewport.
Definition: InhibitScreensaverPlugin.cpp:163
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:50 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