• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KParts

KParts::GenericFactory

KParts::GenericFactory< T > Class Template Reference

A template for a KParts::Factory implementation. More...

#include <genericfactory.h>

Inheritance diagram for KParts::GenericFactory< T >:

Inheritance graph
[legend]

List of all members.


Public Member Functions

virtual KParts::Part * createPartObject (QWidget *parentWidget, QObject *parent, const char *className, const QStringList &args)
 GenericFactory ()

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 )
yourlibrary is the library name that you compiled your KPart into.

Definition at line 108 of file genericfactory.h.


Constructor & Destructor Documentation

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

Definition at line 111 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 
) [inline, 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.

Implements KParts::Factory.

Definition at line 113 of file genericfactory.h.


The documentation for this class was generated from the following file:
  • genericfactory.h

KParts

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal