Marble::RenderPlugin

Search for usage in LXR

#include <RenderPlugin.h>

Inheritance diagram for Marble::RenderPlugin:

Public Types

enum  RenderType {
  UnknownRenderType, TopLevelRenderType, PanelRenderType, OnlineRenderType,
  ThemeRenderType
}
 

Properties

QString description
 
bool enabled
 
QString name
 
QString nameId
 
bool userCheckable
 
QString version
 
bool visible
 
- Properties inherited from QObject
 objectName
 

Signals

void actionGroupsChanged ()
 
void enabledChanged (bool enable)
 
void repaintNeeded (const QRegion &dirtyRegion=QRegion())
 
void settingsChanged (const QString &nameId)
 
void userCheckableChanged (bool isUserCheckable)
 
void visibilityChanged (bool visible, const QString &nameId)
 

Public Slots

QActionaction () const
 
void restoreDefaultSettings ()
 
void setEnabled (bool enabled)
 
bool setSetting (const QString &key, const QVariant &value)
 
QVariant setting (const QString &key) const
 
QStringList settingKeys () const
 
void setUserCheckable (bool isUserCheckable)
 
void setVisible (bool visible)
 

Public Member Functions

 RenderPlugin (const MarbleModel *marbleModel)
 
virtual const QList< QActionGroup * > * actionGroups () const
 
bool enabled () const
 
virtual QString guiString () const =0
 
bool isUserCheckable () const
 
const MarbleModelmarbleModel () const
 
virtual RenderPluginnewInstance (const MarbleModel *marbleModel) const =0
 
RenderState renderState () const override
 
virtual RenderType renderType () const
 
QString runtimeTrace () const override
 
virtual void setSettings (const QHash< QString, QVariant > &settings)
 
virtual QHash< QString, QVariantsettings () const
 
virtual const QList< QActionGroup * > * toolbarActionGroups () const
 
bool visible () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from Marble::RenderPluginInterface
virtual QStringList backendTypes () const =0
 
virtual void initialize ()=0
 
virtual bool isInitialized () const =0
 
virtual QString renderPolicy () const =0
 
- Public Member Functions inherited from Marble::PluginInterface
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
 

Protected Member Functions

bool eventFilter (QObject *, QEvent *) override
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

The abstract class that creates a renderable item.

Renderable Plugins can be used to extend Marble's functionality: They allow to draw stuff on top of the map / globe

Definition at line 38 of file RenderPlugin.h.

Member Enumeration Documentation

A Type of plugin.

Definition at line 54 of file RenderPlugin.h.

Member Function Documentation

QAction * Marble::RenderPlugin::action ( ) const
slot

Plugin's menu action.

The action is checkable and controls the visibility of the plugin.

Returns
action, displayed in menu

Definition at line 84 of file RenderPlugin.cpp.

const QList< QActionGroup * > * Marble::RenderPlugin::actionGroups ( ) const
virtual

Getting all actions.

This method is used by the main window to get all of the actions that this plugin defines. There is no guarantee where the main window will place the actions but it will generally be in a Menu. The returned QList should also contain all of the actions returned by

See also
toolbarActions().
Returns
a list of grouped actions

Definition at line 94 of file RenderPlugin.cpp.

void Marble::RenderPlugin::actionGroupsChanged ( )
signal

This signal is emitted if the actions that the plugin supports change in any way.

bool Marble::RenderPlugin::enabled ( ) const

is enabled

This method indicates enableability of the plugin

If plugin is enabled it going to be displayed in Marble Menu as active action which can be

See also
setUserCheckable
Returns
enableability of the plugin
See also
setEnabled
void Marble::RenderPlugin::enabledChanged ( bool  enable)
signal

This signal is emitted if the enabled property is changed with.

See also
setEnabled
virtual QString Marble::RenderPlugin::guiString ( ) const
pure virtual

String that should be displayed in GUI.

Using a "&" you can suggest key shortcuts

Example: "&Stars"

Returns
string for gui usage
bool Marble::RenderPlugin::isUserCheckable ( ) const

is user checkable

This method indicates user checkability of plugin's action displayed in application menu

Can control plugin visibility

Warning
User can do it only if
See also
enabled is true
Returns
checkability of the plugin
See also
setUserCheckable

Definition at line 176 of file RenderPlugin.cpp.

const MarbleModel * Marble::RenderPlugin::marbleModel ( ) const

Access to the MarbleModel.

Internal way to access the model of marble. Can be used to interact with the main application

