This is the abstract base class for all storage implementations. More...

#include <RStorage.h>

Inheritance diagram for RStorage:

Public Member Functions
void	addModifiedListener (RModifiedListener *l)
	Adds a listener for modified status changed events.

virtual void	beginTransaction ()=0
	Starts a new transaction.

virtual void	clear ()
	Resets this storage to its initial, empty state.

virtual void	clearEntitySelection (QSet< RObject::Id > *affectedEntities=NULL)=0
	Clears the selection status of all entities.

virtual void	commitTransaction ()=0
	Commits the current transaction.

virtual int	countSelectedEntities () const

virtual bool	deleteObject (RObject::Id objectId)=0
	Deletes the object with the given ID.

virtual void	deleteTransactionsFrom (int transactionId)=0
	Deletes all transactions with IDs from transactionId (inclusive) to the maximum transaction ID.

virtual int	deselectEntities (const QSet< RObject::Id > &entityIds, QSet< RObject::Id > *affectedEntities=NULL)=0
	Deselects all entities with the given IDs.

virtual void	deselectEntity (RObject::Id entityId, QSet< RObject::Id > *affectedEntities=NULL)=0
	Deselects the entity with the given ID.

void	endDocumentVariablesTransaction (RTransaction *transaction, bool useLocalTransaction, QSharedPointer< RDocumentVariables > docVars)

virtual RObject::Id	getBlockId (const QString &blockName) const =0

virtual RObject::Id	getBlockIdAuto (const QString &blockLayoutName) const =0

virtual QString	getBlockName (RObject::Id blockId) const =0

virtual QString	getBlockNameFromHandle (RObject::Handle blockHandle) const =0

virtual QString	getBlockNameFromLayout (const QString &layoutName) const =0

virtual QString	getBlockNameFromLayout (RObject::Id layoutId) const =0

virtual QSet< QString >	getBlockNames (const QString &rxStr=RDEFAULT_QSTRING, bool undone=false) const =0

virtual RBox	getBoundingBox (bool ignoreHiddenLayers=true, bool ignoreEmpty=false) const =0

virtual RObject::Id	getCurrentBlockId () const

virtual RColor	getCurrentColor () const

virtual RObject::Id	getCurrentLayerId () const

virtual RObject::Id	getCurrentLinetypeId () const

virtual RLinetypePattern	getCurrentLinetypePattern () const

virtual RLineweight::Lineweight	getCurrentLineweight () const

virtual RObject::Id	getCurrentViewId () const

virtual RObject::Id	getCurrentViewportId () const

virtual QString	getDimensionFont () const

RDocument *	getDocument () const

virtual RBox	getEntitiesBox (QSet< RObject::Id > &ids) const =0

virtual QVariant	getKnownVariable (RS::KnownVariable key) const =0

QString	getLastModified () const

QDateTime	getLastModifiedDateTime () const

virtual int	getLastTransactionId ()

virtual RObject::Id	getLayer0Id () const

virtual RObject::Id	getLayerId (const QString &layerName) const =0

virtual QString	getLayerName (RObject::Id layerId) const =0

virtual QSet< QString >	getLayerNames (const QString &rxStr=RDEFAULT_QSTRING) const =0

virtual RObject::Id	getLayerStateId (const QString &layerStateName) const =0

virtual QString	getLayerStateName (RObject::Id layerStateId) const =0

virtual QSet< QString >	getLayerStateNames (const QString &rxStr=RDEFAULT_QSTRING) const =0

virtual RObject::Id	getLayoutId (const QString &layoutName) const =0

virtual QString	getLayoutName (RObject::Id layoutId) const =0

virtual QSet< QString >	getLayoutNames (const QString &rxStr=RDEFAULT_QSTRING) const =0

virtual QString	getLinetypeDescription (RObject::Id linetypeId) const =0

virtual RObject::Id	getLinetypeId (const QString &linetypeName) const =0

virtual QString	getLinetypeLabel (RObject::Id linetypeId) const =0

virtual QString	getLinetypeName (RObject::Id linetypeId) const =0

virtual QSet< QString >	getLinetypeNames () const =0

virtual QList< RLinetypePattern >	getLinetypePatterns () const =0

virtual double	getLinetypeScale () const

virtual int	getMaxDrawOrder ()

virtual RLineweight::Lineweight	getMaxLineweight () const =0

virtual RObject::Handle	getMaxObjectHandle ()

virtual RObject::Id	getMaxObjectId ()

virtual int	getMaxTransactionId ()=0

RS::Measurement	getMeasurement () const

virtual int	getMinDrawOrder ()

virtual RObject::Id	getModelSpaceBlockId () const

virtual RObject::Handle	getNewObjectHandle ()

virtual RObject::Id	getNewObjectId ()

bool	getNotifyListeners () const

virtual RBox	getSelectionBox () const =0

virtual RTransaction	getTransaction (int transactionId)=0

virtual int	getTransactionGroup () const

RS::Unit	getUnit () const

virtual QVariant	getVariable (const QString &key) const =0

virtual QStringList	getVariables () const =0

virtual RObject::Id	getViewId (const QString &viewName) const =0

virtual QString	getViewName (RObject::Id viewId) const =0

virtual QSet< QString >	getViewNames () const =0

virtual bool	hasBlock (const QString &blockName) const

virtual bool	hasBlockEntities (RObject::Id blockId) const =0

virtual bool	hasChildEntities (RObject::Id parentId) const =0

virtual bool	hasLayer (const QString &layerName) const

virtual bool	hasLayerState (const QString &layerStateName) const

virtual bool	hasLayerStates () const

virtual bool	hasLayout (const QString &layoutName) const

virtual bool	hasLinetype (const QString &linetypeName) const

virtual bool	hasSelection () const =0

virtual bool	hasVariable (const QString &key) const

virtual bool	hasView (const QString &viewName) const

virtual bool	isBlockFrozen (RObject::Id blockId) const

virtual bool	isEntity (RObject::Id objectId)

virtual bool	isEntityVisible (const REntity &entity, RObject::Id blockId) const

virtual bool	isInBackStorage (RObject::Id)
	Linked storages should return true if the given object is stored in the storage the linked storage links to.

virtual bool	isLayerFrozen (const RLayer &layer) const

virtual bool	isLayerFrozen (RObject::Id layerId) const

virtual bool	isLayerLocked (const RLayer &layer) const

virtual bool	isLayerLocked (RObject::Id layerId) const

virtual bool	isLayerOff (const RLayer &layer) const

virtual bool	isLayerOff (RObject::Id layerId) const

virtual bool	isLayerOffOrFrozen (const RLayer &layer) const

virtual bool	isLayerOffOrFrozen (RObject::Id layerId) const

virtual bool	isLayerPlottable (const RLayer &layer) const

virtual bool	isLayerPlottable (RObject::Id layerId) const

virtual bool	isLayerSnappable (const RLayer &layer) const

virtual bool	isLayerSnappable (RObject::Id layerId) const

virtual bool	isLayoutBlock (RObject::Id blockId) const

bool	isModified () const

virtual bool	isParentLayerFrozen (const RLayer &layer) const

virtual bool	isParentLayerFrozen (RObject::Id layerId) const

virtual bool	isParentLayerLocked (const RLayer &layer) const

virtual bool	isParentLayerLocked (RObject::Id layerId) const

virtual bool	isParentLayerPlottable (const RLayer &layer) const

virtual bool	isParentLayerPlottable (RObject::Id layerId) const

virtual bool	isParentLayerSnappable (const RLayer &layer) const

virtual bool	isParentLayerSnappable (RObject::Id layerId) const

virtual bool	isSelected (RObject::Id entityId)

