OpenGUI::PluginManager Class Reference

#include <OpenGUI_PluginManager.h>

Detailed Description

Plugin manager for tracking the proper loading and unloading of plugins.

Note:

All plugins are given a chance for notification when they are loaded and unloaded. Plugins that wish to receive this notification need to export:

void pluginStart(void);
void pluginStop(void);

Remarks:: Depending on how OpenGUI was configured when compiled the plugin system may perform varying degrees of filename mangling. An explanation and the current setting can be found in OpenGUI_CONFIG.h. To help explain how this works, the comment from that section of the config file is available here.

Public Member Functions

void loadPlugin (String filename)

Loads a plugin by filename.

void unloadPlugin (String filename)

Unloads a plugin by filename.

void unloadAllPlugins ()

Unloads all currently loaded plugins.

Static Public Member Functions

static PluginManager & getSingleton (void)

Retrieve the current singleton, if one exists. If none exists, this will cause an error.

static PluginManager * getSingletonPtr (void)

Retrieve a pointer to the current singleton, if one exists. If none exists, this will return 0.

Member Function Documentation

PluginManager & OpenGUI::PluginManager::getSingleton ( void ) [static]

Retrieve the current singleton, if one exists. If none exists, this will cause an error.

PluginManager * OpenGUI::PluginManager::getSingletonPtr ( void ) [static]

Retrieve a pointer to the current singleton, if one exists. If none exists, this will return 0.

void OpenGUI::PluginManager::loadPlugin ( String filename )

Loads a plugin by filename.

void OpenGUI::PluginManager::unloadAllPlugins ( )

Unloads all currently loaded plugins.

void OpenGUI::PluginManager::unloadPlugin ( String filename )

Unloads a plugin by filename.

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

OpenGUI_PluginManager.h
OpenGUI_PluginManager.cpp


Public Member Functions
void	loadPlugin (String filename)
	Loads a plugin by filename.
void	unloadPlugin (String filename)
	Unloads a plugin by filename.
void	unloadAllPlugins ()
	Unloads all currently loaded plugins.
Static Public Member Functions
static PluginManager &	getSingleton (void)
	Retrieve the current singleton, if one exists. If none exists, this will cause an error.
static PluginManager *	getSingletonPtr (void)
	Retrieve a pointer to the current singleton, if one exists. If none exists, this will return 0.