cnoid::Plugin Class Reference

#include <Plugin.h>

Inheritance diagram for cnoid::Plugin:

Public Types
typedef Plugin *(*	PluginEntry) ()

Public Member Functions
	Plugin (const std::string &name)
virtual	~Plugin ()
const std::string &	name () const
const std::string &	filePath () const
virtual bool	initialize ()
virtual bool	finalize ()
bool	isActive () const
bool	isUnloadable () const
const std::string &	requisite (int index) const
int	numRequisites () const
const std::string &	subsequence (int index) const
int	numSubsequences () const
const std::string &	oldName (int index) const
int	numOldNames () const
virtual const char *	description () const
int	activationPriority () const
unsigned int	internalVersion () const
void	setInternalVersion (unsigned int version)
Public Member Functions inherited from cnoid::ExtensionManager
	ExtensionManager (const std::string &moduleName, bool isPlugin)
	ExtensionManager (const std::string &moduleName, const std::string &version, bool isPlugin)
virtual	~ExtensionManager ()
const std::string &	name () const
const std::string &	textDomain () const
ItemManager &	itemManager ()
ViewManager &	viewManager ()
MenuManager &	menuManager ()
OptionManager &	optionManager ()
void	addToolBar (ToolBar *toolBar)
void	mountToolBar (ToolBar *toolBar)
template<class PointerType >
PointerType	manage (PointerType pointer)
SignalProxy< void()>	sigSystemUpdated ()
SignalProxy< void()>	sigReleaseRequest ()
void	setProjectArchiver (const std::string &name, std::function< bool(Archive &)> storeFunction, std::function< void(const Archive &)> restoreFunction)
void	setProjectArchiver (std::function< bool(Archive &)> storeFunction, std::function< void(const Archive &)> restoreFunction)

Protected Member Functions
void	setPluginScope (Item *item)
void	setPluginScope (View *view)
void	setPluginScope (ToolBar *toolBar)
void	setUnloadable (bool on)
void	require (const std::string &pluginName)
void	precede (const std::string &pluginName)
void	setActivationPriority (int priority)
void	addOldName (const std::string &name)

Static Protected Member Functions
static const char *	MITLicenseText ()
static const char *	LGPLtext ()

Friends
class	PluginManager

Additional Inherited Members
Static Public Member Functions inherited from cnoid::ExtensionManager
static void	notifySystemUpdate ()

Member Typedef Documentation

PluginEntry

typedef Plugin*(* cnoid::Plugin::PluginEntry) ()

Constructor & Destructor Documentation

Plugin()

Plugin::Plugin

(

const std::string &

name

)

~Plugin()

Plugin::~Plugin ( )

virtual

Member Function Documentation

activationPriority()

int Plugin::activationPriority

(

)

const

addOldName()

void Plugin::addOldName ( const std::string &  name )

protected

When the plugin name is changed but the old project files should be loadable, specify old names of the plugin with this function in the constructor.

description()

const char * Plugin::description ( ) const

virtual

filePath()

const std::string & Plugin::filePath

(

)

const

finalize()

bool Plugin::finalize ( )

virtual

Reimplemented in cnoid::PythonPlugin.

initialize()

bool Plugin::initialize ( )

virtual

Reimplemented in cnoid::PythonPlugin.

internalVersion()

unsigned int Plugin::internalVersion

(

)

const

isActive()

bool cnoid::Plugin::isActive ( ) const

inline

isUnloadable()

bool Plugin::isUnloadable

(

)

const

LGPLtext()

const char * Plugin::LGPLtext ( )

staticprotected

MITLicenseText()

const char * Plugin::MITLicenseText ( )

staticprotected

name()

const std::string & Plugin::name

(

)

const

numOldNames()

int Plugin::numOldNames

(

)

const

numRequisites()

int Plugin::numRequisites

(

)

const

numSubsequences()

int Plugin::numSubsequences

(

)

const

oldName()

const std::string & Plugin::oldName

(

int

index

)

const

precede()

void Plugin::precede ( const std::string &  pluginName )

protected

require()

void Plugin::require ( const std::string &  pluginName )

protected

When the plugin depends on some other plugins, please specify the plugins to depend with this function in the constructor.

requisite()

const string & Plugin::requisite

(

int

index

)

const

setActivationPriority()

void Plugin::setActivationPriority ( int  priority )

protected

Call this function in the constructor if necessary.

Parameters

priority

A smaller value means a higher priority. The default value is the maximum integer value. The value 0 is set for fundamental plugins which should be initialized before extra plugins.

setInternalVersion()

void Plugin::setInternalVersion

(

unsigned int

version

)

setPluginScope() [1/3]

void cnoid::Plugin::setPluginScope ( Item *  item )

protected

setPluginScope() [2/3]

void cnoid::Plugin::setPluginScope ( ToolBar *  toolBar )

protected

setPluginScope() [3/3]

void cnoid::Plugin::setPluginScope ( View *  view )

protected

setUnloadable()

void Plugin::setUnloadable ( bool  on )

protected

subsequence()

const std::string & Plugin::subsequence

(

int

index

)

const

Friends And Related Function Documentation

PluginManager

friend class PluginManager

friend

---

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

• Plugin.h
• Plugin.cpp