virtual bool	isSelectedWorkingSet (RObject::Id entityId)

virtual QList< RObject::Id >	orderBackToFront (const QSet< RObject::Id > &entityIds) const

virtual QSet< RObject::Id >	queryAllBlockReferences () const =0

virtual QSet< RObject::Id >	queryAllBlocks (bool undone=false)=0

virtual QSet< RObject::Id >	queryAllEntities (bool undone, bool allBlocks, QList< RS::EntityType > types)=0

virtual QSet< RObject::Id >	queryAllEntities (bool undone=false, bool allBlocks=false, RS::EntityType type=RS::EntityAll)=0

virtual QSet< RObject::Id >	queryAllLayers (bool undone=false)=0

virtual QSet< RObject::Id >	queryAllLayerStates (bool undone=false) const =0

virtual QSet< RObject::Id >	queryAllLayoutBlocks (bool includeModelSpace=false, bool undone=false) const =0

virtual QSet< RObject::Id >	queryAllLayouts (bool undone=false)=0

virtual QSet< RObject::Id >	queryAllLinetypes ()=0

virtual QSet< RObject::Id >	queryAllObjects () const =0

virtual QSet< RObject::Id >	queryAllUcs ()=0

virtual QSet< RObject::Id >	queryAllViewports () const =0

virtual QSet< RObject::Id >	queryAllViews (bool undone=false)=0

virtual QSet< RObject::Id >	queryAllVisibleEntities ()=0

virtual QSharedPointer< RBlock >	queryBlock (const QString &blockName) const =0

virtual QSharedPointer< RBlock >	queryBlock (RObject::Id blockId) const =0

virtual QSharedPointer< RBlock >	queryBlockDirect (const QString &blockName) const

virtual QSharedPointer< RBlock >	queryBlockDirect (RObject::Id blockId) const =0

virtual QSet< RObject::Id >	queryBlockEntities (RObject::Id blockId)=0

virtual QSet< RObject::Id >	queryBlockReferences (RObject::Id blockId) const =0

virtual QSet< RObject::Id >	queryChildEntities (RObject::Id parentId, RS::EntityType type=RS::EntityAll)=0

virtual QSharedPointer< RBlock >	queryCurrentBlock ()

virtual QSharedPointer< RLayer >	queryCurrentLayer ()

virtual QSharedPointer< RLinetype >	queryCurrentLinetype () const

virtual QSharedPointer< RView >	queryCurrentView ()

virtual QSharedPointer< RDimStyle >	queryDimStyle () const =0

virtual QSharedPointer< RDimStyle >	queryDimStyleDirect () const =0

virtual QSharedPointer< RDocumentVariables >	queryDocumentVariables () const =0

virtual QSharedPointer< RDocumentVariables >	queryDocumentVariablesDirect () const =0

virtual QSharedPointer< REntity >	queryEntity (RObject::Id entityId) const =0

virtual QSharedPointer< REntity >	queryEntityDirect (RObject::Id entityId) const

virtual QSet< RObject::Id >	queryInfiniteEntities () const =0

virtual QSharedPointer< RLayer >	queryLayer (const QString &layerName) const =0

virtual QSharedPointer< RLayer >	queryLayer (RObject::Id layerId) const =0

virtual QSet< RObject::Id >	queryLayerBlockEntities (RObject::Id layerId, RObject::Id blockId)=0

virtual QSharedPointer< RLayer >	queryLayerDirect (const QString &layerName) const

virtual QSharedPointer< RLayer >	queryLayerDirect (RObject::Id layerId) const

virtual QSet< RObject::Id >	queryLayerEntities (RObject::Id layerId, bool allBlocks=false)=0

virtual QSharedPointer< RLayerState >	queryLayerState (const QString &layerStateName) const =0

virtual QSharedPointer< RLayerState >	queryLayerState (RObject::Id layerStateId) const =0

virtual QSharedPointer< RLayerState >	queryLayerStateDirect (const QString &layerStateName) const

virtual QSharedPointer< RLayerState >	queryLayerStateDirect (RObject::Id layerStateId) const

virtual QSharedPointer< RLayout >	queryLayout (const QString &layoutName) const =0

virtual QSharedPointer< RLayout >	queryLayout (RObject::Id layoutId) const =0

virtual QSharedPointer< RLayout >	queryLayoutDirect (RObject::Id layoutId) const

virtual QSharedPointer< RLinetype >	queryLinetype (const QString &linetypeName) const =0

virtual QSharedPointer< RLinetype >	queryLinetype (RObject::Id linetypeId) const =0

virtual QSharedPointer< RLinetype >	queryLinetypeDirect (RObject::Id linetypeId) const =0

virtual QSharedPointer< RObject >	queryObject (RObject::Id objectId) const =0

virtual QSharedPointer< RObject >	queryObjectByHandle (RObject::Handle objectHandle) const =0

virtual RObject *	queryObjectCC (RObject::Id objectId) const =0

virtual QSharedPointer< RObject >	queryObjectDirect (RObject::Id objectId) const

virtual QSet< RObject::Id >	querySelectedEntities () const =0

virtual QSet< RObject::Id >	querySelectedLayerEntities (RObject::Id layerId, bool allBlocks=false)=0

virtual QSet< RObject::Id >	querySelectedLayers () const =0

virtual QSharedPointer< RUcs >	queryUcs (const QString &ucsName) const =0

virtual QSharedPointer< RUcs >	queryUcs (RObject::Id ucsId) const =0

virtual QSharedPointer< RUcs >	queryUcsDirect (RObject::Id ucsId) const

virtual QSharedPointer< RView >	queryView (const QString &viewName) const =0

virtual QSharedPointer< RView >	queryView (RObject::Id viewId) const =0

virtual QSharedPointer< REntity >	queryVisibleEntityDirect (RObject::Id entityId) const

virtual QSet< RObject::Id >	queryWorkingSetEntities ()=0

virtual bool	removeObject (QSharedPointer< RObject > object)=0

virtual void	removeVariable (const QString &key)=0
	Removes the custom variable with the given key.

virtual void	resetTransactionStack ()=0

virtual void	rollbackTransaction ()=0
	Rolls the current transaction back in order to cancel it.

	RStorage ()

virtual bool	saveObject (QSharedPointer< RObject > object, bool checkBlockRecursion=true, bool keepHandles=false, bool *overwrite=NULL)=0
	Saves the given object to the storage.

virtual void	saveTransaction (RTransaction &transaction)=0
	Saves the given transaction.

virtual void	selectAllEntities (QSet< RObject::Id > *affectedEntities=NULL)=0
	Sets the selection status of all entities.

virtual int	selectEntities (const QSet< RObject::Id > &entityIds, bool add=false, QSet< RObject::Id > *affectedEntities=NULL)=0
	Selects all entities with the given IDs.

virtual void	selectEntity (RObject::Id entityId, bool add=false, QSet< RObject::Id > *affectedEntities=NULL)=0
	Selects the entity with the given ID.

void	setCurrentBlock (const QString &blockName)

virtual void	setCurrentBlock (RObject::Id blockId)

virtual void	setCurrentColor (const RColor &color)

void	setCurrentLayer (const QString &layerName, RTransaction *transaction=NULL)

void	setCurrentLayer (RObject::Id layerId, RTransaction *transaction=NULL)

void	setCurrentLinetype (const QString &name)

void	setCurrentLinetype (RObject::Id ltId)

void	setCurrentLinetypePattern (const RLinetypePattern &p)

void	setCurrentLineweight (RLineweight::Lineweight lw)

void	setCurrentView (const QString &viewName)

void	setCurrentView (RObject::Id viewId)

