KPluginFactory
#include <KPluginFactory>

Classes | |
struct | InheritanceChecker |
struct | InheritanceWithMetaDataChecker |
Signals | |
void | objectCreated (QObject *object) |
Public Member Functions | |
KPluginFactory () | |
~KPluginFactory () override | |
template<typename T > | |
T * | create (QObject *parent=nullptr, const QVariantList &args=QVariantList()) |
template<typename T > | |
T * | create (const QString &keyword, QObject *parent=nullptr, const QVariantList &args=QVariantList()) |
template<typename T > | |
T * | create (QWidget *parentWidget, QObject *parent, const QString &keyword=QString(), const QVariantList &args=QVariantList()) |
template<typename T > | |
T * | create (QObject *parent, const QStringList &args) |
QObject * | create (QObject *parent=nullptr, const char *classname="QObject", const QStringList &args=QStringList()) |
KPluginMetaData | metaData () const |
void | setMetaData (const KPluginMetaData &metaData) |
![]() | |
QObject (QObject *parent) | |
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 () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
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 QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, 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 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_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 | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
T | qobject_cast (QObject *object) |
T | 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) |
QThread * | thread () const const |
Static Public Member Functions | |
static QVariantList | stringListToVariantList (const QStringList &list) |
static QStringList | variantListToStringList (const QVariantList &list) |
![]() | |
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) |
Protected Types | |
typedef QObject *(* | CreateInstanceFunction) (QWidget *, QObject *, const QVariantList &) |
using | CreateInstanceWithMetaDataFunction = QObject *(*)(QWidget *, QObject *, const KPluginMetaData &, const QVariantList &) |
template<bool B, class T = void> | |
using | enable_if_t = typename std::enable_if< B, T >::type |
Protected Member Functions | |
KPluginFactory (KPluginFactoryPrivate &dd) | |
virtual QObject * | create (const char *iface, QWidget *parentWidget, QObject *parent, const QVariantList &args, const QString &keyword) |
virtual QObject * | createObject (QObject *parent, const char *className, const QStringList &args) |
virtual KParts::Part * | createPartObject (QWidget *parentWidget, QObject *parent, const char *classname, const QStringList &args) |
template<class T > | |
void | registerPlugin (const QString &keyword, CreateInstanceFunction instanceFunction) |
template<class T , enable_if_t< InheritanceChecker< T >::enabled, int > = 0> | |
void | registerPlugin (const QString &keyword=QString()) |
template<class T > | |
void | registerPlugin (const QString &keyword, CreateInstanceWithMetaDataFunction instanceFunction) |
template<class T , enable_if_t< InheritanceWithMetaDataChecker< T >::enabled, int > = 0> | |
void | registerPlugin (const QString &keyword=QString()) |
![]() | |
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) |
Static Protected Member Functions | |
template<class impl , class ParentType > | |
static QObject * | createInstance (QWidget *parentWidget, QObject *parent, const QVariantList &args) |
template<class impl > | |
static QObject * | createPartInstance (QWidget *parentWidget, QObject *parent, const QVariantList &args) |
template<class impl > | |
static QObject * | createPartWithMetaDataInstance (QWidget *parentWidget, QObject *parent, const KPluginMetaData &metaData, const QVariantList &args) |
template<class impl , class ParentType > | |
static QObject * | createWithMetaDataInstance (QWidget *parentWidget, QObject *parent, const KPluginMetaData &metaData, const QVariantList &args) |
Protected Attributes | |
std::unique_ptr< KPluginFactoryPrivate > const | d_ptr |
Related Functions | |
(Note that these are not member functions.) | |
#define | K_PLUGIN_CLASS_WITH_JSON(classname, jsonFile) K_PLUGIN_FACTORY_WITH_JSON(classname##Factory, jsonFile, registerPlugin<classname>();) |
#define | K_PLUGIN_FACTORY(name, pluginRegistrations) K_PLUGIN_FACTORY_WITH_BASEFACTORY(name, KPluginFactory, pluginRegistrations) |
#define | K_PLUGIN_FACTORY_DECLARATION(name) K_PLUGIN_FACTORY_DECLARATION_WITH_BASEFACTORY(name, KPluginFactory) |
#define | K_PLUGIN_FACTORY_DECLARATION_WITH_BASEFACTORY_SKEL(name, baseFactory, ...) |
#define | K_PLUGIN_FACTORY_DEFINITION(name, pluginRegistrations) K_PLUGIN_FACTORY_DEFINITION_WITH_BASEFACTORY(name, KPluginFactory, pluginRegistrations) |
#define | K_PLUGIN_FACTORY_WITH_JSON(name, jsonFile, pluginRegistrations) K_PLUGIN_FACTORY_WITH_BASEFACTORY_JSON(name, KPluginFactory, jsonFile, pluginRegistrations) |
Additional Inherited Members | |
![]() | |
objectName | |
![]() | |
typedef | QObjectList |
Detailed Description
KPluginFactory provides a convenient way to provide factory-style plugins.
Qt plugins provide a singleton object, but a common pattern is for plugins to generate as many objects of a particular type as the application requires. By using KPluginFactory, you can avoid implementing the factory pattern yourself.
KPluginFactory also allows plugins to provide multiple different object types, indexed by keywords.
The objects created by KPluginFactory must inherit QObject, and must have a standard constructor pattern:
- if the object is a KPart::Part, it must be of the form or, since KF 5.77, T(QWidget *parentWidget, QObject *parent, const KPluginMetaData &metaData, const QVariantList &args)
- if it is a QWidget, it must be of the form or, since KF 5.77,T(QWidget *parent, const QVariantList &args)
- otherwise it must be of the form or, since KF 5.77,T(QObject *parent, const QVariantList &args)
You should typically use either K_PLUGIN_FACTORY() or K_PLUGIN_FACTORY_WITH_JSON() in your plugin code to create the factory. The typical pattern is
If you want to write a custom KPluginFactory not using the standard macro(s) you can reimplement the create(const char *iface, QWidget *parentWidget, QObject *parent, const QVariantList &args, const QString &keyword) method.
Example:
To use such a custom KPluginFactory, use the K_PLUGIN_FACTORY_DECLARATION_WITH_BASEFACTORY and K_PLUGIN_FACTORY_DEFINITION_WITH_BASEFACTORY macros, passing in the name of the custom subclass as baseFactory
.
If you want to load a library use KPluginLoader. The application that wants to instantiate plugin classes can do the following:
Definition at line 403 of file kpluginfactory.h.
Member Typedef Documentation
|
protected |
Function pointer type to a function that instantiates a plugin.
Definition at line 518 of file kpluginfactory.h.
|
protected |
Function pointer type to a function that instantiates a plugin, also taking a plugin metadata argument.
- Since
- 5.77
Definition at line 548 of file kpluginfactory.h.
Constructor & Destructor Documentation
|
explicit |
This constructor creates a factory for a plugin.
Definition at line 18 of file kpluginfactory.cpp.
|
overridedefault |
This destroys the PluginFactory.
Member Function Documentation
|
inline |
Use this method to create an object.
It will try to create an object which inherits T
. If it has multiple choices it's not defined which object will be returned, so be careful to request a unique interface or use keywords.
- Template Parameters
-
T the interface for which an object should be created. The object will inherit T
.
- Parameters
-
parent the parent of the object. If parent
is a widget type, it will also passed to the parentWidget argument of the CreateInstanceFunction for the object.args additional arguments which will be passed to the object.
- Returns
- pointer to the created object is returned, or
nullptr
if an error occurred.
Definition at line 768 of file kpluginfactory.h.
|
inline |
Use this method to create an object.
It will try to create an object which inherits T
and was registered with keyword
.
- Template Parameters
-
T the interface for which an object should be created. The object will inherit T
.
- Parameters
-
keyword the keyword of the object. parent the parent of the object. If parent
is a widget type, it will also passed to the parentWidget argument of the CreateInstanceFunction for the object.args additional arguments which will be passed to the object.
- Returns
- pointer to the created object is returned, or
nullptr
if an error occurred.
Definition at line 781 of file kpluginfactory.h.
|
inline |
Use this method to create an object.
It will try to create an object which inherits T
and was registered with keyword
. This overload has an additional parentWidget
argument, which is used by some plugins (e.g. Parts).
- Template Parameters
-
T the interface for which an object should be created. The object will inherit T
.
- Parameters
-
parentWidget an additional parent widget. parent the parent of the object. If parent
is a widget type, it will also passed to the parentWidget argument of the CreateInstanceFunction for the object.keyword the keyword of the object. args additional arguments which will be passed to the object.
- Returns
- pointer to the created object is returned, or
nullptr
if an error occurred.
Definition at line 794 of file kpluginfactory.h.
|
inline |
Definition at line 468 of file kpluginfactory.h.
|
inline |
Definition at line 477 of file kpluginfactory.h.
|
protectedvirtual |
This function is called when the factory asked to create an Object.
You may reimplement it to provide a very flexible factory. This is especially useful to provide generic factories for plugins implemented using a scripting language.
- Parameters
-
iface the staticMetaObject::className() string identifying the plugin interface that was requested. E.g. for KCModule plugins this string will be "KCModule". parentWidget only used if the requested plugin is a KPart. parent the parent object for the plugin object. args a plugin specific list of arbitrary arguments. keyword a string that uniquely identifies the plugin. If a KService is used this keyword is read from the X-KDE-PluginKeyword entry in the .desktop file.
Definition at line 146 of file kpluginfactory.cpp.
|
protectedvirtual |
Reimplemented in KParts::Factory.
Definition at line 126 of file kpluginfactory.cpp.
|
protectedvirtual |
- Deprecated:
- since 4.0 use create<T>(QWidget *parentWidget, QObject *parent, const QString &keyword, const QVariantList &args)
Reimplemented in KParts::Factory, and KParts::GenericFactory< class >.
Definition at line 136 of file kpluginfactory.cpp.
KPluginMetaData KPluginFactory::metaData | ( | ) | const |
|
inlineprotected |
Registers a metadata-less plugin with the factory.
Call this function from the constructor of the KPluginFactory subclass to make the create function able to instantiate the plugin when asked for an interface the plugin implements.
You can register as many plugin classes as you want as long as either the plugin interface or the keyword
makes it unique. E.g. it is possible to register a KCModule and a KParts::Part without having to specify keywords since their interfaces differ.
- Template Parameters
-
T the name of the plugin class
- Parameters
-
keyword an optional keyword as unique identifier for the plugin. This allows you to put more than one plugin with the same interface into the same library using the same factory. X-KDE-PluginKeyword is a convenient way to specify the keyword in a desktop file. instanceFunction A function pointer to a function that creates an instance of the plugin.
Definition at line 600 of file kpluginfactory.h.
|
inlineprotected |
Overload for registerPlugin<T>(const QString &keyword, CreateInstanceFunction instanceFunction)
Uses a default instance creation function depending on the type of interface. If the interface inherits from
KParts::Part
the function will callQWidget
the function will call- else the function will call
If those constructor methods are not callable this overload is not available.
Definition at line 626 of file kpluginfactory.h.
|
inlineprotected |
Registers a metadata-taking plugin with the factory.
Call this function from the constructor of the KPluginFactory subclass to make the create function able to instantiate the plugin when asked for an interface the plugin implements.
You can register as many plugin classes as you want as long as either the plugin interface or the keyword
makes it unique. E.g. it is possible to register a KCModule and a KParts::Part without having to specify keywords since their interfaces differ.
- Template Parameters
-
T the name of the plugin class
- Parameters
-
keyword An optional keyword as unique identifier for the plugin. This allows you to put more than one plugin with the same interface into the same library using the same factory. X-KDE-PluginKeyword is a convenient way to specify the keyword in a desktop file. instanceFunction A function pointer to a function that creates an instance of the plugin.
Definition at line 651 of file kpluginfactory.h.
|
inlineprotected |
Overload for registerPlugin<T>(const QString &keyword, CreateInstanceWithMetaDataFunction instanceFunction)
Uses a default instance creation function depending on the type of interface. If the interface inherits from
KParts::Part
the function will callnew T(QWidget *parentWidget, QObject *parent, const KPluginMetaData &metaData, const QVariantList &args)QWidget
the function will call- else the function will call
If those constructor methods are not callable this overload is not available.
Definition at line 677 of file kpluginfactory.h.
void KPluginFactory::setMetaData | ( | const KPluginMetaData & | metaData | ) |
Set the metadata about the plugin this factory generates.
- Parameters
-
metaData the metadata about the plugin
- Since
- 5.77
Definition at line 39 of file kpluginfactory.cpp.
|
static |
Converts a QStringList to a QVariantList
Definition at line 215 of file kpluginfactory.cpp.
|
static |
Converts a QVariantList of strings to a QStringList
Definition at line 206 of file kpluginfactory.cpp.
Friends And Related Function Documentation
|
related |
Create a KPluginFactory subclass and export it as the root plugin object with JSON metadata.
This macro does the same as K_PLUGIN_FACTORY_WITH_JSON, but you only have to pass the class name and the json file. The factory name and registerPlugin call are deduced from the class name.
in the same source file when that one has the name "myplugin.cpp".
Example (KF >= 5.77):
Example (backward-compatible with KF < 5.77):
- See also
- K_PLUGIN_FACTORY_WITH_JSON
- Since
- 5.44
Definition at line 268 of file kpluginfactory.h.
|
related |
Create a KPluginFactory subclass and export it as the root plugin object.
- Parameters
-
name the name of the KPluginFactory derived class. pluginRegistrations code to be inserted into the constructor of the class. Usually a series of registerPlugin() calls.
- Note
- K_PLUGIN_FACTORY declares the subclass including a Q_OBJECT macro. So you need to make sure to have Qt's moc run also for the source file where you use the macro. E.g. in projects using CMake and it's automoc feature, as usual you need to have a line in the same source file when that one has the name "myplugin.cpp".#include <myplugin.moc>
Example:
If you want to compile a .json file into the plugin, use K_PLUGIN_FACTORY_WITH_JSON.
Definition at line 136 of file kpluginfactory.h.
|
related |
K_PLUGIN_FACTORY_DECLARATION declares the KPluginFactory subclass. This macro can be used in a header file.
- Parameters
-
name the name of the KPluginFactory derived class.
Definition at line 281 of file kpluginfactory.h.
|
related |
Declare a KPluginFactory subclass of the given base factory.
- Parameters
-
name the name of the KPluginFactory derived class. baseFactory the name of the base class (base factory) to use. This must be a KPluginFactory subclass with a default constructor.
Additional parameters may be additional Qt properties, such as Q_PLUGIN_METADATA.
- Note
- The base factory must be a subclass of KPluginFactory. While this macro is largely an implementation detail, factories that have a different create() interface can be declared through this macro. Normal use through other K_PLUGIN_FACTORY macros uses KPluginFactory as a base.
- This macro is usually only an implementation detail for K_PLUGIN_FACTORY_DECLARATION_WITH_BASEFACTORY or K_PLUGIN_FACTORY_DECLARATION_WITH_BASEFACTORY_JSON .
- Since
- 5.80
Definition at line 61 of file kpluginfactory.h.
|
related |
K_PLUGIN_FACTORY_DEFINITION defines the KPluginFactory subclass. This macro can not be used in a header file.
- Parameters
-
name the name of the KPluginFactory derived class. pluginRegistrations code to be inserted into the constructor of the class. Usually a series of registerPlugin() calls.
Definition at line 296 of file kpluginfactory.h.
|
related |
Create a KPluginFactory subclass and export it as the root plugin object with JSON metadata.
This macro does the same as K_PLUGIN_FACTORY, but adds a JSON file as plugin metadata. See Q_PLUGIN_METADATA() for more information.
- Parameters
-
name the name of the KPluginFactory derived class. pluginRegistrations code to be inserted into the constructor of the class. Usually a series of registerPlugin() calls. jsonFile name of the JSON file to be compiled into the plugin as metadata
- Note
- K_PLUGIN_FACTORY_WITH_JSON declares the subclass including a Q_OBJECT macro. So you need to make sure to have Qt's moc run also for the source file where you use the macro. E.g. in projects using CMake and its automoc feature, as usual you need to have a line in the same source file when that one has the name "myplugin.cpp".#include <myplugin.moc>
Example (KF >= 5.77):
Example (backward-compatible with KF < 5.77):
- Since
- 5.0
Definition at line 211 of file kpluginfactory.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2021 The KDE developers.
Generated on Thu Apr 15 2021 23:01:47 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.