#include <RxEvent.h>

Inheritance diagram for OdRxEventReactor:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdRxEventReactor)

virtual void	dwgFileOpened (OdDbDatabase *pDb, const OdString &filename)

virtual void	initialDwgFileOpenComplete (OdDbDatabase *pDb)

virtual void	databaseConstructed (OdDbDatabase *pDb)

virtual void	databaseToBeDestroyed (OdDbDatabase *pDb)

virtual void	beginSave (OdDbDatabase *pDb, const OdString &intendedName)

virtual void	saveComplete (OdDbDatabase *pDb, const OdString &actualName)

virtual void	abortSave (OdDbDatabase *pDb)

virtual void	beginDxfIn (OdDbDatabase *pDb)

virtual void	abortDxfIn (OdDbDatabase *pDb)

virtual void	dxfInComplete (OdDbDatabase *pDb)

virtual void	beginDxfOut (OdDbDatabase *pDb)

virtual void	abortDxfOut (OdDbDatabase *pDb)

virtual void	dxfOutComplete (OdDbDatabase *pDb)

virtual void	beginInsert (OdDbDatabase pToDb, const OdString &blockName, OdDbDatabase pFromDb)

virtual void	beginInsert (OdDbDatabase pToDb, const OdGeMatrix3d &xfm, OdDbDatabase pFromDb)

virtual void	otherInsert (OdDbDatabase pToDb, OdDbIdMapping &idMap, OdDbDatabase pFromDb)

virtual void	abortInsert (OdDbDatabase *pToDb)

virtual void	endInsert (OdDbDatabase *pToDb)

virtual void	wblockNotice (OdDbDatabase *pFromDb)

virtual void	beginWblock (OdDbDatabase pToDb, OdDbDatabase pFromDb, const OdGePoint3d &insertionPoint)

virtual void	beginWblock (OdDbDatabase pToDb, OdDbDatabase pFromDb, OdDbObjectId blockId)

virtual void	beginWblock (OdDbDatabase pToDb, OdDbDatabase pFromDb)

virtual void	otherWblock (OdDbDatabase pToDb, OdDbIdMapping &idMap, OdDbDatabase pFromDb)

virtual void	abortWblock (OdDbDatabase *pToDb)

virtual void	endWblock (OdDbDatabase *pToDb)

virtual void	beginWblockObjects (OdDbDatabase *pFromDb, OdDbIdMapping &idMap)

virtual void	beginDeepClone (OdDbDatabase *pToDb, OdDbIdMapping &idMap)

virtual void	beginDeepCloneXlation (OdDbIdMapping &idMap)

virtual void	abortDeepClone (OdDbIdMapping &idMap)

virtual void	endDeepClone (OdDbIdMapping &idMap)

virtual void	partialOpenNotice (OdDbDatabase *pDb)

virtual void	xrefSubCommandStart (OdDbDatabase *pHostDb, OdXrefSubCommand subCmd, const OdDbObjectIdArray &btrIds, const OdStringArray &btrNames, const OdStringArray &paths, bool &vetoOp)

virtual void	xrefSubCommandEnd (OdDbDatabase *pHostDb, OdXrefSubCommand subCmd, const OdDbObjectIdArray &btrIds, const OdStringArray &btrNames, const OdStringArray &paths)

virtual void	xrefSubCommandAborted (OdDbDatabase *pHostDb, OdXrefSubCommand subCmd, const OdDbObjectIdArray &btrIds, const OdStringArray &btrNames, const OdStringArray &paths)

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 is the base class for custom classes that receive notification of OdRxEvent (application level) events.

Remarks: The default implementations of all methods in this class do nothing but return.

Definition at line 68 of file RxEvent.h.

Member Function Documentation

◆ abortDeepClone()

virtual void OdRxEventReactor::abortDeepClone ( OdDbIdMapping & idMap )

virtual

Notification function called whenever a subDeepClone operation has failed.