virtual void	setCurrentViewport (RObject::Id viewportId)

virtual void	setDimensionFont (const QString &f, RTransaction *transaction=NULL)

void	setDocument (RDocument *doc)

virtual void	setEntityParentId (REntity &entity, RObject::Id parentId)

virtual void	setKnownVariable (RS::KnownVariable key, const QVariant &value, RTransaction *transaction=NULL)=0
	Sets a known DXF/DWG variable for this document.

virtual void	setLastTransactionId (int transactionId)
	Sets the ID of the last created transaction.

virtual void	setLayer0Id (RObject::Id id)

virtual void	setLinetypeScale (double v, RTransaction *transaction=NULL)
	Sets the global linetype scale of this document to the given value.

virtual void	setMaxDrawOrder (int m)

void	setMeasurement (RS::Measurement m, RTransaction *transaction=NULL)

virtual void	setModelSpaceBlockId (RObject::Id id)

void	setModified (bool m)
	Resets the modified flag.

void	setNotifyListeners (bool on)

virtual void	setObjectHandle (RObject &object, RObject::Handle objectHandle)

virtual void	setObjectId (RObject &object, RObject::Id objectId) const

virtual void	setUndoStatus (RObject &object, bool status)

virtual bool	setUndoStatus (RObject::Id object, bool status)=0

void	setUnit (RS::Unit unit, RTransaction *transaction=NULL)

virtual void	setVariable (const QString &key, const QVariant &value, bool overwrite=true)=0
	Sets a custom variable in the context of this document.

QList< RObject::Id >	sortBlocks (const QList< RObject::Id > &blockIds) const

QList< RObject::Id >	sortLayers (const QList< RObject::Id > &layerIds) const

QSharedPointer< RDocumentVariables >	startDocumentVariablesTransaction (RTransaction *&transaction, bool &useLocalTransaction)

virtual void	startTransactionGroup ()

virtual void	toggleUndoStatus (QSet< RObject::Id > &objects)=0
	Toggles the current undo status of all given objects.

virtual void	toggleUndoStatus (RObject::Id object)=0
	Toggles the current undo status of the given object.

virtual void	unsetCurrentViewport ()

virtual void	update ()
	Clear caches:

virtual	~RStorage ()

Public Member Functions inherited from RRequireHeap
void	doDelete ()

Static Public Member Functions
static QString	getKnownVariableName (RS::KnownVariable n)

static bool	lessThan (const QPair< RObject::Id, int > &p1, const QPair< RObject::Id, int > &p2)

static void	registerCustomEntityType (RS::EntityType type)

static void	unregisterCustomEntityType (RS::EntityType type)

Protected Attributes
RObject::Handle	handleCounter

QDateTime	lastModified

bool	modified

Static Protected Attributes
static QList< RS::EntityType >	customEntityTypes
	Copyright (c) 2011-2018 by Andrew Mustun.

Private Attributes
RObject::Id	currentBlockId

RColor	currentColor

RObject::Id	currentLinetypeId

RLineweight::Lineweight	currentLineweight

RObject::Id	currentViewId

RObject::Id	currentViewportId

RDocument *	document

RObject::Id	idCounter

int	lastTransactionGroup

int	lastTransactionId

RObject::Id	layer0Id

int	maxDrawOrder

RObject::Id	modelSpaceBlockId

QList< RModifiedListener * >	modifiedListeners

bool	notifyGlobalListeners

Friends
QDebug	operator<< (QDebug dbg, RStorage &s)
	Stream operator for QDebug.

Additional Inherited Members
Protected Member Functions inherited from RRequireHeap
virtual	~RRequireHeap ()

Private Member Functions inherited from RNonCopyable
	RNonCopyable ()

virtual	~RNonCopyable ()

Detailed Description

This is the abstract base class for all storage implementations.

A storage is used to store documents (entities, layers, blocks, transactions) in memory or on disk. Every document is backed by a storage object.

A storage implementation is available in the qcaddbstorage.

Scriptable:\nThis class is available in script environments.\n

Constructor & Destructor Documentation

◆ RStorage()

RStorage::RStorage ( )

◆ ~RStorage()

virtual RStorage::~RStorage ( )

inlinevirtual

Member Function Documentation

◆ addModifiedListener()

void RStorage::addModifiedListener ( RModifiedListener * l )

Adds a listener for modified status changed events.

This can for example be a modification indication widget.

◆ beginTransaction()

virtual void RStorage::beginTransaction ( )

pure virtual

Starts a new transaction.

This function is called before something is stored in the storage.

Implemented in RMemoryStorage.

◆ clear()

void RStorage::clear ( )

virtual

Resets this storage to its initial, empty state.

Reimplemented in RLinkedStorage, and RMemoryStorage.

◆ clearEntitySelection()

virtual void RStorage::clearEntitySelection ( QSet< RObject::Id > * affectedEntities = NULL )

pure virtual

Clears the selection status of all entities.

Implemented in RMemoryStorage.

◆ commitTransaction()

virtual void RStorage::commitTransaction ( )

pure virtual

Commits the current transaction.

This function is called after something has been stored in the storage.

Implemented in RMemoryStorage.

◆ countSelectedEntities()

virtual int RStorage::countSelectedEntities ( ) const

inlinevirtual

Returns: Number of selected entities.

Reimplemented in RMemoryStorage.

◆ deleteObject()

virtual bool RStorage::deleteObject ( RObject::Id objectId )

pure virtual

Deletes the object with the given ID.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ deleteTransactionsFrom()

virtual void RStorage::deleteTransactionsFrom ( int transactionId )

pure virtual

Deletes all transactions with IDs from transactionId (inclusive) to the maximum transaction ID.

This is called if some transactions have been undone and then a redo is triggered. All undone transactions have to be deleted at this point.

Implemented in RMemoryStorage.

◆ deselectEntities()

virtual int RStorage::deselectEntities	(	const QSet< RObject::Id > &	entityIds,
		QSet< RObject::Id > *	affectedEntities = NULL )

pure virtual

Deselects all entities with the given IDs.

Parameters

affected Optional pointer to an empty set of entity IDs. After the call, this set will contain all entity IDs of entities that were affected by the call.

Implemented in RMemoryStorage.

◆ deselectEntity()

virtual void RStorage::deselectEntity	(	RObject::Id	entityId,
		QSet< RObject::Id > *	affectedEntities = NULL )

pure virtual

Deselects the entity with the given ID.

Parameters

affected Optional pointer to an empty set of entity IDs. After the call, this set will contain all entity IDs of entities that were affected by the call.

Implemented in RMemoryStorage.

◆ endDocumentVariablesTransaction()

void RStorage::endDocumentVariablesTransaction	(	RTransaction *	transaction,
		bool	useLocalTransaction,
		QSharedPointer< RDocumentVariables >	docVars )

◆ getBlockId()

