Marble::PluginManager Class Reference

#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)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () 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 () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	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
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () 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 *context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
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
QObject *	sender () 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 38 of file PluginManager.h.

Constructor & Destructor Documentation

PluginManager()

Marble::PluginManager::PluginManager ( QObject * parent = nullptr )

explicit

Definition at line 67 of file PluginManager.cpp.

~PluginManager()

Marble::PluginManager::~PluginManager ( )

override

Definition at line 77 of file PluginManager.cpp.

Member Function Documentation

addParseRunnerPlugin()

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

plugin

The plugin to add. Ownership retains with the caller.

Definition at line 153 of file PluginManager.cpp.

addPositionProviderPlugin()

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

plugin

The plugin to add. Ownership retains with the caller.

Definition at line 101 of file PluginManager.cpp.

addRenderPlugin()

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

plugin

The plugin to add. Ownership retains with the caller.

Definition at line 88 of file PluginManager.cpp.

addReverseGeocodingRunnerPlugin()

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

plugin

The plugin to add. Ownership retains with the caller.

Definition at line 127 of file PluginManager.cpp.

addRoutingRunnerPlugin()

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

plugin

The plugin to add. Ownership retains with the caller.

Definition at line 140 of file PluginManager.cpp.

addSearchRunnerPlugin()

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

plugin

The plugin to add. Ownership retains with the caller.

Definition at line 114 of file PluginManager.cpp.

blacklistPlugin()

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

static

blacklistPlugin Prevent that a plugin is loaded from the given filename

Parameters

filename

The 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 160 of file PluginManager.cpp.

parsingRunnerPlugins()

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 147 of file PluginManager.cpp.

positionProviderPlugins()

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 95 of file PluginManager.cpp.

renderPlugins()

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 82 of file PluginManager.cpp.

reverseGeocodingRunnerPlugins()

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 121 of file PluginManager.cpp.

routingRunnerPlugins()

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 134 of file PluginManager.cpp.

searchRunnerPlugins()

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 108 of file PluginManager.cpp.

whitelistPlugin()

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

filename

The 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 165 of file PluginManager.cpp.

---

The documentation for this class was generated from the following files:

• PluginManager.h
• PluginManager.cpp