Parameters

idMap [in] ID Map source -> destination.

Remarks: This function is called after the operation.; The objects involved in the subDeepClone operation are in an indeterminate state and must be cleaned up.

See also: beginDeepClone beginDeepCloneXlation endDeepClone

◆ abortDxfIn()

virtual void OdRxEventReactor::abortDxfIn ( OdDbDatabase * pDb )

virtual

Notification function called whenever the DXF input to a database has failed.

Parameters

pDb	[in] Pointer to the database being modified.

Remarks: This function is called after the operation.

See also: beginDxfIn dxfInComplete

◆ abortDxfOut()

virtual void OdRxEventReactor::abortDxfOut ( OdDbDatabase * pDb )

virtual

Notification function called whenever the DXF output from a database has failed.

Parameters

pDb	[in] Pointer to the database being saved.

Remarks: This function is called after the operation.

See also: beginDxfOut dxfOutComplete

◆ abortInsert()

virtual void OdRxEventReactor::abortInsert ( OdDbDatabase * pToDb )

virtual

Notification function called whenever the insertion of a database has failed.

Parameters

pToDb [in] Destination database.

Remarks: This function is called after the operation.

See also: beginInsert endInsert otherInsert

◆ abortSave()

virtual void OdRxEventReactor::abortSave ( OdDbDatabase * pDb )

virtual

Notification function called whenever the save of a database has failed.

Parameters

pDb	[in] Pointer to the database being saved.

Remarks: This function is called after the operation.

See also: beginSave saveComplete

◆ abortWblock()

virtual void OdRxEventReactor::abortWblock ( OdDbDatabase * pToDb )

virtual

Notification function called whenever the wblock of a database has failed.

Parameters

pToDb [in] Destination database.

Remarks: This function is called after the operation.

See also: beginWblock beginWblockObjects endWblock otherWblock wblockNotice

◆ beginDeepClone()

virtual void OdRxEventReactor::beginDeepClone	(	OdDbDatabase *	pToDb,
		OdDbIdMapping &	idMap
	)

virtual

Notification function called whenever a subDeepClone operation is about to be started on a database.

Parameters

pToDb	[in] Destination database.
idMap	[in] ID Map source -> destination.

Remarks: idMap will always be empty.

See also: abortDeepClone beginDeepCloneXlation endDeepClone

◆ beginDeepCloneXlation()

virtual void OdRxEventReactor::beginDeepCloneXlation ( OdDbIdMapping & idMap )

virtual

Notification function called whenever a the translation stage of a subDeepClone operation is about to be started on a database.

Parameters

idMap [in] ID Map source -> destination.

Remarks: This function is called after all objects, and their owned objects, have been cloned. It is called before any Object IDs are translated; Object IDs of cloned objects do not point at the cloned objects, and must therefore not not be used at this point for any operations on those objects.

See also: abortDeepClone beginDeepClone endDeepClone

◆ beginDxfIn()

virtual void OdRxEventReactor::beginDxfIn ( OdDbDatabase * pDb )

virtual

Notification function called whenever a database is about to be modified by a DXF input operation.

Parameters

pDb	[in] Pointer to the database to be modified.

Remarks: This function is called before the operation.

See also: abortDxfIn dxfInComplete

◆ beginDxfOut()

virtual void OdRxEventReactor::beginDxfOut ( OdDbDatabase * pDb )

virtual

Notification function called whenever a database is about to be saved to a DXF file.

Parameters

pDb	[in] Pointer to the database to be saved.

Remarks: This function is called before the operation

See also: abortDxfOut dxfOutComplete

◆ beginInsert() [1/2]

virtual void OdRxEventReactor::beginInsert	(	OdDbDatabase *	pToDb,
		const OdGeMatrix3d &	xfm,
		OdDbDatabase *	pFromDb
	)

virtual

Notification function called whenever one database is about to be inserted into another.

