• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KParts

  • KParts
  • GenericFactory
Public Member Functions | List of all members
KParts::GenericFactory< T > Class Template Reference

#include <genericfactory.h>

Inheritance diagram for KParts::GenericFactory< T >:
KParts::GenericFactoryBase< T > KParts::Factory KPluginFactory QObject

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())
 
virtual KComponentData partComponentData ()
 
- 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
 
T * create (const QString &keyword, QObject *parent=0, const QVariantList &args=QVariantList())
 
T * create (QObject *parent, const QStringList &args)
 
QObject * create (QObject *parent=0, const char *classname="QObject", const QStringList &args=QStringList())
 
T * create (QObject *parent=0, const QVariantList &args=QVariantList())
 
T * create (QWidget *parentWidget, QObject *parent, const QString &keyword=QString(), const QVariantList &args=QVariantList())
 

Additional Inherited Members

- Signals inherited from KPluginFactory
void objectCreated (QObject *object)
 
- 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)
 
- Protected Types inherited from KPluginFactory
typedef QObject *(* CreateInstanceFunction) (QWidget *, QObject *, const QVariantList &)
 
- 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())
 
virtual Part * createPartObject (QWidget *parentWidget=0, QObject *parent=0, const char *classname="KParts::Part", const QStringList &args=QStringList())=0
 
- 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 QObject * createObject (QObject *parent, const char *className, const QStringList &args)
 
virtual KParts::Part * createPartObject (QWidget *parentWidget, QObject *parent, const char *classname, const QStringList &args)
 
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)
 
- Static Protected Member Functions inherited from KPluginFactory
static QObject * createInstance (QWidget *parentWidget, QObject *parent, const QVariantList &args)
 
static QObject * createPartInstance (QWidget *parentWidget, QObject *parent, const QVariantList &args)
 
- Protected Attributes inherited from KPluginFactory
KPluginFactoryPrivate *const d_ptr
 

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&lt;YourKPart&gt; YourKPartFactory;
K_EXPORT_COMPONENT_FACTORY( yourlibrary, YourKPartFactory )
KParts::GenericFactory
A template for a KParts::Factory implementation.
Definition: genericfactory.h:111
K_EXPORT_COMPONENT_FACTORY
#define K_EXPORT_COMPONENT_FACTORY(libname, factory)

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

Definition at line 110 of file genericfactory.h.

Constructor & Destructor Documentation

◆ GenericFactory()

template<class T >
KParts::GenericFactory< T >::GenericFactory ( )
inline

Definition at line 113 of file genericfactory.h.

Member Function Documentation

◆ createPartObject()

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>
param
QString param(const QString &t)
name
const char * name(StandardAction id)

This could result in a call to

createPart( parentWidget, parentObject, "KParts::Part",
QStringList("name1="value1"", "name2="value2") );
KParts::Factory::createPart
Part * createPart(QWidget *parentWidget=0, QObject *parent=0, const char *classname="KParts::Part", const QStringList &args=QStringList())
Creates a part.
Definition: factory.cpp:44
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
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KParts

Skip menu "KParts"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal