KGenericFactory< Product, ParentType > Class Template Reference

#include <KGenericFactory>

Inheritance diagram for KGenericFactory< Product, ParentType >:

Public Member Functions
	KGenericFactory (const char *componentName=0, const char *catalogName=0)
	KGenericFactory (const KAboutData *data)
Public Member Functions inherited from KGenericFactoryBase< Product >
	KGenericFactoryBase (const char *componentName, const char *catalogName)
	KGenericFactoryBase (const KAboutData *data)
virtual	~KGenericFactoryBase ()
Public Member Functions inherited from KPluginFactory
	KPluginFactory (const char *componentName=0, const char *catalogName=0, QObject *parent=0)
	KPluginFactory (const KAboutData &aboutData, QObject *parent=0)
KDE_CONSTRUCTOR_DEPRECATED	KPluginFactory (const KAboutData *aboutData, QObject *parent=0)
KDE_CONSTRUCTOR_DEPRECATED	KPluginFactory (QObject *parent)
virtual	~KPluginFactory ()
KComponentData	componentData () const
template<typename T >
T *	create (QObject *parent=0, const QVariantList &args=QVariantList())
template<typename T >
T *	create (const QString &keyword, QObject *parent=0, 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=0, const char *classname="QObject", const QStringList &args=QStringList())

Protected Member Functions
virtual QObject *	createObject (QObject *parent, const char *className, const QStringList &args)
Protected Member Functions inherited from KGenericFactoryBase< Product >
virtual KComponentData *	createComponentData ()
Protected Member Functions inherited from KPluginFactory
	KPluginFactory (KPluginFactoryPrivate &dd, QObject *parent=0)
virtual QObject *	create (const char *iface, QWidget *parentWidget, QObject *parent, const QVariantList &args, const QString &keyword)
virtual KParts::Part *	createPartObject (QWidget *parentWidget, QObject *parent, const char *classname, const QStringList &args)
template<class T >
void	registerPlugin (const QString &keyword=QString(), CreateInstanceFunction instanceFunction=InheritanceChecker< T >().createInstanceFunction(reinterpret_cast< T * >(0)))
void	setComponentData (const KComponentData &componentData)
virtual void	setupTranslations ()
QVariantList	stringListToVariantList (const QStringList &list)
QStringList	variantListToStringList (const QVariantList &list)

Additional Inherited Members
Signals inherited from KPluginFactory
void	objectCreated (QObject *object)
Static Public Member Functions inherited from KGenericFactoryBase< Product >
static KComponentData	componentData ()
Protected Types inherited from KPluginFactory
typedef QObject *(*	CreateInstanceFunction )(QWidget *, QObject *, const QVariantList &)
Static Protected Member Functions inherited from KPluginFactory
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)
Protected Attributes inherited from KPluginFactory
KPluginFactoryPrivate *const	d_ptr
Related Functions inherited from KPluginFactory
#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_DEFINITION(name, pluginRegistrations)   K_PLUGIN_FACTORY_DEFINITION_WITH_BASEFACTORY(name, KPluginFactory, pluginRegistrations)

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 QStringList &args );
• If the class is derived from QWidget then it needs to have a constructor like: MyWidget( QWidget *parent, const QStringList &args);
• If the class is derived from KParts::Part then it needs to have a constructor like: MyPart( QWidget *parentWidget, QObject *parent, const QStringList &args );

The args QStringList passed to the constructor is the args string list that the caller passed to KLibFactory's create method.

In addition upon instantiation this template provides a central KComponentData object for your component, accessible through the static componentData() method. The componentName and catalogName arguments of the KGenericFactory constructor are passed to the KComponentData object.

The creation of the KComponentData object can be customized by inheriting from this template class and re-implementing the virtual createComponentData method. For example it could look like this:

KComponentData *MyFactory::createComponentData()
{
    return new KComponentData( myAboutData );
}

Example of usage of the whole template:

class MyPlugin : public KParts::Plugin
{
    Q_ OBJECT
public:
    MyPlugin( QObject *parent, const QStringList &args );
    ...
};

K_EXPORT_COMPONENT_FACTORY( libmyplugin, KGenericFactory<MyPlugin> )