virtual RObject::Id RStorage::getBlockId ( const QString & blockName ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getBlockIdAuto()

virtual RObject::Id RStorage::getBlockIdAuto ( const QString & blockLayoutName ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getBlockName()

virtual QString RStorage::getBlockName ( RObject::Id blockId ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getBlockNameFromHandle()

virtual QString RStorage::getBlockNameFromHandle ( RObject::Handle blockHandle ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getBlockNameFromLayout() [1/2]

virtual QString RStorage::getBlockNameFromLayout ( const QString & layoutName ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getBlockNameFromLayout() [2/2]

virtual QString RStorage::getBlockNameFromLayout ( RObject::Id layoutId ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getBlockNames()

virtual QSet< QString > RStorage::getBlockNames	(	const QString &	rxStr = RDEFAULT_QSTRING,
		bool	undone = false ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getBoundingBox()

virtual RBox RStorage::getBoundingBox	(	bool	ignoreHiddenLayers = true,
		bool	ignoreEmpty = false ) const

pure virtual

Returns: The bounding box around all visible entities.

Implemented in RMemoryStorage.

◆ getCurrentBlockId()

virtual RObject::Id RStorage::getCurrentBlockId ( ) const

inlinevirtual

Reimplemented in RLinkedStorage.

◆ getCurrentColor()

RColor RStorage::getCurrentColor ( ) const

virtual

Reimplemented in RLinkedStorage.

◆ getCurrentLayerId()

RLayer::Id RStorage::getCurrentLayerId ( ) const

virtual

Reimplemented in RLinkedStorage.

◆ getCurrentLinetypeId()

RLinetype::Id RStorage::getCurrentLinetypeId ( ) const

virtual

Reimplemented in RLinkedStorage.

◆ getCurrentLinetypePattern()

RLinetypePattern RStorage::getCurrentLinetypePattern ( ) const

virtual

◆ getCurrentLineweight()

RLineweight::Lineweight RStorage::getCurrentLineweight ( ) const

virtual

Reimplemented in RLinkedStorage.

◆ getCurrentViewId()

virtual RObject::Id RStorage::getCurrentViewId ( ) const

inlinevirtual

Reimplemented in RLinkedStorage.

◆ getCurrentViewportId()

virtual RObject::Id RStorage::getCurrentViewportId ( ) const

inlinevirtual

◆ getDimensionFont()

QString RStorage::getDimensionFont ( ) const

virtual

Reimplemented in RLinkedStorage.

◆ getDocument()

RDocument * RStorage::getDocument ( ) const

inline

◆ getEntitiesBox()

virtual RBox RStorage::getEntitiesBox ( QSet< RObject::Id > & ids ) const

pure virtual

Implemented in RMemoryStorage.

◆ getKnownVariable()

virtual QVariant RStorage::getKnownVariable ( RS::KnownVariable key ) const

pure virtual

Returns: Value for the given DXF/DWG variable.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getKnownVariableName()

QString RStorage::getKnownVariableName ( RS::KnownVariable n )

static

Returns: Name of the given known variable enum. Used for debugging.

◆ getLastModified()

QString RStorage::getLastModified ( ) const

inline

◆ getLastModifiedDateTime()

QDateTime RStorage::getLastModifiedDateTime ( ) const

inline

Non-Scriptable:\nThis function is not available in script environments.\n

◆ getLastTransactionId()

virtual int RStorage::getLastTransactionId ( )

inlinevirtual

Returns: The ID of the last completed transaction. The default implementation reads variable "LastTransaction".

◆ getLayer0Id()

virtual RObject::Id RStorage::getLayer0Id ( ) const

inlinevirtual

◆ getLayerId()

virtual RObject::Id RStorage::getLayerId ( const QString & layerName ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getLayerName()

virtual QString RStorage::getLayerName ( RObject::Id layerId ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getLayerNames()

virtual QSet< QString > RStorage::getLayerNames ( const QString & rxStr = RDEFAULT_QSTRING ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getLayerStateId()

virtual RObject::Id RStorage::getLayerStateId ( const QString & layerStateName ) const

pure virtual

Implemented in RMemoryStorage.

◆ getLayerStateName()

virtual QString RStorage::getLayerStateName ( RObject::Id layerStateId ) const

pure virtual

Implemented in RMemoryStorage.

◆ getLayerStateNames()

virtual QSet< QString > RStorage::getLayerStateNames ( const QString & rxStr = RDEFAULT_QSTRING ) const

pure virtual

Implemented in RMemoryStorage.

◆ getLayoutId()

virtual RObject::Id RStorage::getLayoutId ( const QString & layoutName ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getLayoutName()

virtual QString RStorage::getLayoutName ( RObject::Id layoutId ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getLayoutNames()

virtual QSet< QString > RStorage::getLayoutNames ( const QString & rxStr = RDEFAULT_QSTRING ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getLinetypeDescription()

virtual QString RStorage::getLinetypeDescription ( RObject::Id linetypeId ) const

pure virtual

Returns: User readable description for the given linetype.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getLinetypeId()

virtual RObject::Id RStorage::getLinetypeId ( const QString & linetypeName ) const

pure virtual

Returns: Linetype ID of the given linetype name or RObject::INVALID_ID.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getLinetypeLabel()

virtual QString RStorage::getLinetypeLabel ( RObject::Id linetypeId ) const

pure virtual

Returns: User readable label for the given linetype.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getLinetypeName()

virtual QString RStorage::getLinetypeName ( RObject::Id linetypeId ) const

pure virtual

Returns: Linetype name of the given linetype.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getLinetypeNames()

virtual QSet< QString > RStorage::getLinetypeNames ( ) const

pure virtual

Returns: List of all available linetype pattern names in this document.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getLinetypePatterns()

virtual QList< RLinetypePattern > RStorage::getLinetypePatterns ( ) const

pure virtual

Returns: List of all available linetype patterns in this document.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getLinetypeScale()

double RStorage::getLinetypeScale ( ) const

virtual

◆ getMaxDrawOrder()

virtual int RStorage::getMaxDrawOrder ( )

inlinevirtual

◆ getMaxLineweight()

virtual RLineweight::Lineweight RStorage::getMaxLineweight ( ) const

pure virtual

Implemented in RMemoryStorage.

◆ getMaxObjectHandle()

RObject::Handle RStorage::getMaxObjectHandle ( )

virtual

◆ getMaxObjectId()

RObject::Id RStorage::getMaxObjectId ( )

virtual

◆ getMaxTransactionId()

virtual int RStorage::getMaxTransactionId ( )

pure virtual

Returns: The highest transaction ID that is in use. This should be used by deleteTransactionsFrom internally.

Implemented in RMemoryStorage.

◆ getMeasurement()

RS::Measurement RStorage::getMeasurement ( ) const

◆ getMinDrawOrder()

int RStorage::getMinDrawOrder ( )

virtual

◆ getModelSpaceBlockId()

virtual RObject::Id RStorage::getModelSpaceBlockId ( ) const

inlinevirtual

◆ getNewObjectHandle()

RObject::Handle RStorage::getNewObjectHandle ( )

virtual

Reimplemented in RLinkedStorage, and RMemoryStorage.

◆ getNewObjectId()

RObject::Id RStorage::getNewObjectId ( )

virtual

Reimplemented in RLinkedStorage.

◆ getNotifyListeners()

bool RStorage::getNotifyListeners ( ) const

inline

◆ getSelectionBox()

virtual RBox RStorage::getSelectionBox ( ) const

pure virtual

Implemented in RMemoryStorage.

◆ getTransaction()

virtual RTransaction RStorage::getTransaction ( int transactionId )

pure virtual

Returns: Transaction with the given id.

Implemented in RMemoryStorage.

◆ getTransactionGroup()

virtual int RStorage::getTransactionGroup ( ) const

inlinevirtual

◆ getUnit()

RS::Unit RStorage::getUnit ( ) const

◆ getVariable()

virtual QVariant RStorage::getVariable ( const QString & key ) const

pure virtual

Returns: The value of the given variable or an invalid variant if the variable does not exist.

Implemented in RMemoryStorage.

◆ getVariables()

virtual QStringList RStorage::getVariables ( ) const

pure virtual

Returns: List of custom variable names stored in this document.

Implemented in RMemoryStorage.

◆ getViewId()

virtual RObject::Id RStorage::getViewId ( const QString & viewName ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getViewName()

virtual QString RStorage::getViewName ( RObject::Id viewId ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ getViewNames()

virtual QSet< QString > RStorage::getViewNames ( ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ hasBlock()

bool RStorage::hasBlock ( const QString & blockName ) const

virtual

◆ hasBlockEntities()

virtual bool RStorage::hasBlockEntities ( RObject::Id blockId ) const

pure virtual

Returns: True if the given block contains any entities.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ hasChildEntities()

virtual bool RStorage::hasChildEntities ( RObject::Id parentId ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ hasLayer()

bool RStorage::hasLayer ( const QString & layerName ) const

virtual

◆ hasLayerState()

bool RStorage::hasLayerState ( const QString & layerStateName ) const

virtual

◆ hasLayerStates()

bool RStorage::hasLayerStates ( ) const

virtual

◆ hasLayout()

bool RStorage::hasLayout ( const QString & layoutName ) const

virtual

◆ hasLinetype()

bool RStorage::hasLinetype ( const QString & linetypeName ) const

virtual

◆ hasSelection()

virtual bool RStorage::hasSelection ( ) const

pure virtual

Returns: True if at least one entity is selected in this storage.

Implemented in RMemoryStorage.

◆ hasVariable()

virtual bool RStorage::hasVariable ( const QString & key ) const

inlinevirtual

Returns: True if the given variable exists in this storage.

◆ hasView()

bool RStorage::hasView ( const QString & viewName ) const

virtual

◆ isBlockFrozen()

bool RStorage::isBlockFrozen ( RObject::Id blockId ) const

virtual

Returns: True if the given block is frozen.

◆ isEntity()

bool RStorage::isEntity ( RObject::Id objectId )

virtual

◆ isEntityVisible()

bool RStorage::isEntityVisible	(	const REntity &	entity,
		RObject::Id	blockId ) const

virtual

Returns: True if the given entity is visible in the context of the given block or the current block (default).

◆ isInBackStorage()

virtual bool RStorage::isInBackStorage ( RObject::Id )

inlinevirtual

Linked storages should return true if the given object is stored in the storage the linked storage links to.

Reimplemented in RLinkedStorage.

◆ isLayerFrozen() [1/2]

bool RStorage::isLayerFrozen ( const RLayer & layer ) const

virtual

Returns: True if this layer or one of its parent layers are frozen.

◆ isLayerFrozen() [2/2]

bool RStorage::isLayerFrozen ( RObject::Id layerId ) const

virtual

Returns: True if this layer or one of its parent layers are frozen.

◆ isLayerLocked() [1/2]

bool RStorage::isLayerLocked ( const RLayer & layer ) const

virtual

◆ isLayerLocked() [2/2]

bool RStorage::isLayerLocked ( RObject::Id layerId ) const

virtual

◆ isLayerOff() [1/2]

bool RStorage::isLayerOff ( const RLayer & layer ) const

virtual

◆ isLayerOff() [2/2]

bool RStorage::isLayerOff ( RObject::Id layerId ) const

virtual

Returns: True if this layer is off.

◆ isLayerOffOrFrozen() [1/2]

bool RStorage::isLayerOffOrFrozen ( const RLayer & layer ) const

virtual

◆ isLayerOffOrFrozen() [2/2]

bool RStorage::isLayerOffOrFrozen ( RObject::Id layerId ) const

virtual

Returns: True if this layer is off or frozen.

◆ isLayerPlottable() [1/2]

bool RStorage::isLayerPlottable ( const RLayer & layer ) const

virtual

Returns: True if this layer and its parent layers are plottable.

◆ isLayerPlottable() [2/2]

bool RStorage::isLayerPlottable ( RObject::Id layerId ) const

virtual

Returns: True if this layer and its parent layers are plottable.

◆ isLayerSnappable() [1/2]

bool RStorage::isLayerSnappable ( const RLayer & layer ) const

virtual

Returns: True if this layer and its parent layers are snappable.

◆ isLayerSnappable() [2/2]

bool RStorage::isLayerSnappable ( RObject::Id layerId ) const

virtual

Returns: True if this layer and its parent layers are snappable.

◆ isLayoutBlock()

bool RStorage::isLayoutBlock ( RObject::Id blockId ) const

virtual

Returns: True if the given block is a layout block (i.e. paper space block).

◆ isModified()

bool RStorage::isModified ( ) const

inline

Returns: True if the document has unsaved changes.

◆ isParentLayerFrozen() [1/2]

bool RStorage::isParentLayerFrozen ( const RLayer & layer ) const

virtual

◆ isParentLayerFrozen() [2/2]

bool RStorage::isParentLayerFrozen ( RObject::Id layerId ) const

virtual

Returns: True if a parent layer of the given layer is frozen.

◆ isParentLayerLocked() [1/2]

bool RStorage::isParentLayerLocked ( const RLayer & layer ) const

virtual

◆ isParentLayerLocked() [2/2]

bool RStorage::isParentLayerLocked ( RObject::Id layerId ) const

virtual

Returns: True if a parent layer of the given layer is locked.

◆ isParentLayerPlottable() [1/2]

bool RStorage::isParentLayerPlottable ( const RLayer & layer ) const

virtual

◆ isParentLayerPlottable() [2/2]

bool RStorage::isParentLayerPlottable ( RObject::Id layerId ) const

virtual

Returns: True if a parent layer of the given layer is plottable.

◆ isParentLayerSnappable() [1/2]

bool RStorage::isParentLayerSnappable ( const RLayer & layer ) const

virtual

◆ isParentLayerSnappable() [2/2]

bool RStorage::isParentLayerSnappable ( RObject::Id layerId ) const

virtual

Returns: True if a parent layer of the given layer is snappable.

◆ isSelected()

bool RStorage::isSelected ( RObject::Id entityId )

virtual

Reimplemented in RMemoryStorage.

◆ isSelectedWorkingSet()

bool RStorage::isSelectedWorkingSet ( RObject::Id entityId )

virtual

Reimplemented in RMemoryStorage.

◆ lessThan()

bool RStorage::lessThan	(	const QPair< RObject::Id, int > &	p1,
		const QPair< RObject::Id, int > &	p2 )

static

Non-Scriptable:\nThis function is not available in script environments.\n

◆ orderBackToFront()

QList< REntity::Id > RStorage::orderBackToFront ( const QSet< RObject::Id > & entityIds ) const

virtual

Returns: Ordered list of given IDs for display purposes.

◆ queryAllBlockReferences()

virtual QSet< RObject::Id > RStorage::queryAllBlockReferences ( ) const

pure virtual

Returns: A set of all block reference entity IDs.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryAllBlocks()

virtual QSet< RObject::Id > RStorage::queryAllBlocks ( bool undone = false )

pure virtual

Returns: A set of all block IDs of the document.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryAllEntities() [1/2]

virtual QSet< RObject::Id > RStorage::queryAllEntities	(	bool	undone,
		bool	allBlocks,
		QList< RS::EntityType >	types )

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryAllEntities() [2/2]

virtual QSet< RObject::Id > RStorage::queryAllEntities	(	bool	undone = false,
		bool	allBlocks = false,
		RS::EntityType	type = RS::EntityAll )

pure virtual

Returns: A set of all entity IDs of the document.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryAllLayers()

virtual QSet< RObject::Id > RStorage::queryAllLayers ( bool undone = false )

pure virtual

Returns: A set of all layer IDs of the document.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryAllLayerStates()

virtual QSet< RObject::Id > RStorage::queryAllLayerStates ( bool undone = false ) const

pure virtual

Returns: A set of all layer state IDs of the document.

Implemented in RMemoryStorage.

◆ queryAllLayoutBlocks()

virtual QSet< RObject::Id > RStorage::queryAllLayoutBlocks	(	bool	includeModelSpace = false,
		bool	undone = false ) const

pure virtual

Returns: A set of all block IDs of layout blocks of the document.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryAllLayouts()

virtual QSet< RObject::Id > RStorage::queryAllLayouts ( bool undone = false )

pure virtual

Returns: A set of all layout IDs of layouts of the document.

Implemented in RMemoryStorage, and RLinkedStorage.

◆ queryAllLinetypes()

virtual QSet< RObject::Id > RStorage::queryAllLinetypes ( )

pure virtual

Returns: A set of all linetype IDs of the document.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryAllObjects()

virtual QSet< RObject::Id > RStorage::queryAllObjects ( ) const

pure virtual

Returns: A set of all object IDs of the document.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryAllUcs()

virtual QSet< RObject::Id > RStorage::queryAllUcs ( )

pure virtual

Returns: A set of all UCS IDs of the document.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryAllViewports()

virtual QSet< RObject::Id > RStorage::queryAllViewports ( ) const

pure virtual

Returns: A set of all viewport entity IDs.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryAllViews()

virtual QSet< RObject::Id > RStorage::queryAllViews ( bool undone = false )

pure virtual

Returns: A set of all view IDs of the document.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryAllVisibleEntities()

virtual QSet< RObject::Id > RStorage::queryAllVisibleEntities ( )

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryBlock() [1/2]

virtual QSharedPointer< RBlock > RStorage::queryBlock ( const QString & blockName ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryBlock() [2/2]

virtual QSharedPointer< RBlock > RStorage::queryBlock ( RObject::Id blockId ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryBlockDirect() [1/2]

virtual QSharedPointer< RBlock > RStorage::queryBlockDirect ( const QString & blockName ) const

inlinevirtual

Reimplemented in RMemoryStorage.

◆ queryBlockDirect() [2/2]

virtual QSharedPointer< RBlock > RStorage::queryBlockDirect ( RObject::Id blockId ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryBlockEntities()

virtual QSet< RObject::Id > RStorage::queryBlockEntities ( RObject::Id blockId )

pure virtual

Returns: A set of all entity IDs that are part of the given block.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryBlockReferences()

virtual QSet< RObject::Id > RStorage::queryBlockReferences ( RObject::Id blockId ) const

pure virtual

Returns: A set of all block reference entity IDs that reference the given block.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryChildEntities()

virtual QSet< RObject::Id > RStorage::queryChildEntities	(	RObject::Id	parentId,
		RS::EntityType	type = RS::EntityAll )

pure virtual

Returns: A set of all block attributes which are not stored in the block definition but as separate entities on the same level as the block reference.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryCurrentBlock()

QSharedPointer< RBlock > RStorage::queryCurrentBlock ( )

virtual

◆ queryCurrentLayer()

virtual QSharedPointer< RLayer > RStorage::queryCurrentLayer ( )

inlinevirtual

◆ queryCurrentLinetype()

virtual QSharedPointer< RLinetype > RStorage::queryCurrentLinetype ( ) const

inlinevirtual

◆ queryCurrentView()

virtual QSharedPointer< RView > RStorage::queryCurrentView ( )

inlinevirtual

◆ queryDimStyle()

virtual QSharedPointer< RDimStyle > RStorage::queryDimStyle ( ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryDimStyleDirect()

virtual QSharedPointer< RDimStyle > RStorage::queryDimStyleDirect ( ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryDocumentVariables()

virtual QSharedPointer< RDocumentVariables > RStorage::queryDocumentVariables ( ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryDocumentVariablesDirect()

virtual QSharedPointer< RDocumentVariables > RStorage::queryDocumentVariablesDirect ( ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryEntity()

virtual QSharedPointer< REntity > RStorage::queryEntity ( RObject::Id entityId ) const

pure virtual

Returns: A pointer to the entity with the given entityId or NULL if no such entity exists.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryEntityDirect()

QSharedPointer< REntity > RStorage::queryEntityDirect ( RObject::Id entityId ) const

virtual

Reimplemented in RLinkedStorage, and RMemoryStorage.

◆ queryInfiniteEntities()

virtual QSet< RObject::Id > RStorage::queryInfiniteEntities ( ) const

pure virtual

Returns: A set of entity IDs of all infinite entities (xlines).

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryLayer() [1/2]

virtual QSharedPointer< RLayer > RStorage::queryLayer ( const QString & layerName ) const

pure virtual

Returns: A pointer to the layer with the given layerName or NULL if no such layer exists.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryLayer() [2/2]

virtual QSharedPointer< RLayer > RStorage::queryLayer ( RObject::Id layerId ) const

pure virtual

Returns: A pointer to the layer with the given layerId or NULL if no such layer exists.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryLayerBlockEntities()

virtual QSet< RObject::Id > RStorage::queryLayerBlockEntities	(	RObject::Id	layerId,
		RObject::Id	blockId )

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryLayerDirect() [1/2]

virtual QSharedPointer< RLayer > RStorage::queryLayerDirect ( const QString & layerName ) const

inlinevirtual

◆ queryLayerDirect() [2/2]

virtual QSharedPointer< RLayer > RStorage::queryLayerDirect ( RObject::Id layerId ) const

inlinevirtual

Reimplemented in RLinkedStorage, and RMemoryStorage.

◆ queryLayerEntities()

virtual QSet< RObject::Id > RStorage::queryLayerEntities	(	RObject::Id	layerId,
		bool	allBlocks = false )

pure virtual

Returns: A set of all entity IDs on the given layer.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryLayerState() [1/2]

virtual QSharedPointer< RLayerState > RStorage::queryLayerState ( const QString & layerStateName ) const

pure virtual

Returns: A pointer to the layer with the given layerName or NULL if no such layer exists.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryLayerState() [2/2]

virtual QSharedPointer< RLayerState > RStorage::queryLayerState ( RObject::Id layerStateId ) const

pure virtual

Returns: A pointer to the layer state with the given layerStateId or NULL if no such layer state exists.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryLayerStateDirect() [1/2]

virtual QSharedPointer< RLayerState > RStorage::queryLayerStateDirect ( const QString & layerStateName ) const

inlinevirtual

◆ queryLayerStateDirect() [2/2]

virtual QSharedPointer< RLayerState > RStorage::queryLayerStateDirect ( RObject::Id layerStateId ) const

inlinevirtual

Reimplemented in RLinkedStorage, and RMemoryStorage.

◆ queryLayout() [1/2]

virtual QSharedPointer< RLayout > RStorage::queryLayout ( const QString & layoutName ) const

pure virtual

Returns: A pointer to the layout with the given layoutName or NULL if no such layout exists.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryLayout() [2/2]

virtual QSharedPointer< RLayout > RStorage::queryLayout ( RObject::Id layoutId ) const

pure virtual

Returns: A pointer to the layout with the given layoutId or NULL if no such layout exists.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryLayoutDirect()

virtual QSharedPointer< RLayout > RStorage::queryLayoutDirect ( RObject::Id layoutId ) const

inlinevirtual

Reimplemented in RLinkedStorage, and RMemoryStorage.

◆ queryLinetype() [1/2]

virtual QSharedPointer< RLinetype > RStorage::queryLinetype ( const QString & linetypeName ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryLinetype() [2/2]

virtual QSharedPointer< RLinetype > RStorage::queryLinetype ( RObject::Id linetypeId ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryLinetypeDirect()

virtual QSharedPointer< RLinetype > RStorage::queryLinetypeDirect ( RObject::Id linetypeId ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryObject()

virtual QSharedPointer< RObject > RStorage::queryObject ( RObject::Id objectId ) const

pure virtual

Returns: A shared pointer to the object with the given objectId or null pointer if the object is no available in this storage.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryObjectByHandle()

virtual QSharedPointer< RObject > RStorage::queryObjectByHandle ( RObject::Handle objectHandle ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryObjectCC()

virtual RObject * RStorage::queryObjectCC ( RObject::Id objectId ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryObjectDirect()

virtual QSharedPointer< RObject > RStorage::queryObjectDirect ( RObject::Id objectId ) const

inlinevirtual

Reimplemented in RLinkedStorage, and RMemoryStorage.

◆ querySelectedEntities()

virtual QSet< RObject::Id > RStorage::querySelectedEntities ( ) const

pure virtual

Returns: A set of entity IDs of all selected entities.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ querySelectedLayerEntities()

virtual QSet< RObject::Id > RStorage::querySelectedLayerEntities	(	RObject::Id	layerId,
		bool	allBlocks = false )

pure virtual

Returns: A set of all entity IDs of selected entities on the given layer.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ querySelectedLayers()

virtual QSet< RObject::Id > RStorage::querySelectedLayers ( ) const

pure virtual

Returns: A set of object IDs of all selected objects (layers, ...).

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryUcs() [1/2]

virtual QSharedPointer< RUcs > RStorage::queryUcs ( const QString & ucsName ) const

pure virtual

Returns: A pointer to the UCS with the given ucsName or NULL if no such UCS exists.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryUcs() [2/2]

virtual QSharedPointer< RUcs > RStorage::queryUcs ( RObject::Id ucsId ) const

pure virtual

Returns: A pointer to the UCS with the given ucsId or NULL if no such UCS exists.

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryUcsDirect()

virtual QSharedPointer< RUcs > RStorage::queryUcsDirect ( RObject::Id ucsId ) const

inlinevirtual

Reimplemented in RLinkedStorage, and RMemoryStorage.

◆ queryView() [1/2]

virtual QSharedPointer< RView > RStorage::queryView ( const QString & viewName ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryView() [2/2]

virtual QSharedPointer< RView > RStorage::queryView ( RObject::Id viewId ) const

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ queryVisibleEntityDirect()

QSharedPointer< REntity > RStorage::queryVisibleEntityDirect ( RObject::Id entityId ) const

virtual

Reimplemented in RMemoryStorage.

◆ queryWorkingSetEntities()

virtual QSet< RObject::Id > RStorage::queryWorkingSetEntities ( )

pure virtual

Returns: A set of all entity IDs in the current working set.

Implemented in RMemoryStorage.

◆ registerCustomEntityType()

void RStorage::registerCustomEntityType ( RS::EntityType type )

static

◆ removeObject()

virtual bool RStorage::removeObject ( QSharedPointer< RObject > object )

pure virtual

Implemented in RMemoryStorage.

◆ removeVariable()

virtual void RStorage::removeVariable ( const QString & key )

pure virtual

Removes the custom variable with the given key.

Implemented in RMemoryStorage.

◆ resetTransactionStack()

virtual void RStorage::resetTransactionStack ( )

pure virtual

Implemented in RMemoryStorage.

◆ rollbackTransaction()

virtual void RStorage::rollbackTransaction ( )

pure virtual

Rolls the current transaction back in order to cancel it.

This function should never be called under normal circumstances.

Implemented in RMemoryStorage.

◆ saveObject()

virtual bool RStorage::saveObject	(	QSharedPointer< RObject >	object,
		bool	checkBlockRecursion = true,
		bool	keepHandles = false,
		bool *	overwrite = NULL )

pure virtual

Saves the given object to the storage.

Implemented in RMemoryStorage.

◆ saveTransaction()

virtual void RStorage::saveTransaction ( RTransaction & transaction )

pure virtual

Saves the given transaction.

Transactions need to be stored for undo / redo functionality.

Implemented in RMemoryStorage.

◆ selectAllEntities()

virtual void RStorage::selectAllEntities ( QSet< RObject::Id > * affectedEntities = NULL )

pure virtual

Sets the selection status of all entities.

Implemented in RMemoryStorage.

◆ selectEntities()

virtual int RStorage::selectEntities	(	const QSet< RObject::Id > &	entityIds,
		bool	add = false,
		QSet< RObject::Id > *	affectedEntities = NULL )

pure virtual

Selects all entities with the given IDs.

Parameters

add	True to add the entities to the current selection. False to replace the current selection with the new entities.
affected	Optional pointer to an empty set of entity IDs. After the call, this set will contain all entity IDs of entities that were affected by the call.

Implemented in RMemoryStorage.

◆ selectEntity()

virtual void RStorage::selectEntity	(	RObject::Id	entityId,
		bool	add = false,
		QSet< RObject::Id > *	affectedEntities = NULL )

pure virtual

Selects the entity with the given ID.

Parameters

add	True to add the entity to the current selection. False to replace the current selection with the given entity.
affected	Optional pointer to an empty set of entity IDs. After the call, this set will contain all entity IDs of entities that were affected by the call.

Implemented in RMemoryStorage.

◆ setCurrentBlock() [1/2]

void RStorage::setCurrentBlock ( const QString & blockName )

inline

◆ setCurrentBlock() [2/2]

void RStorage::setCurrentBlock ( RObject::Id blockId )

virtual

Reimplemented in RMemoryStorage.

◆ setCurrentColor()

void RStorage::setCurrentColor ( const RColor & color )

virtual

◆ setCurrentLayer() [1/2]

void RStorage::setCurrentLayer	(	const QString &	layerName,
		RTransaction *	transaction = NULL )

◆ setCurrentLayer() [2/2]

void RStorage::setCurrentLayer	(	RObject::Id	layerId,
		RTransaction *	transaction = NULL )

◆ setCurrentLinetype() [1/2]

void RStorage::setCurrentLinetype ( const QString & name )

◆ setCurrentLinetype() [2/2]

void RStorage::setCurrentLinetype ( RObject::Id ltId )

◆ setCurrentLinetypePattern()

void RStorage::setCurrentLinetypePattern ( const RLinetypePattern & p )

◆ setCurrentLineweight()

void RStorage::setCurrentLineweight ( RLineweight::Lineweight lw )

◆ setCurrentView() [1/2]

void RStorage::setCurrentView ( const QString & viewName )

inline

◆ setCurrentView() [2/2]

void RStorage::setCurrentView ( RObject::Id viewId )

inline

◆ setCurrentViewport()

virtual void RStorage::setCurrentViewport ( RObject::Id viewportId )

inlinevirtual

◆ setDimensionFont()

void RStorage::setDimensionFont	(	const QString &	f,
		RTransaction *	transaction = NULL )

virtual

◆ setDocument()

void RStorage::setDocument ( RDocument * doc )

inline

◆ setEntityParentId()

void RStorage::setEntityParentId	(	REntity &	entity,
		RObject::Id	parentId )

virtual

Reimplemented in RMemoryStorage.

◆ setKnownVariable()

virtual void RStorage::setKnownVariable	(	RS::KnownVariable	key,
		const QVariant &	value,
		RTransaction *	transaction = NULL )

pure virtual

Sets a known DXF/DWG variable for this document.

Parameters

key	Variable key (see DXF reference)
value	New value of the variable.
transaction	RTransaction to use for the change or NULL (default) to create a transaction on the fly.

Implemented in RMemoryStorage.

◆ setLastTransactionId()

virtual void RStorage::setLastTransactionId ( int transactionId )

inlinevirtual

Sets the ID of the last created transaction.

This is called when a transaction is undone or redone (the last transaction id indicates where we are in the transaction stack). The default implementation sets the variable "LastTransaction".

Reimplemented in RMemoryStorage.

◆ setLayer0Id()

virtual void RStorage::setLayer0Id ( RObject::Id id )

inlinevirtual

◆ setLinetypeScale()

void RStorage::setLinetypeScale	(	double	v,
		RTransaction *	transaction = NULL )

virtual

Sets the global linetype scale of this document to the given value.

Parameters

transaction Transaction to use for the modification or NULL to create a local transaction (default).

◆ setMaxDrawOrder()

virtual void RStorage::setMaxDrawOrder ( int m )

inlinevirtual

◆ setMeasurement()

void RStorage::setMeasurement	(	RS::Measurement	m,
		RTransaction *	transaction = NULL )

◆ setModelSpaceBlockId()

virtual void RStorage::setModelSpaceBlockId ( RObject::Id id )

inlinevirtual

◆ setModified()

void RStorage::setModified ( bool m )

Resets the modified flag.

Modification time is stored.

◆ setNotifyListeners()

void RStorage::setNotifyListeners ( bool on )

inline

◆ setObjectHandle()

void RStorage::setObjectHandle	(	RObject &	object,
		RObject::Handle	objectHandle )

virtual

Reimplemented in RMemoryStorage.

◆ setObjectId()

void RStorage::setObjectId	(	RObject &	object,
		RObject::Id	objectId ) const

virtual

◆ setUndoStatus() [1/2]

void RStorage::setUndoStatus	(	RObject &	object,
		bool	status )

virtual

Reimplemented in RMemoryStorage.

◆ setUndoStatus() [2/2]

virtual bool RStorage::setUndoStatus	(	RObject::Id	object,
		bool	status )

pure virtual

Implemented in RLinkedStorage, and RMemoryStorage.

◆ setUnit()

void RStorage::setUnit	(	RS::Unit	unit,
		RTransaction *	transaction = NULL )

◆ setVariable()

virtual void RStorage::setVariable	(	const QString &	key,
		const QVariant &	value,
		bool	overwrite = true )

pure virtual

Sets a custom variable in the context of this document.

Parameters

key	Variable key (name)
value	Variable value
overwrite	True to overwrite an existing variable with the same key (default)

Implemented in RMemoryStorage.

◆ sortBlocks()

QList< RBlock::Id > RStorage::sortBlocks ( const QList< RObject::Id > & blockIds ) const

◆ sortLayers()

QList< RLayer::Id > RStorage::sortLayers ( const QList< RObject::Id > & layerIds ) const

◆ startDocumentVariablesTransaction()

QSharedPointer< RDocumentVariables > RStorage::startDocumentVariablesTransaction	(	RTransaction *&	transaction,
		bool &	useLocalTransaction )

◆ startTransactionGroup()

virtual void RStorage::startTransactionGroup ( )

inlinevirtual

◆ toggleUndoStatus() [1/2]

virtual void RStorage::toggleUndoStatus ( QSet< RObject::Id > & objects )

pure virtual

Toggles the current undo status of all given objects.

The undo status can for example be a boolean value that is true if the object is undone or false otherwise.

Implemented in RMemoryStorage.

◆ toggleUndoStatus() [2/2]

virtual void RStorage::toggleUndoStatus ( RObject::Id object )

pure virtual

Toggles the current undo status of the given object.

Implemented in RMemoryStorage.

◆ unregisterCustomEntityType()

void RStorage::unregisterCustomEntityType ( RS::EntityType type )

static

◆ unsetCurrentViewport()

virtual void RStorage::unsetCurrentViewport ( )

inlinevirtual

◆ update()

virtual void RStorage::update ( )

inlinevirtual

Clear caches:

Reimplemented in RMemoryStorage.

Friends And Related Symbol Documentation

◆ operator<<

QDebug operator<<	(	QDebug	dbg,
		RStorage &	s )

friend

Stream operator for QDebug.

Non-Scriptable:\nThis function is not available in script environments.\n

Member Data Documentation

◆ currentBlockId

RObject::Id RStorage::currentBlockId

private

◆ currentColor

RColor RStorage::currentColor

private

◆ currentLinetypeId

RObject::Id RStorage::currentLinetypeId

private

◆ currentLineweight

RLineweight::Lineweight RStorage::currentLineweight

private

◆ currentViewId

RObject::Id RStorage::currentViewId

private

◆ currentViewportId

RObject::Id RStorage::currentViewportId

private

◆ customEntityTypes

QList< RS::EntityType > RStorage::customEntityTypes

staticprotected

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.

◆ document

RDocument* RStorage::document

private

◆ handleCounter

RObject::Handle RStorage::handleCounter

protected

◆ idCounter

RObject::Id RStorage::idCounter

private

◆ lastModified

QDateTime RStorage::lastModified

protected

◆ lastTransactionGroup

int RStorage::lastTransactionGroup

private

◆ lastTransactionId

int RStorage::lastTransactionId

private

◆ layer0Id

RObject::Id RStorage::layer0Id

private

◆ maxDrawOrder

int RStorage::maxDrawOrder

private

◆ modelSpaceBlockId

RObject::Id RStorage::modelSpaceBlockId

private

◆ modified

bool RStorage::modified

protected

◆ modifiedListeners

QList<RModifiedListener*> RStorage::modifiedListeners

private

◆ notifyGlobalListeners

bool RStorage::notifyGlobalListeners

private

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

src/core/RStorage.h
src/core/RStorage.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RStorage()

◆ ~RStorage()

Member Function Documentation

◆ addModifiedListener()

◆ beginTransaction()

◆ clear()

◆ clearEntitySelection()

◆ commitTransaction()

◆ countSelectedEntities()

◆ deleteObject()

◆ deleteTransactionsFrom()

◆ deselectEntities()

◆ deselectEntity()

◆ endDocumentVariablesTransaction()

◆ getBlockId()

◆ getBlockIdAuto()

◆ getBlockName()

◆ getBlockNameFromHandle()

◆ getBlockNameFromLayout() [1/2]

◆ getBlockNameFromLayout() [2/2]

◆ getBlockNames()

◆ getBoundingBox()

◆ getCurrentBlockId()

◆ getCurrentColor()

◆ getCurrentLayerId()

◆ getCurrentLinetypeId()

◆ getCurrentLinetypePattern()

◆ getCurrentLineweight()

◆ getCurrentViewId()

◆ getCurrentViewportId()

◆ getDimensionFont()

◆ getDocument()

◆ getEntitiesBox()

◆ getKnownVariable()

◆ getKnownVariableName()

◆ getLastModified()

◆ getLastModifiedDateTime()

◆ getLastTransactionId()

◆ getLayer0Id()

◆ getLayerId()

◆ getLayerName()

◆ getLayerNames()

◆ getLayerStateId()

◆ getLayerStateName()

◆ getLayerStateNames()

◆ getLayoutId()

◆ getLayoutName()

◆ getLayoutNames()

◆ getLinetypeDescription()

◆ getLinetypeId()

◆ getLinetypeLabel()

◆ getLinetypeName()

◆ getLinetypeNames()

◆ getLinetypePatterns()

◆ getLinetypeScale()

◆ getMaxDrawOrder()

◆ getMaxLineweight()

◆ getMaxObjectHandle()

◆ getMaxObjectId()

◆ getMaxTransactionId()

◆ getMeasurement()

◆ getMinDrawOrder()

◆ getModelSpaceBlockId()

◆ getNewObjectHandle()

◆ getNewObjectId()

◆ getNotifyListeners()

◆ getSelectionBox()

◆ getTransaction()

◆ getTransactionGroup()

◆ getUnit()

◆ getVariable()