Parameters

pToDb	[in] Destination database.
pFromDb	[in] Source database.
xfm	[in] Transformation matrix.

Remarks: This function is called before the operation.; If xfm is specified, pFromDb was inserted into pToDb as entities.

See also: abortInsert endInsert otherInsert

◆ beginInsert() [2/2]

virtual void OdRxEventReactor::beginInsert	(	OdDbDatabase *	pToDb,
		const OdString &	blockName,
		OdDbDatabase *	pFromDb
	)

virtual

Notification function called whenever one database is about to be inserted into another.

Parameters

pToDb	[in] Destination database.
pFromDb	[in] Source database.
blockName	[in] Name of the block.

Remarks: This function is called before the operation.; If blockName is specified, pFromDb was inserted into pToDb as a OdDbBlockTableRecord.

See also: abortInsert endInsert otherInsert

◆ beginSave()

virtual void OdRxEventReactor::beginSave	(	OdDbDatabase *	pDb,
		const OdString &	intendedName
	)

virtual

Notification function called whenever a database is about to be saved to a .dwg file.

Parameters

pDb	[in] Pointer to the database to be saved.
intendedName	[in] Intended name of the .dwg file.

Remarks: This function is called before the operation, and before the user has had a chance to modify the filename. The file may not have the intendedName.

See also: abortSave saveComplete

◆ beginWblock() [1/3]

virtual void OdRxEventReactor::beginWblock	(	OdDbDatabase *	pToDb,
		OdDbDatabase *	pFromDb
	)

virtual

Notification function called while one database is being wblocked to another.

Parameters

pToDb	[in] Destination database.
pFromDb	[in] Source database.

Remarks: This function is called during the operation.

The entire pFromDb database is wblocked to pToDb.

See also: abortWblock beginWblockObjects endWblock otherWblock wblockNotice

◆ beginWblock() [2/3]

virtual void OdRxEventReactor::beginWblock	(	OdDbDatabase *	pToDb,
		OdDbDatabase *	pFromDb,
		const OdGePoint3d &	insertionPoint
	)

virtual

Notification function called while one database is being wblocked to another.

Parameters

pToDb	[in] Destination database.
pFromDb	[in] Source database.
insertionPoint	[in] INSBASE of pToDb.

Remarks: This function is called during the operation.

If insertionPoint is specified, the wblock operation is being performed on a set of entities in pFromDb.

See also: abortWblock beginWblockObjects endWblock otherWblock wblockNotice

◆ beginWblock() [3/3]

virtual void OdRxEventReactor::beginWblock	(	OdDbDatabase *	pToDb,
		OdDbDatabase *	pFromDb,
		OdDbObjectId	blockId
	)

virtual

Notification function called while one database is being wblocked to another.

Parameters

pToDb	[in] Destination database.
pFromDb	[in] Source database.
blockId	[in] Object ID of OdDbBlockTableRecord being wblocked.

Remarks: This function is called during the operation.

If blockId is specified, the wblock operation is being performed on a BlockTableRecord in pFromDb.

See also: abortWblock beginWblockObjects endWblock otherWblock wblockNotice

◆ beginWblockObjects()

virtual void OdRxEventReactor::beginWblockObjects	(	OdDbDatabase *	pFromDb,
		OdDbIdMapping &	idMap
	)

virtual

Notification function called whenever one database is being wblocked to another.

Parameters

pFromDb	[in] Source database.
idMap	[in] ID Map source -> destination.

Remarks: idMap contains mapping of the original objects in pFromDb to the objects created in pToDb.

This notification function gives wblockCloneObjects a method of being notified before each pFrom database before the actual cloning begins.

See also: abortWblock beginWblock endWblock otherWblock wblockNotice

◆ databaseConstructed()

virtual void OdRxEventReactor::databaseConstructed ( OdDbDatabase * pDb )

virtual

Notification function called whenever a database has been constructed from a file.

