RImporter Class Reference

Base class for importers. More...

#include <RImporter.h>

Inheritance diagram for RImporter:

List of all members.

Public Member Functions
virtual void	endImport ()
	Ends the import.
virtual RBlock::Id	getCurrentBlockId ()
RDocument &	getDocument ()
virtual void	importObject (QSharedPointer< RObject > object)
	Imports an entity into the document.
	RImporter ()
	RImporter (RDocument &document, RMessageHandler *messageHandler=NULL, RProgressHandler *progressHandler=NULL)
virtual void	setCurrentBlockId (RBlock::Id id)
void	setDocument (RDocument *d)
virtual void	startImport ()
	Starts the import.
virtual	~RImporter ()

Protected Attributes
RBlock::Id	blockId
RDocument *	document
RMessageHandler *	messageHandler
RProgressHandler *	progressHandler
RTransaction	transaction

---

Detailed Description

Base class for importers.

Importers import entities from a source (e.g. file, DB, network, ...) into a graphics document. The implementing importer is expected to call the import functions to add objects (e.g. entities) to the document. Custom import functions may be implemented to support custom entity types supported by a specific importer.

Scriptable:

This class is wrapped for script environments.

---

Constructor & Destructor Documentation

RImporter::RImporter

(

)

RImporter::RImporter	(	RDocument &	document,
		RMessageHandler *	messageHandler = NULL,
		RProgressHandler *	progressHandler = NULL
	)

RImporter::~RImporter ( )

virtual

---

Member Function Documentation

void RImporter::endImport ( )

virtual

Ends the import.

Reimplementations should call this base implementation first since this commits the transaction after importing entities into the document.

RBlock::Id RImporter::getCurrentBlockId ( )

virtual

RDocument & RImporter::getDocument

(

)

void RImporter::importObject ( QSharedPointer< RObject >  object )

virtual

Imports an entity into the document.

void RImporter::setCurrentBlockId ( RBlock::Id  id )

virtual

void RImporter::setDocument

(

RDocument *

d

)

void RImporter::startImport ( )

virtual

Starts the import.

Reimplementations should call this base implementation first since this starts a transaction.

---

Member Data Documentation

RBlock::Id RImporter::blockId

protected

RDocument* RImporter::document

protected

RMessageHandler* RImporter::messageHandler

protected

RProgressHandler* RImporter::progressHandler

protected

RTransaction RImporter::transaction

protected

---

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

• src/core/RImporter.h
• src/core/RImporter.cpp