KDECore
KGenericFactory< Product, ParentType > Class Template Reference
This template provides a generic implementation of a KLibFactory , for use with shared library components. More...
#include <kgenericfactory.h>
Public Member Functions | |
KGenericFactory (const KAboutData *data) | |
KGenericFactory (const char *instanceName=0) | |
Protected Member Functions | |
virtual QObject * | createObject (QObject *parent, const char *name, const char *className, const QStringList &args) |
Detailed Description
template<class Product, class ParentType = QObject>
class KGenericFactory< Product, ParentType >
This template provides a generic implementation of a KLibFactory , for use with shared library components.
It implements the pure virtual createObject method of KLibFactory and instantiates objects of the specified class (template argument) when the class name argument of createObject matches a class name in the given hierarchy.
In case you are developing a KParts component, skip this file and go directly to KParts::GenericFactory .
Note that the class specified as template argument needs to provide a certain constructor:
-
If the class is derived from QObject then it needs to have a constructor like:
MyClass( QObject *parent, const char *name, const QStringList &args );
-
If the class is derived from QWidget then it needs to have a constructor like:
MyWidget( QWidget *parent, const char *name, const QStringList &args);
-
If the class is derived from KParts::Part then it needs to have a constructor like:
MyPart( QWidget *parentWidget, const char *widgetName, QObject *parent, const char *name, const QStringList &args );
In addition upon instantiation this template provides a central KInstance object for your component, accessible through the static instance() method. The instanceName argument of the KGenericFactory constructor is passed to the KInstance object.
The creation of the KInstance object can be customized by inheriting from this template class and re-implementing the virtual createInstance method. For example it could look like this:
KInstance *MyFactory::createInstance() { return new KInstance( myAboutData ); }
Example of usage of the whole template:
class MyPlugin : public KParts::Plugin { Q_ OBJECT public: MyPlugin( QObject *parent, const char *name, const QStringList &args ); ... }; K_EXPORT_COMPONENT_FACTORY( libmyplugin, KGenericFactory<MyPlugin> )
Definition at line 173 of file kgenericfactory.h.
Constructor & Destructor Documentation
KGenericFactory< Product, ParentType >::KGenericFactory | ( | const char * | instanceName = 0 |
) | [inline] |
Definition at line 176 of file kgenericfactory.h.
KGenericFactory< Product, ParentType >::KGenericFactory | ( | const KAboutData * | data | ) | [inline] |
Member Function Documentation
virtual QObject* KGenericFactory< Product, ParentType >::createObject | ( | QObject * | parent, | |
const char * | name, | |||
const char * | className, | |||
const QStringList & | args | |||
) | [inline, protected, virtual] |
Creates a new object.
The returned object has to be derived from the requested classname.
It is valid behavior to create different kinds of objects depending on the requested className
. For example a koffice library may usually return a pointer to KoDocument. But if asked for a "QWidget", it could create a wrapper widget, that encapsulates the Koffice specific features.
This function is called by create()
- Parameters:
-
parent the parent of the QObject, 0 for no parent name the name of the QObject, 0 for no name className the name of the class args a list of arguments
Implements KLibFactory.
Definition at line 189 of file kgenericfactory.h.
The documentation for this class was generated from the following file: