tlp::PluginLoader Struct Reference

#include <PluginLoader.h>

Inheritance diagram for tlp::PluginLoader:

List of all members.

Public Member Functions
virtual void	aborted (const std::string &filename, const std::string &errormsg)=0
virtual void	finished (bool state, const std::string &msg)=0
virtual void	loaded (const Plugin *infos, const std::list< Dependency > &dependencies)=0
virtual void	loading (const std::string &filename)=0
virtual void	numberOfFiles (int)
virtual void	start (const std::string &path)=0

---

Detailed Description

A callback class when loading plugins into Tulip.

This interface can be subclassed and passed to the tlp::PluginLibraryLoader to implement custom event handling when loading plugins into Tulip

See also:

tlp::PluginLibraryLoader

tlp::PluginLoaderTxt

Definition at line 40 of file PluginLoader.h.

---

Member Function Documentation

virtual void tlp::PluginLoader::aborted	(	const std::string &	filename,
		const std::string &	errormsg
	)		[pure virtual]

Indicates that an error occurred when trying to load a file.

Parameters:

filename	The absolute path of where the error occured.
errormsg	A human-readable error message.

Implemented in tlp::PluginLoaderTxt.

virtual void tlp::PluginLoader::finished	(	bool	state,
		const std::string &	msg
	)		[pure virtual]

Indicates that a file has finished being loaded.

Parameters:

state	true if the file was loaded sucessfully
msg	An additional human-readable message about the load state

Implemented in tlp::PluginLoaderTxt.

virtual void tlp::PluginLoader::loaded	(	const Plugin *	infos,
		const std::list< Dependency > &	dependencies
	)		[pure virtual]

Indicates that a plugin has been loaded sucessfully.

Parameters:

infos	The Plugin object that has just been loaded
dependencies	The plugin dependencies

See also:

tlp::Dependency

Implemented in tlp::PluginLoaderTxt.

virtual void tlp::PluginLoader::loading

(

const std::string &

filename

)

[pure virtual]

Indicates that a new file is being loaded.

Parameters:

filename

The absolute path of the file

Implemented in tlp::PluginLoaderTxt.

virtual void tlp::PluginLoader::numberOfFiles

(

int

)

[inline, virtual]

Indicates the number of files to be loaded.

Parameters:

int	the number of files

Definition at line 53 of file PluginLoader.h.

virtual void tlp::PluginLoader::start

(

const std::string &

path

)

[pure virtual]

Called when starting to load plugins into a given directory.

Parameters:

path	The absolute path of the directory

Implemented in tlp::PluginLoaderTxt.