ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Abstract base class for the plugin system. More...

#include <plugins.h>

Inheritance diagram for Plugin:
Collaboration diagram for Plugin:

List of all members.

Public Member Functions

 Plugin ()
virtual ~Plugin ()
virtual bool loadPlugin ()=0
virtual void unloadPlugin ()=0
PluginType getType () const
 The following functions query information from the plugin object once it's loaded into memory.
const char * getName () const
template<class T >
T & get () const
virtual const char * getFileName () const
 The getFileName() function gets the name of the plugin file for those plugins that have files (ie.

Protected Attributes

PluginObject_pluginObject
PluginType _type

Detailed Description

Abstract base class for the plugin system.

Subclasses for this can be used to wrap both static and dynamic plugins. This class refers to a plugin which may or may not be loaded in memory.

Definition at line 170 of file plugins.h.


Constructor & Destructor Documentation

Plugin::Plugin (  )  [inline]

Definition at line 176 of file plugins.h.

virtual Plugin::~Plugin (  )  [inline, virtual]

Definition at line 177 of file plugins.h.


Member Function Documentation

template<class T >
T& Plugin::get (  )  const [inline]

Definition at line 194 of file plugins.h.

virtual const char* Plugin::getFileName (  )  const [inline, virtual]

The getFileName() function gets the name of the plugin file for those plugins that have files (ie.

not static). It doesn't require the plugin object to be loaded into memory, unlike getName()

Reimplemented in DynamicPlugin.

Definition at line 207 of file plugins.h.

const char * Plugin::getName (  )  const

Definition at line 48 of file plugins.cpp.

PluginType Plugin::getType (  )  const

The following functions query information from the plugin object once it's loaded into memory.

Definition at line 44 of file plugins.cpp.

virtual bool Plugin::loadPlugin (  )  [pure virtual]

Implemented in DynamicPlugin, SDLPlugin, and StaticPlugin.

virtual void Plugin::unloadPlugin (  )  [pure virtual]

Implemented in DynamicPlugin, SDLPlugin, and StaticPlugin.


Member Data Documentation

Definition at line 172 of file plugins.h.

Definition at line 173 of file plugins.h.


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


Generated on Sat May 25 2019 05:04:07 for ResidualVM by doxygen 1.7.1
curved edge   curved edge