importer.h File Reference

It is the base class for all the importers. More...

#include <cstdio>
#include <map>
#include <ETL/handle>
#include "string.h"
#include "time.h"
#include "gamma.h"
#include "renddesc.h"
#include "filesystem.h"

Go to the source code of this file.

Classes
class	synfig::Importer
	Used for importing bitmaps of various formats, including animations. More...
struct	synfig::Importer::BookEntry

Namespaces
namespace	synfig
	Where every function and class of the synfig library can be found.

Macros
#define	SYNFIG_IMPORTER_MODULE_EXT
#define	SYNFIG_IMPORTER_MODULE_CONSTRUCTOR_DERIVED(class, parent)   public: class(const synfig::FileSystem::Identifier &identifier): parent(identifier) { }
	Defines constructor for class derived from other class which derived from Importer.
#define	SYNFIG_IMPORTER_MODULE_CONSTRUCTOR(class)   SYNFIG_IMPORTER_MODULE_CONSTRUCTOR_DERIVED(class, synfig::Importer)
	Defines constructor for class derived from Importer.
#define	SYNFIG_IMPORTER_MODULE_DECLARATIONS_DERIVED(class, parent)
#define	SYNFIG_IMPORTER_MODULE_DECLARATIONS(class)
#define	SYNFIG_IMPORTER_SET_NAME(class, x)   const char class::name__[]=x
	Sets the name of the importer.
#define	SYNFIG_IMPORTER_SET_EXT(class, x)   const char class::ext__[]=x
	Sets the primary file extension of the importer.
#define	SYNFIG_IMPORTER_SET_VERSION(class, x)   const char class::version__[]=x
	Sets the version of the importer.
#define	SYNFIG_IMPORTER_SET_CVS_ID(class, x)   const char class::cvs_id__[]=x
	Sets the CVS ID of the importer.
#define	SYNFIG_IMPORTER_SET_SUPPORTS_FILE_SYSTEM_WRAPPER(class, x)   const bool class::supports_file_system_wrapper__=x
	Sets the supports_file_system_wrapper flag of the importer.
#define	SYNFIG_IMPORTER_INIT(class)   synfig::Importer* class::create(const synfig::FileSystem::Identifier &identifier) { return new class(identifier); }

Detailed Description

It is the base class for all the importers.

$Id$

Macro Definition Documentation

#define SYNFIG_IMPORTER_MODULE_EXT

Value:

public: static const char name__[], version__[], ext__[],cvs_id__[]; \
        static const bool supports_file_system_wrapper__; \
        static synfig::Importer *create(const synfig::FileSystem::Identifier &identifier);

Defines various variables and the create method, common for all importers. To be used in the private part of the importer class definition.

#define SYNFIG_IMPORTER_MODULE_CONSTRUCTOR_DERIVED	(		class,
			parent
	)		public: class(const synfig::FileSystem::Identifier &identifier): parent(identifier) { }

Defines constructor for class derived from other class which derived from Importer.

#define SYNFIG_IMPORTER_MODULE_CONSTRUCTOR

(

class

)

SYNFIG_IMPORTER_MODULE_CONSTRUCTOR_DERIVED(class, synfig::Importer)

Defines constructor for class derived from Importer.

#define SYNFIG_IMPORTER_MODULE_DECLARATIONS_DERIVED	(		class,
			parent
	)

Value:

SYNFIG_IMPORTER_MODULE_EXT \
		SYNFIG_IMPORTER_MODULE_CONSTRUCTOR_DERIVED(class, parent)

Defines various variables and the create method, common for all importers. To be used in the private part of the importer class definition. And defines constructor for class derived from other class which derived from Importer

#define SYNFIG_IMPORTER_MODULE_DECLARATIONS

(

class

)

Value:

SYNFIG_IMPORTER_MODULE_EXT \
		SYNFIG_IMPORTER_MODULE_CONSTRUCTOR(class)

Defines various variables and the create method, common for all importers. To be used in the private part of the importer class definition. And defines constructor

#define SYNFIG_IMPORTER_SET_NAME	(		class,
			x
	)		const char class::name__[]=x

Sets the name of the importer.

#define SYNFIG_IMPORTER_SET_EXT	(		class,
			x
	)		const char class::ext__[]=x

Sets the primary file extension of the importer.

#define SYNFIG_IMPORTER_SET_VERSION	(		class,
			x
	)		const char class::version__[]=x

Sets the version of the importer.

#define SYNFIG_IMPORTER_SET_CVS_ID	(		class,
			x
	)		const char class::cvs_id__[]=x

Sets the CVS ID of the importer.

#define SYNFIG_IMPORTER_SET_SUPPORTS_FILE_SYSTEM_WRAPPER	(		class,
			x
	)		const bool class::supports_file_system_wrapper__=x

Sets the supports_file_system_wrapper flag of the importer.

#define SYNFIG_IMPORTER_INIT

(

class

)

synfig::Importer* class::create(const synfig::FileSystem::Identifier &identifier) { return new class(identifier); }

Defines de implementation of the create method for the importer

Parameters

identifier

The identifier of file to be imported by the importer.