#include <pluginloader.h>

Inheritance diagram for PluginLoader< T, T_config >:

Public Member Functions
virtual	~PluginLoader ()

virtual T *	createForName (const QString &type) const

virtual void	scan ()

Public Member Functions inherited from PluginLoaderBase
const PluginMetaData *	infoForName (const QString &type) const

QStringList	types () const

Static Public Member Functions
static PluginLoader< T, T_config > *	instance ()

Protected Member Functions
	PluginLoader ()

Protected Member Functions inherited from PluginLoaderBase
	PluginLoaderBase ()

virtual	~PluginLoaderBase ()

void	doScan (const char *path)

KLibrary::void_function_ptr	mainFunc (const QString &type, const char *main_func) const

Detailed Description

template<typename T, typename T_config>
class PluginLoader< T, T_config >

A generic plugin loader for when KPart::Plugin is overkill.

Author: Marc Mutz mutz@.nosp@m.kde..nosp@m.org based on KABC's FormatFactory

This is a generic plugin loader / factory for small plugins that don't want to be QObjects.

Usage

A PluginLoader takes two template arguments, T and T_config:

T: The type of object to return
T_config::mainfunc: The suffix of the factory function to call in the library to obtain a new object of type T. The string passed to KLibrary::symbol() is libName_mainfunc.
T_config::path: The search pattern for .desktop files containing the plugin descriptions. This is the string passed as the filter argument to KStandardDirs::findAllResources.

The last two parameters being strings, they are passed via an encapsulating class, of which mainfunc and path are public static members:

struct MyObjectPluginLoaderConfig {
  static const char * const mainfunc;
  static const char * const path;
};
const char * const MyObjectPluginLoaderConfig::mainfunc = "myapp_create_myobject";
const char * const MyObjectPluginLoaderConfig::path = "myapp/plugins/ *.desktop";

You would then use a typedef to create a less unwieldy name for your plugin loader:

typedef PluginLoader< MyObject, MyObjectPluginLoaderConfig > MyObjectPluginLoader;

All of this is what the DEFINE_PLUGIN_LOADER(pluginloadername,type,mainfunc,path) macro achieves.

Definition at line 78 of file pluginloader.h.