Tulip  5.1.0
Large graphs analysis and drawing
tlp::PluginLoader Struct Referenceabstract

#include <PluginLoader.h>

+ Inheritance diagram for tlp::PluginLoader:

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 *info, 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
filenameThe absolute path of where the error occured.
errormsgA 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
statetrue if the file was loaded sucessfully
msgAn additional human-readable message about the load state

Implemented in tlp::PluginLoaderTxt.

virtual void tlp::PluginLoader::loaded ( const Plugin info,
const std::list< Dependency > &  dependencies 
)
pure virtual

Indicates that a plugin has been loaded sucessfully.

Parameters
infoThe Plugin object that has just been loaded
dependenciesThe 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
filenameThe absolute path of the file

Implemented in tlp::PluginLoaderTxt.

virtual void tlp::PluginLoader::numberOfFiles ( int  )
inlinevirtual

Indicates the number of files to be loaded.

Parameters
intthe 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
pathThe absolute path of the directory

Implemented in tlp::PluginLoaderTxt.