IPluginAdaptor Class Reference

This class is used to provide plugins for LeechCraft from additional sources. More...

#include "ipluginadaptor.h"

Public Member Functions
virtual	~IPluginAdaptor ()
virtual QList< QObject * >	GetPlugins ()=0
	Returns the list of plugins provided by this adaptor. More...

Detailed Description

This class is used to provide plugins for LeechCraft from additional sources.

By default, LeechCraft core loads plugins only from the dynamic shared objects (.so on *nix, .dll on Windows, .dylib on Mac OS X) it finds in a set of platform-dependent predefined places. To provide additional plugins for LeechCraft, one should implement this plugin and return the set of plugin instances (analogous to the return value of QPluginLoader::instance() function) from the GetPlugins() function.

The returned objects should behave as normal LeechCraft plugin instances: each one should implement at least IInfo and whatever other interfaces it decides to. Successful qobject_cast() to IInfo is sufficient for the plugin object to be considered a valid LeechCraft plugin.

For example, the Qrosp plugin implements this interface in order to provide script plugins for LeechCraft. It creates a wrapper object for each script it finds. It also does some QMetaObject magic to provide corresponding (and unknown in advance) signals/slots for each script it wraps. Some trickery is also used to cast only to those interfaces that the script claims to provide.

Of course, each plugin adaptor should also implement at least IInfo.

Definition at line 40 of file ipluginadaptor.h.

Constructor & Destructor Documentation

~IPluginAdaptor()

virtual IPluginAdaptor::~IPluginAdaptor ( )

inlinevirtual

Definition at line 49 of file ipluginadaptor.h.

Member Function Documentation

GetPlugins()

virtual QList<QObject*> IPluginAdaptor::GetPlugins ( )

pure virtual

Returns the list of plugins provided by this adaptor.

Each object should be a valid LeechCraft plugin instance: it should be castable to IInfo at least.

This function must be callable before IInfo::Init() is called on the plugin. In fact, GetPlugins() would be called on every IPluginAdaptor before the initialization takes place, hence this requirement: it should return the proper list of plugin instances before Init().

Returns

The list of plugin instances provided by this adaptor.

---

The documentation for this class was generated from the following file:

• /home/d34df00d/leechcraft/src/interfaces/ipluginadaptor.h