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

KParts

  • KParts
  • Factory
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
KParts::Factory Class Referenceabstract

#include <factory.h>

Inheritance diagram for KParts::Factory:
KPluginFactory QObject KParts::GenericFactoryBase< T1 > KParts::GenericFactoryBase< T > KParts::GenericFactory< KTypeList< T1, T2 > > KParts::GenericFactory< T >

Public Member Functions

 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())
 

Static Public Member Functions

static KComponentData partComponentDataFromLibrary (const QString &libraryName)
 

Protected Member Functions

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)
 

Additional Inherited Members

- Signals inherited from KPluginFactory
void objectCreated (QObject *object)
 
- Protected Types inherited from KPluginFactory
typedef QObject *(* CreateInstanceFunction) (QWidget *, QObject *, const QVariantList &)
 
- 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

A generic factory object to create a Part.

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

See also
KLibFactory.

Definition at line 42 of file factory.h.

Constructor & Destructor Documentation

◆ Factory()

Factory::Factory ( QObject *  parent = 0)

Definition at line 35 of file factory.cpp.

◆ ~Factory()

Factory::~Factory ( )
virtual

Definition at line 40 of file factory.cpp.

Member Function Documentation

◆ createObject()

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

Reimplemented from KLibFactory.

Calls createPart()

Reimplemented from KPluginFactory.

Definition at line 75 of file factory.cpp.

◆ createPart()

Part * Factory::createPart ( QWidget *  parentWidget = 0,
QObject *  parent = 0,
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>
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.

createPart() automatically emits a signal KLibFactory::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 44 of file factory.cpp.

◆ createPartObject()

Part * Factory::createPartObject ( QWidget *  parentWidget = 0,
QObject *  parent = 0,
const char *  classname = "KParts::Part",
const QStringList &  args = QStringList() 
)
protectedpure 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 >, and KParts::GenericFactory< KTypeList< T1, T2 > >.

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 52 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
libraryNamename of the library to query the instance from

Definition at line 57 of file factory.cpp.


The documentation for this class was generated from the following files:
  • factory.h
  • factory.cpp
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