synfig::Module Class Reference

#include <module.h>

Public Types
typedef etl::handle< Module >	Handle
typedef etl::loose_handle< Module >	LooseHandle
typedef etl::handle< const Module >	ConstHandle
typedef Module *(*	constructor_type )(ProgressCallback *)
typedef std::map< String, Handle >	Book

Public Member Functions
bool	constructor_ (synfig::ProgressCallback *)
virtual void	destructor_ ()
virtual const char *	Name ()
	Virtual Modules properties wrappers. Must be defined in the modules classes.
virtual const char *	Desc ()
virtual const char *	Author ()
virtual const char *	Version ()
virtual const char *	Copyright ()
virtual	~Module ()

Static Public Member Functions
static Book &	book ()
static bool	subsys_init (const String &prefix)
static bool	subsys_stop ()
static void	register_default_modules (ProgressCallback *cb=NULL)
	Register not optional modules.
static void	Register (Handle mod)
	Register Module by handle.
static bool	Register (const String &module_name, ProgressCallback *cb=NULL)
	Register Module by name.
static void	Register (Module *mod)
	Register Module by instance pointer.

Detailed Description

Todo:

writeme

Member Typedef Documentation

typedef etl::handle<Module> synfig::Module::Handle

typedef etl::loose_handle<Module> synfig::Module::LooseHandle

typedef etl::handle<const Module> synfig::Module::ConstHandle

typedef Module*(* synfig::Module::constructor_type)(ProgressCallback *)

Type that represents a pointer to a Module's constructor by name. As a pointer to the member, it represents a constructor of the module.

typedef std::map<String, Handle > synfig::Module::Book

Constructor & Destructor Documentation

virtual synfig::Module::~Module ( )

inlinevirtual

References destructor_().

Member Function Documentation

bool synfig::Module::constructor_ ( synfig::ProgressCallback *  )

inline

virtual void synfig::Module::destructor_ ( )

inlinevirtual

Referenced by ~Module().

Module::Book & Module::book ( )

static

References book_.

Referenced by OptionsProcessor::process_info_options().

bool Module::subsys_init ( const String &  prefix )

static

Inits the book of importers and add the paths to search for the ltdl library utilities.

References _, book_, and synfig::error().

Referenced by synfig::Main::Main().

bool Module::subsys_stop ( )

static

References book_.

Referenced by synfig::Main::Main().

void Module::register_default_modules ( ProgressCallback *  cb = NULL )

static

Register not optional modules.

References REGISTER_MODULE.

Referenced by synfig::Main::Main().

void synfig::Module::Register ( Module::Handle  mod )

static

Register Module by handle.

Referenced by synfig::Main::Main().

bool synfig::Module::Register ( const String &  module_name, ProgressCallback *  cb = NULL  )

static

Register Module by name.

References _, synfig::ProgressCallback::error(), synfig::ProgressCallback::task(), and synfig::ProgressCallback::warning().

static void synfig::Module::Register ( Module *  mod )

inlinestatic

Register Module by instance pointer.

References Register().

Referenced by Register().

virtual const char* synfig::Module::Name ( )

inlinevirtual

Virtual Modules properties wrappers. Must be defined in the modules classes.

virtual const char* synfig::Module::Desc ( )

inlinevirtual

virtual const char* synfig::Module::Author ( )

inlinevirtual

virtual const char* synfig::Module::Version ( )

inlinevirtual

virtual const char* synfig::Module::Copyright ( )

inlinevirtual

References SYNFIG_COPYRIGHT.

---

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

• module.h
• module.cpp