QCAD
Open Source 2D CAD
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
RImporter Class Reference

Base class for importers. More...

#include <RImporter.h>

Inheritance diagram for RImporter:
RFileImporter RDxfImporter

List of all members.

Public Member Functions

virtual void endImport ()
 Ends the import.
virtual RBlock::Id getCurrentBlockId ()
RDocumentgetDocument ()
virtual void importObject (RObject *object)
 Provided for script importers as importObjectP will loose the object ID.
virtual void importObjectP (QSharedPointer< RObject > object)
 Imports an entity into the document.
 RImporter ()
 Copyright (c) 2011-2014 by Andrew Mustun.
 RImporter (RDocument &document, RMessageHandler *messageHandler=NULL, RProgressHandler *progressHandler=NULL)
virtual void setCurrentBlockId (RBlock::Id id)
void setDocument (RDocument *d)
void setKnownVariable (RS::KnownVariable key, const QVariant &value)
void setKnownVariable (RS::KnownVariable key, const RVector &value)
virtual void startImport ()
 Starts the import.
virtual ~RImporter ()

Protected Attributes

RBlock::Id blockId
RDocumentdocument
RMessageHandlermessageHandler
RProgressHandlerprogressHandler
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 ( )

Copyright (c) 2011-2014 by Andrew Mustun.

All rights reserved.

This file is part of the QCAD project.

QCAD is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

QCAD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with QCAD.

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 ( RObject object)
virtual

Provided for script importers as importObjectP will loose the object ID.

void RImporter::importObjectP ( QSharedPointer< RObject object)
virtual

Imports an entity into the document.

   \par Non-Scriptable:

This function is not available in script environments.

void RImporter::setCurrentBlockId ( RBlock::Id  id)
virtual
void RImporter::setDocument ( RDocument d)
void RImporter::setKnownVariable ( RS::KnownVariable  key,
const QVariant &  value 
)
void RImporter::setKnownVariable ( RS::KnownVariable  key,
const RVector value 
)
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: