Marble::PluginManager

#include <PluginManager.h>

Inheritance diagram for Marble::PluginManager:

Signals

void parseRunnerPluginsChanged ()
 
void positionProviderPluginsChanged ()
 
void renderPluginsChanged ()
 
void reverseGeocodingRunnerPluginsChanged ()
 
void routingRunnerPluginsChanged ()
 
void searchRunnerPluginsChanged ()
 

Public Member Functions

 PluginManager (QObject *parent=nullptr)
 
void addParseRunnerPlugin (const ParseRunnerPlugin *plugin)
 
void addPositionProviderPlugin (const PositionProviderPlugin *plugin)
 
void addRenderPlugin (const RenderPlugin *plugin)
 
void addReverseGeocodingRunnerPlugin (const ReverseGeocodingRunnerPlugin *plugin)
 
void addRoutingRunnerPlugin (RoutingRunnerPlugin *plugin)
 
void addSearchRunnerPlugin (const SearchRunnerPlugin *plugin)
 
QList< const ParseRunnerPlugin * > parsingRunnerPlugins () const
 
QList< const PositionProviderPlugin * > positionProviderPlugins () const
 
QList< const RenderPlugin * > renderPlugins () const
 
QList< const ReverseGeocodingRunnerPlugin * > reverseGeocodingRunnerPlugins () const
 
QList< RoutingRunnerPlugin * > routingRunnerPlugins () const
 
QList< const SearchRunnerPlugin * > searchRunnerPlugins () 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)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
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
 

Static Public Member Functions

static void blacklistPlugin (const QString &filename)
 
static void whitelistPlugin (const QString &filename)
 
- 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)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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)
 

Detailed Description

The class that handles Marble's plugins.

Ownership policy for plugins:

On every invocation of createNetworkPlugins and createFloatItems the PluginManager creates new objects and transfers ownership to the calling site. In order to create the objects, the PluginManager internally has a list of the plugins which are owned by the PluginManager and destroyed by it.

Definition at line 44 of file PluginManager.h.

Member Function Documentation

void Marble::PluginManager::addParseRunnerPlugin ( const ParseRunnerPlugin plugin)

Add a ParseRunnerPlugin manually to the list of known plugins.

Normally you don't need to call this method since all plugins are loaded automatically.

Parameters
pluginThe plugin to add. Ownership retains with the caller.

Definition at line 159 of file PluginManager.cpp.

void Marble::PluginManager::addPositionProviderPlugin ( const PositionProviderPlugin plugin)

Add a PositionProviderPlugin manually to the list of known plugins.

Normally you don't need to call this method since all plugins are loaded automatically.

Parameters
pluginThe plugin to add. Ownership retains with the caller.

Definition at line 107 of file PluginManager.cpp.

void Marble::PluginManager::addRenderPlugin ( const RenderPlugin plugin)

Add a RenderPlugin manually to the list of known plugins.

Normally you don't need to call this method since all plugins are loaded automatically.

Parameters
pluginThe plugin to add. Ownership retains with the caller.

Definition at line 94 of file PluginManager.cpp.

void Marble::PluginManager::addReverseGeocodingRunnerPlugin ( const ReverseGeocodingRunnerPlugin plugin)

Add a ReverseGeocodingRunnerPlugin manually to the list of known plugins.

Normally you don't need to call this method since all plugins are loaded automatically.

Parameters
pluginThe plugin to add. Ownership retains with the caller.

Definition at line 133 of file PluginManager.cpp.

void Marble::PluginManager::addRoutingRunnerPlugin ( RoutingRunnerPlugin plugin)

Add a RoutingRunnerPlugin manually to the list of known plugins.

Normally you don't need to call this method since all plugins are loaded automatically.

Parameters
pluginThe plugin to add. Ownership retains with the caller.

Definition at line 146 of file PluginManager.cpp.

void Marble::PluginManager::addSearchRunnerPlugin ( const SearchRunnerPlugin plugin)

Add a SearchRunnerPlugin manually to the list of known plugins.

Normally you don't need to call this method since all plugins are loaded automatically.

Parameters
pluginThe plugin to add. Ownership retains with the caller.

Definition at line 120 of file PluginManager.cpp.

void Marble::PluginManager::blacklistPlugin ( const QString filename)
static

blacklistPlugin Prevent that a plugin is loaded from the given filename

Parameters
filenameThe name of the file (excluding prefix and file extension) to blacklist. E.g. to ignore "libWikipedia.so" on Linux and "Wikipedia.dll" on Windows, pass "Wikipedia"

Definition at line 166 of file PluginManager.cpp.

QList< const ParseRunnerPlugin * > Marble::PluginManager::parsingRunnerPlugins ( ) const

Returns all parse runner plugins.

Note
: The runner plugins are owned by the PluginManager, do not delete them.

Definition at line 153 of file PluginManager.cpp.

QList< const PositionProviderPlugin * > Marble::PluginManager::positionProviderPlugins ( ) const

Returns all available PositionProviderPlugins.

Ownership of the items remains in PluginManager. In order to use the PositionProviderPlugins, first create new instances using PositionProviderPlugin::newInstance().

Definition at line 101 of file PluginManager.cpp.

QList< const RenderPlugin * > Marble::PluginManager::renderPlugins ( ) const

Returns all available RenderPlugins.

Ownership of the items remains in PluginManager. In order to use the RenderPlugins, first create new instances using RenderPlugin::newInstance().

Definition at line 88 of file PluginManager.cpp.

QList< const ReverseGeocodingRunnerPlugin * > Marble::PluginManager::reverseGeocodingRunnerPlugins ( ) const

Returns all reverse geocoding runner plugins.

Note
: The runner plugins are owned by the PluginManager, do not delete them.

Definition at line 127 of file PluginManager.cpp.

QList< RoutingRunnerPlugin * > Marble::PluginManager::routingRunnerPlugins ( ) const

Returns all routing runner plugins.

Note
: The runner plugins are owned by the PluginManager, do not delete them.

Definition at line 140 of file PluginManager.cpp.

QList< const SearchRunnerPlugin * > Marble::PluginManager::searchRunnerPlugins ( ) const

Returns all search runner plugins.

Note
: Runner plugins are owned by the PluginManager, do not delete them.

Definition at line 114 of file PluginManager.cpp.

void Marble::PluginManager::whitelistPlugin ( const QString filename)
static

whitelistPlugin Add a plugin to the whitelist of plugins.

If the whitelist is not empty, only whitelisted plugins are loaded. If a plugin is both whitelisted and blacklisted, it will not be loaded

Parameters
filenameThe name of the file (excluding prefix and file extension) to whitelist. E.g. to ignore "libWikipedia.so" on Linux and "Wikipedia.dll" on Windows, pass "Wikipedia"

Definition at line 171 of file PluginManager.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Sep 21 2020 23:20:59 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.