KParts::GenericFactory< T > Class Template Reference

#include <genericfactory.h>

Inheritance diagram for KParts::GenericFactory< T >:

Public Member Functions
	GenericFactory ()
virtual KParts::Part *	createPartObject (QWidget *parentWidget, QObject *parent, const char *className, const QStringList &args)
Public Member Functions inherited from KParts::GenericFactoryBase< T >
	GenericFactoryBase ()
virtual	~GenericFactoryBase ()
virtual KComponentData	partComponentData ()
Public Member Functions inherited from KParts::Factory
	Factory (QObject *parent=0)
virtual	~Factory ()
Part *	createPart (QWidget *parentWidget=0, QObject *parent=0, const char *classname="KParts::Part", const QStringList &args=QStringList())
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from KParts::GenericFactoryBase< T >
static KAboutData *	aboutData ()
static const KComponentData &	componentData ()
Static Public Member Functions inherited from KParts::Factory
static KComponentData	partComponentDataFromLibrary (const QString &libraryName)
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
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)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from KParts::GenericFactoryBase< T >
virtual KComponentData *	createComponentData ()
Protected Member Functions inherited from KParts::Factory
virtual QObject *	createObject (QObject *parent=0, const char *classname="QObject", const QStringList &args=QStringList())
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

template<class T>
class KParts::GenericFactory< T >

A template for a KParts::Factory implementation.

It implements the pure virtual createPartObject method by instantiating the template argument when requested through the className field. In addition it is a container for a part's KComponentData object, by providing a static KComponentData componentData() method.

The template argument has to inherit from KParts::Part and has to implement two methods: 1) There needs to be a public constructor with the following signature: MyPart( QWidget *parentWidget, QObject *parent, const QStringList& args )

2) It needs to provide one static method to create a KAboutData object per request, holding information about the component's name, its authors, license, etc. The signature of that static method has to be KAboutData *createAboutData()

The template will take care of memory management of the KComponentData and the KAboutData object, meaning ownership of what createAboutData returns is passed to the caller (this template) .

For advanced use you can also inherit from the template and re-implement additionally the virtual KComponentData createComponentData() method, for example in case you want to extend the paths of your instance's KStandardDirs object.

If a KParts::ReadOnlyPart is requested through this factory and the template argument implements a KParts::ReadWritePart then setReadWrite( false ) will automatically be called in createPartObject.

Use the factory through the K_EXPORT_COMPONENT_FACTORY macro, like that:

typedef KParts::GenericFactory<YourKPart> YourKPartFactory;
K_EXPORT_COMPONENT_FACTORY( yourlibrary, YourKPartFactory )

yourlibrary is the library name that you compiled your KPart into.

Definition at line 110 of file genericfactory.h.

Constructor & Destructor Documentation

template<class T >

KParts::GenericFactory< T >::GenericFactory ( )

inline

Definition at line 113 of file genericfactory.h.

Member Function Documentation

template<class T >

virtual KParts::Part* KParts::GenericFactory< T >::createPartObject ( QWidget *  parentWidget, QObject *  parent, const char *  classname, const QStringList &  args  )

inlinevirtual

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.

Implements KParts::Factory.

Definition at line 115 of file genericfactory.h.

---

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

• genericfactory.h