Returns
marble model
See also
MarbleModel

Definition at line 79 of file RenderPlugin.cpp.

virtual RenderPlugin* Marble::RenderPlugin::newInstance ( const MarbleModel marbleModel) const
pure virtual

Creation a new instance of the plugin.

This method is used to create a new object of the current plugin using the marbleModel given.

Parameters
marbleModelbase model
Returns
new instance of current plugin
Note
Typically this method is implemented with the help of the MARBLE_PLUGIN() macro.
RenderPlugin::RenderType Marble::RenderPlugin::renderType ( ) const
virtual

Render type of the plugin.

Function for returning the type of plugin this is for. This affects where in the menu tree the action() is placed.

See also
RenderType
Returns
: The type of render plugin this is

Reimplemented in Marble::AbstractDataPlugin, and Marble::AbstractFloatItem.

Definition at line 197 of file RenderPlugin.cpp.

void Marble::RenderPlugin::repaintNeeded ( const QRegion dirtyRegion = QRegion())
signal

This signal is emitted if an update of the view is needed.

If available with the dirtyRegion which is the region the view will change in. If dirtyRegion.isEmpty() returns true, the whole viewport has to be repainted.

void Marble::RenderPlugin::restoreDefaultSettings ( )
slot

Passes an empty set of settings to the plugin.

Well behaving plugins restore their settings to default values as a result of calling this method.

Definition at line 217 of file RenderPlugin.cpp.

void Marble::RenderPlugin::setEnabled ( bool  enabled)
slot

setting enabled

If enabled = true, plugin will be enabled

If plugin is enabled it will be possible to show/hide it from menu (access from UI)

Parameters
enabledplugin's enabled state
See also
enabled

Definition at line 135 of file RenderPlugin.cpp.

bool Marble::RenderPlugin::setSetting ( const QString key,
const QVariant value 
)
slot

Change setting key's values.

Parameters
keysetting key
valuenew value

This method applies value for the key

Returns
successfully changed or not

Definition at line 227 of file RenderPlugin.cpp.

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

Definition at line 191 of file RenderPlugin.cpp.

QVariant Marble::RenderPlugin::setting ( const QString key) const
slot

Getting setting value from the settings.

Parameters
keysetting's key index

This method should be used to get current value of key in settings hash table

Returns
setting value

Definition at line 240 of file RenderPlugin.cpp.

QStringList Marble::RenderPlugin::settingKeys ( ) const
slot

Full list of the settings keys.

This method should be used to get all possible settings' keys for the plugin's settings

Returns
list with the keys of settings

Definition at line 222 of file RenderPlugin.cpp.

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

Definition at line 181 of file RenderPlugin.cpp.

void Marble::RenderPlugin::settingsChanged ( const QString nameId)
signal

This signal is emitted if the settings of the RenderPlugin changed.

void Marble::RenderPlugin::setUserCheckable ( bool  isUserCheckable)
slot

setting user checkable

If isUserCheckable = true, user will get an option to control visibility in application menu

Parameters
isUserCheckableuser checkability of the plugin
See also
isUserCheckable

Definition at line 157 of file RenderPlugin.cpp.

void Marble::RenderPlugin::setVisible ( bool  visible)
slot

setting visible

If visible = true, plugin will be visible

Parameters
visiblevisibility of the plugin
See also
visible

Definition at line 147 of file RenderPlugin.cpp.

const QList< QActionGroup * > * Marble::RenderPlugin::toolbarActionGroups ( ) const
virtual

Getting all actions which should be placed in the toolbar.

This method returns a subset of the actions returned by

See also
actions() which are intended to be placed in a more prominent place such as a toolbar above the Marble Widget. You are not guaranteed that they will be in an actual toolbar but they will be visible and discoverable
Returns
a list of grouped toolbar actions

Definition at line 99 of file RenderPlugin.cpp.

void Marble::RenderPlugin::userCheckableChanged ( bool  isUserCheckable)
signal

This signal is emitted if the user checkable property is changed with.

See also
setUserCheckable
void Marble::RenderPlugin::visibilityChanged ( bool  visible,
const QString nameId 
)
signal

This signal is emitted if the visibility is changed with.

See also
setVisible
bool Marble::RenderPlugin::visible ( ) const

is visible

This method indicates visibility of the plugin

If plugin is visible you can see it on the map/globe

Returns
visibility of the plugin
See also
setVisible

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 Oct 26 2021 23:21:27 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.