Parameters

pDb	[in] Pointer to the database constructed.

Remarks: This function is called after the operation.

See also: dwgFileOpened initialDwgFileOpenComplete

◆ databaseToBeDestroyed()

virtual void OdRxEventReactor::databaseToBeDestroyed ( OdDbDatabase * pDb )

virtual

Notification function called whenever a database is about to be deleted from memory.

Parameters

pDb	[in] Pointer to the database to be destroyed.

Remarks: This function is called before the operation.

◆ dwgFileOpened()

virtual void OdRxEventReactor::dwgFileOpened	(	OdDbDatabase *	pDb,
		const OdString &	filename
	)

virtual

Notification function called whenever a .dwg file is being read.

Parameters

pDb	[in] Pointer to the database being created.
filename	[in] Name of the .dwg file.

Remarks: This function is called during the operation.

See also: databaseConstructed initialDwgFileOpenComplete

Reimplemented in OdEditorReactor.

◆ dxfInComplete()

virtual void OdRxEventReactor::dxfInComplete ( OdDbDatabase * pDb )

virtual

Notification function called whenever a database has been modified by a DXF input operation.

Parameters

pDb	[in] Pointer to the database modified.

Remarks: This function is called after the operation.

See also: abortDxfIn beginDxfIn

◆ dxfOutComplete()

virtual void OdRxEventReactor::dxfOutComplete ( OdDbDatabase * pDb )

virtual

Notification function called whenever a database has be saved to a DXF file.

Parameters

pDb	[in] Pointer to the database saved.

Remarks: This function is called after the operation.

See also: abortDxfOut beginDxfOut

◆ endDeepClone()

virtual void OdRxEventReactor::endDeepClone ( OdDbIdMapping & idMap )

virtual

Notification function called whenever a subDeepClone operation has succeeded.

Parameters

idMap [in] ID Map source -> destination.

Remarks: This function is called after the operation.

See also: abortDeepClone beginDeepClone beginDeepCloneXlation

◆ endInsert()

virtual void OdRxEventReactor::endInsert ( OdDbDatabase * pToDb )

virtual

Notification function called whenever the insertion of a database has succeeded.

Parameters

pToDb [in] Destination database.

Remarks: This function is called after the operation.

See also: abortInsert beginInsert otherInsert

◆ endWblock()

virtual void OdRxEventReactor::endWblock ( OdDbDatabase * pToDb )

virtual

Notification function called whenever the wblock of a database has succeded.

Parameters

pToDb [in] Destination database.

Remarks: This function is called after the operation.

See also: abortWblock beginWblock beginWblockObjects otherWblock wblockNotice

◆ initialDwgFileOpenComplete()

virtual void OdRxEventReactor::initialDwgFileOpenComplete ( OdDbDatabase * pDb )

virtual

Notification function called whenever a .dwg file has been read.

Parameters

pDb	[in] Pointer to the database being created.

Remarks: This function is called after the read operation, but before the database is constructed.

See also: databaseConstructed dwgFileOpened

◆ ODRX_DECLARE_MEMBERS()

OdRxEventReactor::ODRX_DECLARE_MEMBERS ( OdRxEventReactor )

◆ otherInsert()

virtual void OdRxEventReactor::otherInsert	(	OdDbDatabase *	pToDb,
		OdDbIdMapping &	idMap,
		OdDbDatabase *	pFromDb
	)

virtual

Notification function called whenever one database has been inserted into another.

Parameters

pToDb	[in] Destination database.
pFromDb	[in] Source database.
idMap	[in] ID Map source -> destination.

Remarks: This function is called after the operation, and is sent just before beginDeepCloneXlation. It is called before any Object IDs are translated.; Object IDs of cloned objects do not point at the cloned objects, and must therefore not not be used at this point for any operations on those objects.

See also: abortInsert beginInsert endInsert

◆ otherWblock()

