OdDbUndoController Class Reference

#include <DbUndoController.h>

Inheritance diagram for OdDbUndoController:

Public Types
enum	{ kDefault = 0, kBlockBegin = 1, kBlockEnd = 2, kMarker = 3 }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdDbUndoController)
virtual void	pushData (OdStreamBuf *pStream, OdUInt32 nSize, OdUInt32 opt=kDefault)=0
virtual bool	hasData () const =0
virtual OdUInt32	popData (OdStreamBuf *pStream)=0
virtual OdRxIteratorPtr	newRecordStackIterator () const =0
virtual void	clearData ()=0
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

This class defines the interface for Undo Controller objects for OdDbDatabase instances.

Remarks

The implementer manages resources for storing undo and redo information. <group OdDb_Classes>

Definition at line 56 of file DbUndoController.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kDefault
kBlockBegin
kBlockEnd
kMarker

Definition at line 59 of file DbUndoController.h.

Member Function Documentation

clearData()

virtual void OdDbUndoController::clearData ( )

pure virtual

hasData()

virtual bool OdDbUndoController::hasData ( ) const

pure virtual

Returns true if undo information is stored inside this object and can be taken back via call popData.

newRecordStackIterator()

virtual OdRxIteratorPtr OdDbUndoController::newRecordStackIterator ( ) const

pure virtual

ODRX_DECLARE_MEMBERS()

OdDbUndoController::ODRX_DECLARE_MEMBERS

(

OdDbUndoController

)

popData()

virtual OdUInt32 OdDbUndoController::popData ( OdStreamBuf *  pStream )

pure virtual

Gives back most recent single undo step data.

Parameters

pStream

[out] stream

Remarks

Implementer should write back single undo step data saved in this object via the most recent call pushData into specified stream and then free internal resources used for storing undo step.

pushData()

virtual void OdDbUndoController::pushData ( OdStreamBuf *  pStream, OdUInt32  nSize, OdUInt32  opt = kDefault  )

pure virtual

Saves undo information in some manner.

Parameters

pStream	[in] stream that contains single undo step data.
nSize	[in] size of undo information (starting from current stream position).

Remarks

Implementer should save nSize bytes from specified stream.

---

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

• DbUndoController.h