KParts::Factory Class Reference

#include <factory.h>

Inheritance diagram for KParts::Factory:

Public Member Functions
	Factory (QObject *parent=nullptr)
Part *	createPart (QWidget *parentWidget=nullptr, QObject *parent=nullptr, const char *classname="KParts::Part", const QStringList &args=QStringList())
virtual KComponentData	partComponentData ()
Public Member Functions inherited from KPluginFactory
T *	create (const QString &keyword, QObject *parent=nullptr, const QVariantList &args=QVariantList())
T *	create (QObject *parent, const QStringList &args)
QObject *	create (QObject *parent=nullptr, const char *classname="QObject", const QStringList &args=QStringList())
T *	create (QObject *parent=nullptr, const QVariantList &args=QVariantList())
T *	create (QWidget *parentWidget, QObject *parent, const QString &keyword, const QVariantList &args=QVariantList())
T *	create (QWidget *parentWidget, QObject *parent, const QVariantList &args={})
KPluginMetaData	metaData () const
void	setMetaData (const KPluginMetaData &metaData)
Public Member Functions inherited from QObject
	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 QRegExp &regExp, 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
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 &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
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	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 KComponentData	partComponentDataFromLibrary (const QString &libraryName)
Static Public Member Functions inherited from KPluginFactory
static Result< T >	instantiatePlugin (const KPluginMetaData &data, QObject *parent=nullptr, const QVariantList &args={})
static Result< KPluginFactory >	loadFactory (const KPluginMetaData &data)
static QVariantList	stringListToVariantList (const QStringList &list)
static QStringList	variantListToStringList (const QVariantList &list)
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)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Protected Member Functions
QObject *	createObject (QObject *parent=nullptr, const char *classname="QObject", const QStringList &args=QStringList()) override
Part *	createPartObject (QWidget *parentWidget=nullptr, QObject *parent=nullptr, const char *classname="KParts::Part", const QStringList &args=QStringList()) override=0
Protected Member Functions inherited from KPluginFactory
virtual QObject *	create (const char *iface, QWidget *parentWidget, QObject *parent, const QVariantList &args, const QString &keyword)
void	registerPlugin ()
void	registerPlugin ()
void	registerPlugin (const QString &keyword)
void	registerPlugin (const QString &keyword)
void	registerPlugin (const QString &keyword, CreateInstanceFunction instanceFunction)
void	registerPlugin (const QString &keyword, CreateInstanceWithMetaDataFunction instanceFunction)
void	registerPlugin (CreateInstanceWithMetaDataFunction instanceFunction)
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)

Additional Inherited Members
Public Types inherited from KPluginFactory
enum	ResultErrorReason
Properties inherited from QObject
	objectName
Public Attributes inherited from QObject
typedef	QObjectList
Protected Types inherited from KPluginFactory
typedef QObject *(*	CreateInstanceFunction) (QWidget *, QObject *, const QVariantList &)
typedef QObject *(*)(QWidget *, QObject *, const KPluginMetaData &, const QVariantList &	CreateInstanceWithMetaDataFunction)

Detailed Description

A generic factory object to create a Part.

Factory is an abstract class. Reimplement the createPartObject() method to give it functionality.

See also

KPluginFactory.

Definition at line 42 of file factory.h.

Member Function Documentation

createObject()

QObject * Factory::createObject ( QObject *  parent = nullptr, const char *  classname = "QObject", const QStringList &  args = QStringList()  )

overrideprotectedvirtual

Reimplemented from KPluginFactory.

Calls createPart()

Reimplemented from KPluginFactory.

Definition at line 75 of file factory.cpp.

createPart()

Part * Factory::createPart	(	QWidget *	parentWidget = nullptr,
		QObject *	parent = nullptr,
		const char *	classname = "KParts::Part",
		const QStringList &	args = QStringList()
	)

Creates a part.

The QStringList can be used to pass additional arguments to the part. If the part needs additional arguments, it should take them as name="value" pairs. This is the way additional arguments will get passed to the part from eg. khtml. You can for example emebed the part into HTML by using the following code:

<object type="my_mimetype" data="url_to_my_data">
    <param name="name1" value="value1">
    <param name="name2" value="value2">
</object>

This could result in a call to

createPart( parentWidget, parentObject, "KParts::Part",
            QStringList("name1="value1"", "name2="value2") );

Returns

the newly created part.

createPart() automatically emits a signal KPluginFactory::objectCreated to tell the library about its newly created object. This is very important for reference counting, and allows unloading the library automatically once all its objects have been destroyed.

Definition at line 41 of file factory.cpp.

createPartObject()

Part * Factory::createPartObject ( QWidget *  parentWidget = nullptr, QObject *  parent = nullptr, const char *  classname = "KParts::Part", const QStringList &  args = QStringList()  )

overrideprotectedpure virtual

Reimplement this method in your implementation to create the Part.

The QStringList can be used to pass additional arguments to the part. If the part needs additional arguments, it should take them as name="value" pairs. This is the way additional arguments will get passed to the part from eg. khtml. You can for example emebed the part into HTML by using the following code:

<object type="my_mimetype" data="url_to_my_data">
    <param name="name1" value="value1">
    <param name="name2" value="value2">
</object>

This could result in a call to

createPart( parentWidget, parentObject, "KParts::Part",
            QStringList("name1="value1"", "name2="value2") );

Returns

the newly created part.

Reimplemented from KPluginFactory.

Implemented in KParts::GenericFactory< T >.

Definition at line 70 of file factory.cpp.

partComponentData()

KComponentData Factory::partComponentData ( )

virtual

If you have a part contained in a shared library you might want to query for meta-information like the about-data, or the KComponentData in general.

If the part is exported using KParts::GenericFactory then this method will return the instance that belongs to the part without the need to instantiate the part component.

Reimplemented in KParts::GenericFactoryBase< T >, and KParts::GenericFactoryBase< T1 >.

Definition at line 50 of file factory.cpp.

partComponentDataFromLibrary()

KComponentData Factory::partComponentDataFromLibrary ( const QString &  libraryName )

static

A convenience method for partComponentData that takes care of retrieving the factory for a given library name and calling partComponentData on it.

Parameters

libraryName

name of the library to query the instance from

Definition at line 55 of file factory.cpp.

---

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

• factory.h
• factory.cpp