virtual void OdRxEventReactor::otherWblock	(	OdDbDatabase *	pToDb,
		OdDbIdMapping &	idMap,
		OdDbDatabase *	pFromDb
	)

virtual

Notification function called whenever one database is being wblocked to another.

Parameters

pToDb	[in] Destination database.
pFromDb	[in] Source database.
idMap	[in] ID Map source -> destination.

Remarks: idMap contains mapping of the original objects in pFromDb to the objects created in pToDb.

This function is called after the operation, and is sent just before beginDeepCloneXlation.

See also: abortWblock beginWblock beginWblockObjects endWblock wblockNotice

◆ partialOpenNotice()

virtual void OdRxEventReactor::partialOpenNotice ( OdDbDatabase * pDb )

virtual

Notification function called before an attempt is made to partially open an OdDbDatabase.

Parameters

pDb	[in] Pointer to the database.

Remarks

To veto the partial open, an application should override partialOpenNotice, and from it call

        pDb->disablePartialOpen()

◆ saveComplete()

virtual void OdRxEventReactor::saveComplete	(	OdDbDatabase *	pDb,
		const OdString &	actualName
	)

virtual

Notification function called whenever a database has been saved to a .dwg file.

Parameters

pDb	[in] Pointer to the database saved.
actualName	[in] Actual name of the .dwg file.

Remarks: This function is called after the operation, but before the database is constructed.

See also: abortSave beginSave

◆ wblockNotice()

virtual void OdRxEventReactor::wblockNotice ( OdDbDatabase * pFromDb )

virtual

Notification function called while one database is about to be wblocked to another.

Parameters

pFromDb [in] Source database.

◆ xrefSubCommandAborted()

virtual void OdRxEventReactor::xrefSubCommandAborted	(	OdDbDatabase *	pHostDb,
		OdXrefSubCommand	subCmd,
		const OdDbObjectIdArray &	btrIds,
		const OdStringArray &	btrNames,
		const OdStringArray &	paths
	)

virtual

◆ xrefSubCommandEnd()

virtual void OdRxEventReactor::xrefSubCommandEnd	(	OdDbDatabase *	pHostDb,
		OdXrefSubCommand	subCmd,
		const OdDbObjectIdArray &	btrIds,
		const OdStringArray &	btrNames,
		const OdStringArray &	paths
	)

virtual

◆ xrefSubCommandStart()

virtual void OdRxEventReactor::xrefSubCommandStart	(	OdDbDatabase *	pHostDb,
		OdXrefSubCommand	subCmd,
		const OdDbObjectIdArray &	btrIds,
		const OdStringArray &	btrNames,
		const OdStringArray &	paths,
		bool &	vetoOp
	)

virtual

Reimplemented in OdEditorReactor.

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

RxEvent.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ abortDeepClone()

◆ abortDxfIn()

◆ abortDxfOut()

◆ abortInsert()

◆ abortSave()

◆ abortWblock()

◆ beginDeepClone()

◆ beginDeepCloneXlation()

◆ beginDxfIn()

◆ beginDxfOut()

◆ beginInsert() [1/2]

◆ beginInsert() [2/2]

◆ beginSave()

◆ beginWblock() [1/3]

◆ beginWblock() [2/3]

◆ beginWblock() [3/3]

◆ beginWblockObjects()

◆ databaseConstructed()

◆ databaseToBeDestroyed()

◆ dwgFileOpened()

◆ dxfInComplete()

◆ dxfOutComplete()

◆ endDeepClone()

◆ endInsert()

◆ endWblock()

◆ initialDwgFileOpenComplete()

◆ ODRX_DECLARE_MEMBERS()

◆ otherInsert()

◆ otherWblock()

◆ partialOpenNotice()

◆ saveComplete()

◆ wblockNotice()

◆ xrefSubCommandAborted()

◆ xrefSubCommandEnd()

◆ xrefSubCommandStart()