KPluginLoader

KDE 4.7 PyKDE API Reference

- KDE's Python API

# KPluginLoader Class Reference

`from PyKDE4.kdecore import *`

Inherits: QPluginLoader → QObject

## Detailed Description

\class KPluginLoader kpluginloader.h <KPluginLoader>

This class can be used to dynamically load a plugin library at runtime.

This class makes sure that the Qt and KDE versions used to compile this library aren't newer then the ones currently used.

This class is reentrant, you can load plugins from different threads. You can also have multiple PluginLoaders for one library without negative effects. The object obtained with factory() or the inherited method QPluginLoader.instance() is cached inside the library. If you call factory() or instance() multiple times, you will always get the same object, even from different threads and different KPluginLoader instances. You can delete this object easily, a new one will be created if factory() or instance() is called afterwards. factory() uses instance() internally.

KPluginLoader inherits QPluginLoader.unload(). It is safe to call this method if you loaded a plugin and decide not to use it for some reason. But as soon as you start to use the factory from the plugin, you should stay away from it. It's nearly impossible to keep track of all objects created directly or indirectly from the plugin and all other pointers into plugin code. Using unload() in this case is asking for trouble. If you really need to unload your plugins, you have to take care to convert the clipboard content to text, because the plugin could have registered a custom mime source. You also have to delete the factory of the plugin, otherwise you will create a leak. The destructor of KPluginLoader doesn't call unload.

Sample code:

      KPluginLoader loader( ...library or kservice... );
      KPluginFactory* factory = loader.factory();
      if (!factory) {
          kWarning() << "Error loading plugin:" << loader.errorString();
      } else {
          MyInterface* obj = factory->create<MyInterface>();
          if (!obj) {
              kWarning() << "Error creating object";
          }
      }

See also:
  KPluginFactory

Author:
  Bernhard Loos <nhuh.put@web.de>

## Methods
| __init__ (self, QString plugin, KComponentData componentdata=KGlobal.mainComponent(), QObject parent=0)
| __init__ (self, KService service, KComponentData componentdata=KGlobal.mainComponent(), QObject parent=0)
| __init__ (self, KPluginLoader a0)
QString | errorString (self)
KPluginFactory | factory (self)
bool | isLoaded (self)
bool | load (self)
QString | pluginName (self)
long | pluginVersion (self)

## Method Documentation

__init__ | ( | self, |
|  | QString | plugin,
|  | KComponentData | componentdata=KGlobal.mainComponent(),
|  | QObject | parent=0
| ) |  |  |

Used this constructor to load a plugin with a given library name. Plugin libraries shouldn't have a 'lib' prefix.

errorString() will be set if problems are encountered.

Parameters:

  | plugin | The name of the plugin library.

Parameters:

  | componentdata | The KStandardDirs object from componentdata is used to search the library.

Parameters:

  | parent | A parent object.

__init__ | ( | self, |
|  | KService | service,
|  | KComponentData | componentdata=KGlobal.mainComponent(),
|  | QObject | parent=0
| ) |  |  |

Used this constructor to load a plugin from a service. The service must contain a library.

errorString() will be set if problems are encountered.

Parameters:

  | service | The service for which the library should be loaded.

Parameters:

  | componentdata | The KStandardDirs object from componentdata is used to search the library.

Parameters:

  | parent | A parent object.

__init__ | ( | self, |
|  | KPluginLoader | a0
| ) |  |  |

QString errorString | ( |  | self ) |

Queries the last error.

Returns:
  The description of the last error.

KPluginFactory factory | ( |  | self ) |

Used to obtain the factory object of the plugin. You have to give a class which inherits KPluginFactory to K_EXPORT_PLUGIN to use this method.

Returns:
  The factory of the plugin or 0 on error.

bool isLoaded | ( |  | self ) |

bool load | ( |  | self ) |

Performs the loading of the plugin.

QString pluginName | ( |  | self ) |

The name of this plugin as given to the constructor.

Returns:
  the plugin name

long pluginVersion | ( |  | self ) |

Queries the plugin version.

Returns:
  The version given to K_EXPORT_PLUGIN_VERSION or (quint32) -1 if not set.