Spm::Plugin::Plugin Class Reference

#include <plugin.h>

Inheritance diagram for Spm::Plugin::Plugin:

List of all members.

Public Member Functions
const miniXml::ustring &	getDescription ()
const boost::filesystem::path &	getPath ()
pluginType_e	getType ()
const miniXml::ustring &	getDescription () const
const boost::filesystem::path &	getPath () const
pluginType_e	getType () const
const miniXml::ustring &	getVersion ()
const miniXml::ustring &	getVersion () const
const miniXml::ustring &	getAuthor ()
const miniXml::ustring &	getAuthor () const
const license_e &	getLicense ()
const license_e &	getLicense () const
bool	enabled ()
bool	enabled () const
const std::map< miniXml::ustring, miniXml::ustring > &	getPluginOptions ()
const std::map< miniXml::ustring, miniXml::ustring > &	getPluginOptions () const
void	enable ()
	Enable the plugin.
void	disable ()
	disable the plugin
bool	operator< (const Plugin &p) const
Static Public Member Functions
static Plugin *	isAPlugin (const boost::filesystem::path &aFile) throw (NotAPluginException)
	Check if a file is a Plugin.
Friends
class	PluginManager
struct	equalDownloaderHandler
struct	equalInstallerHandlerByUrl
struct	equalInstallerHandlerByCompressed
Plugin *	convertXmlToPlugin (const miniXml::Element *pluginElement)

---

Member Function Documentation

static Plugin* Spm::Plugin::Plugin::isAPlugin

(

const boost::filesystem::path &

aFile

)

throw (NotAPluginException) [static]

Check if a file is a Plugin.

Parameters:

	aFile	the file to check
	p	The Plugin to create

Returns:

A new Plugin object. NULL if the file is not a Plugin

const miniXml::ustring& Spm::Plugin::Plugin::getDescription

(

)

Returns:

The description of the Plugin

const boost::filesystem::path& Spm::Plugin::Plugin::getPath

(

)

Returns:

The path of the Plugin

pluginType_e Spm::Plugin::Plugin::getType

(

)

Returns:

The type of the Plugin

const miniXml::ustring& Spm::Plugin::Plugin::getDescription

(

)

const

Returns:

The description of the Plugin

const boost::filesystem::path& Spm::Plugin::Plugin::getPath

(

)

const

Returns:

The path of the Plugin

pluginType_e Spm::Plugin::Plugin::getType

(

)

const

Returns:

The type of the Plugin

const miniXml::ustring& Spm::Plugin::Plugin::getVersion

(

)

Returns:

The version of the Plugin

const miniXml::ustring& Spm::Plugin::Plugin::getVersion

(

)

const

Returns:

The version of the Plugin

const miniXml::ustring& Spm::Plugin::Plugin::getAuthor

(

)

Returns:

The author of the Plugin

const miniXml::ustring& Spm::Plugin::Plugin::getAuthor

(

)

const

Returns:

The author of the Plugin

const license_e& Spm::Plugin::Plugin::getLicense

(

)

Returns:

The license of the Plugin

const license_e& Spm::Plugin::Plugin::getLicense

(

)

const

Returns:

The license of the Plugin

bool Spm::Plugin::Plugin::enabled

(

)

Returns:

true if the plugin is enable

bool Spm::Plugin::Plugin::enabled

(

)

const

const std::map<miniXml::ustring, miniXml::ustring>& Spm::Plugin::Plugin::getPluginOptions

(

)

Returns:

The options accepted by this Plugin

const std::map<miniXml::ustring, miniXml::ustring>& Spm::Plugin::Plugin::getPluginOptions

(

)

const

Returns:

The options accepted by this Plugin

void Spm::Plugin::Plugin::enable

(

)

Enable the plugin.

void Spm::Plugin::Plugin::disable

(

)

disable the plugin

bool Spm::Plugin::Plugin::operator<

(

const Plugin &

p

)

const

---

Friends And Related Function Documentation

friend class PluginManager [friend]

friend struct equalDownloaderHandler [friend]

friend struct equalInstallerHandlerByUrl [friend]

friend struct equalInstallerHandlerByCompressed [friend]

Plugin* convertXmlToPlugin

(

const miniXml::Element *

pluginElement

)

[friend]

---

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

• /home/elche/Prog/Projects/spm-0.8/src/include/plugin/plugin.h

---