Deprecated:

use KPluginFactory

It implements the pure virtual createObject method of KLibFactory and instantiates objects of the specified classes in the given typelist template argument when the class name argument of createObject matches a class names in the given hierarchy of classes.

Note that each class in the specified in the typelist 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 QStringList &args );
• If the class is derived from QWidget then it needs to have a constructor like: MyWidget( QWidget *parent, const QStringList &args);
• If the class is derived from KParts::Part then it needs to have a constructor like: MyPart( QWidget *parentWidget, QObject *parent, const QStringList &args );

The args QStringList passed to the constructor is the args string list that the caller passed to KLibFactory's create method.

In addition upon instantiation this template provides a central KComponentData object for your component, accessible through the static componentData() method. The componentName and catalogName arguments of the KGenericFactory constructor are passed to the KComponentData object.

The creation of the KComponentData object can be customized by inheriting from this template class and re-implementing the virtual createComponentData method. For example it could look like this:

KComponentData *MyFactory::createComponentData()
{
    return new KComponentData( myAboutData );
}

Example of usage of the whole template:

class MyPlugin : public KParts::Plugin
{
    Q_ OBJECT
public:
    MyPlugin( QObject *parent,
              const QStringList &args );
    ...
};

class MyDialogComponent : public KDialog
{
    Q_ OBJECT
public:
    MyDialogComponent( QWidget *parentWidget,
                       const QStringList &args );
    ...
};

typedef K_TYPELIST_2( MyPlugin, MyDialogComponent ) Products;
K_EXPORT_COMPONENT_FACTORY( libmyplugin, KGenericFactory<Products> )

It implements the pure virtual createObject method of KLibFactory and instantiates objects of the specified classes in the given typelist template argument when the class name argument of createObject matches a class names in the given hierarchy of classes.

Note that each class in the specified in the typelist 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 QStringList &args );
• If the class is derived from QWidget then it needs to have a constructor like: MyWidget( QWidget *parent, const QStringList &args);
• If the class is derived from KParts::Part then it needs to have a constructor like: MyPart( QWidget *parentWidget, QObject *parent, const QStringList &args );

The args QStringList passed to the constructor is the args string list that the caller passed to KLibFactory's create method.

In addition upon instantiation this template provides a central KComponentData object for your component, accessible through the static componentData() method. The componentName and catalogNames arguments of the KGenericFactory constructor are passed to the KComponentData object.

The creation of the KComponentData object can be customized by inheriting from this template class and re-implementing the virtual createComponentData method. For example it could look like this:

KComponentData *MyFactory::createComponentData()
{
    return new KComponentData( myAboutData );
}

Example of usage of the whole template:

class MyPlugin : public KParts::Plugin
{
    Q_ OBJECT
public:
    MyPlugin( QObject *parent,
              const QStringList &args );
    ...
};

class MyDialogComponent : public KDialog
{
    Q_ OBJECT
public:
    MyDialogComponent( QWidget *parentWidget,
                       const QStringList &args );
    ...
};

typedef K_TYPELIST_2( MyPlugin, MyDialogComponent ) Products;
K_EXPORT_COMPONENT_FACTORY( libmyplugin, KGenericFactory<Products> )

Definition at line 152 of file kgenericfactory.h.

Constructor & Destructor Documentation

template<class Product , class ParentType = QObject>

KGenericFactory< Product, ParentType >::KGenericFactory ( const char *  componentName = 0, const char *  catalogName = 0  )

inlineexplicit

Definition at line 155 of file kgenericfactory.h.

template<class Product , class ParentType = QObject>

KGenericFactory< Product, ParentType >::KGenericFactory ( const KAboutData *  data )

inlineexplicit

Definition at line 159 of file kgenericfactory.h.

Member Function Documentation

template<class Product , class ParentType = QObject>

virtual QObject* KGenericFactory< Product, ParentType >::createObject ( QObject *  parent, const char *  className, const QStringList &  args  )

inlineprotectedvirtual

Deprecated:

Reimplemented from KPluginFactory.

Definition at line 164 of file kgenericfactory.h.

---

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

• kgenericfactory.h