PluginList Class Reference

#include <pluginsupport.h>

List of all members.

Public Member Functions
	~PluginList ()
void	pluginDirLookup (const char *szDirectory)
void	callByName (FrameBuffer &fb, std::string pluginName, std::string args)
Static Public Member Functions
static PluginList *	ptr ()
static void	destroy ()
Protected Member Functions
	PluginList ()
Friends
class	DocMenu
	Needed for plugin names reading.
Classes
struct	ErrPluginDir
struct	ErrPluginEC
struct	ErrPluginNotFound

---

Detailed Description

Plugin list. Design pattern singleton.

Definition at line 20 of file pluginsupport.h.

---

Constructor & Destructor Documentation

PluginList::~PluginList

(

)

PluginList::PluginList

(

)

[inline, protected]

Singleton PluginList can't be allocated static. Use PluginList::ptr() method to obtain singleton address.

Definition at line 82 of file pluginsupport.h.

---

Member Function Documentation

static PluginList* PluginList::ptr

(

)

[static]

Access point to singleton.

Returns:

Return pointer to singleton object.

static void PluginList::destroy

(

)

[static]

Destroy plugin list singleton. This should be called on program exit.

void PluginList::pluginDirLookup

(

const char *

szDirectory

)

Lookup for plugins. Can be called repeatly to add plugins from different directories. This method throws PluginList::ErrPluginDir exception if directory can't be opened.

Parameters:

szDirectory

Directory to lookup for plugins.

void PluginList::callByName	(	FrameBuffer &	fb,
		std::string	pluginName,
		std::string	args
	)

Call plugin. This method throws PluginList::ErrPluginNotFound exception if pluginName is not valid. It can also throw PluginList::ErrPluginEC exception if plugin exits with an error.

Parameters:

	fb	Frame buffer to work with.
	pluginName	Name (identification) of plugin.
	args	Argumets passed to plugin.

---

Friends And Related Function Documentation

friend class DocMenu [friend]

Needed for plugin names reading.

Definition at line 76 of file pluginsupport.h.

---

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

• pluginsupport.h

---