Manages the registry of plugins. More...
#include <libvisual/lv_plugin_registry.h>
Inheritance diagram for LV::PluginRegistry:
Collaboration diagram for LV::PluginRegistry:
Public Member Functions | |
| PluginRegistry (PluginRegistry const &)=delete | |
| virtual | ~PluginRegistry () |
| Destructor. | |
| void | add_path (std::string const &path) |
| Adds an extra plugin search path. More... | |
| PluginRef const * | find_plugin (PluginType type, std::string const &name) const |
| bool | has_plugin (PluginType type, std::string const &name) const |
| Checks if a plugin is available. More... | |
| PluginList const & | get_plugins () const |
| Returns the list of all available plugins. More... | |
| PluginList const & | get_plugins_by_type (PluginType type) const |
| Returns the list of all available plugins of a given type. More... | |
| VisPluginInfo const * | get_plugin_info (PluginType type, std::string const &name) const |
| Returns information on a plugin. More... | |
 Public Member Functions inherited from LV::Singleton< PluginRegistry > | |
| Singleton (Singleton const &)=delete | |
| Singleton const & | operator= (Singleton const &)=delete |
| virtual | ~Singleton () |
| Destructor. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from LV::Singleton< PluginRegistry > | |
| static PluginRegistry * | instance () |
| Returns the singleton instance. More... | |
| static void | destroy () |
| Destroys the singleton instance. | |
| Static Protected Attributes inherited from LV::Singleton< PluginRegistry > | |
| static PluginRegistry * | m_instance |
Detailed Description
Manages the registry of plugins.
- Note
- This is a singleton class. Its only instance must be accessed via the instance() method.
Definition at line 23 of file lv_plugin_registry.h.
Member Function Documentation
| void LV::PluginRegistry::add_path | ( | std::string const & | path | ) |
Adds an extra plugin search path.
- Parameters
-
path Path to plugin directory
Definition at line 116 of file lv_plugin_registry.cpp.
| VisPluginInfo const * LV::PluginRegistry::get_plugin_info | ( | PluginType | type, |
| std::string const & | name | ||
| ) | const |
Returns information on a plugin.
- Parameters
-
type Type of plugin name Name of plugin
- Returns
- Plugin information
Definition at line 158 of file lv_plugin_registry.cpp.
Referenced by visual_plugin_load().
| PluginList const& LV::PluginRegistry::get_plugins | ( | ) | const |
Returns the list of all available plugins.
- Returns
- List of plugins
| PluginList const & LV::PluginRegistry::get_plugins_by_type | ( | PluginType | type | ) | const |
Returns the list of all available plugins of a given type.
- Parameters
-
type Type of plugin
- Returns
- List of plugins of the given type
Definition at line 147 of file lv_plugin_registry.cpp.
| bool LV::PluginRegistry::has_plugin | ( | PluginType | type, |
| std::string const & | name | ||
| ) | const |
Checks if a plugin is available.
- Parameters
-
type Type of plugin name Name of plugin
- Returns
- Returns true if plugin is available, false otherwise
Definition at line 142 of file lv_plugin_registry.cpp.
The documentation for this class was generated from the following files: