#include <TfObjectReactor.h>

Inheritance diagram for OdTfObjectReactor:

Public Member Functions
virtual void	copied (const OdTfObject pElement, const OdTfObject pNewElement)=0

virtual void	erased (const OdTfObject *pElement, bool erasing=true)=0

virtual void	goodbye (const OdTfObject *pElement)=0

virtual void	openedForModify (const OdTfObject *pElement)=0

virtual void	modified (const OdTfObject *pElement)=0

virtual void	modifiedGraphics (const OdTfObject *pElement)=0

virtual void	modifiedLinkages (const OdTfObject *pElement)=0

virtual void	subElementModified (const OdTfObject pElement, const OdTfObject pSubElm)=0

virtual void	modifyUndone (const OdTfObject *pElement)=0

virtual void	unappended (const OdTfObject *pElement)=0

virtual void	reappended (const OdTfObject *pElement)=0

virtual void	closed (OdDbStub *elementId)=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 is the base class for custom classes that receive notification of OdTfObject events.

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

Corresponding C++ library: Od_Tf

Definition at line 47 of file TfObjectReactor.h.

Member Function Documentation

◆ closed()

virtual void OdTfObjectReactor::closed ( OdDbStub * elementId )

pure virtual

Notification function called immediately before an element is closed.

Parameters

elementId [in] Element ID of the element that is being closed.

Remarks: The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ copied()

virtual void OdTfObjectReactor::copied	(	const OdTfObject *	pElement,
		const OdTfObject *	pNewElement
	)

pure virtual

Notification function called whenever the notifying element has had its clone() member function called.

Parameters

pElement	[in] Pointer to the notifying element.
pNewElement	[in] Pointer to the element resulting from the copy.

Remarks: The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ erased()

virtual void OdTfObjectReactor::erased	(	const OdTfObject *	pElement,
		bool	erasing = `true`
	)

pure virtual

Notification function called whenever an element has been erased or unerased.

Parameters

pElement	[in] Pointer to the element that was erased/unerased.
erasing	[in] True if and only if this element is being erased.

Remarks: The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ goodbye()

virtual void OdTfObjectReactor::goodbye ( const OdTfObject * pElement )

pure virtual

Notification function called just before an element is deleted from memory.

Parameters

pElement [in] Pointer to the element that is being deleted.

Remarks: The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ modified()

virtual void OdTfObjectReactor::modified ( const OdTfObject * pElement )

pure virtual

Notification function called whenever an element is opened OdDg::kForWrite, a function has been called that could modify the contents of this element, and this element is now being closed.

Parameters

pElement [in] Pointer to the element that is being closed after being modified.

Remarks: The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ modifiedGraphics()

virtual void OdTfObjectReactor::modifiedGraphics ( const OdTfObject * pElement )

pure virtual

Notification function called whenever an element derived from OdDgGraphicsElement is modified.

Parameters

pElement [in] Pointer to the modified element.

Remarks: The default implementation of this function does nothing. This function can be overridden in custom classes.

This function is called whenever the following has occurred.

1) The calling element is opened OdDg::kForWrite.

2) One of its member functions either

a Calls its assertWriteEnabled with recordModified == true.

b Calls its recordGraphicsModified(true).

3) The calling element is being closed.

This function is called whenever the element as been modified. It therefore indicates only that the graphics for it may have changed.

◆ modifiedLinkages()

virtual void OdTfObjectReactor::modifiedLinkages ( const OdTfObject * pElement )

pure virtual

Notification function called whenever the attribute linkages has been written to the notifying element.

Parameters

pElement [in] Pointer to the notifying element.

Remarks: Notification is made upon pElement->close().

The notifying element is open OdDg::kForRead.

The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ modifyUndone()

virtual void OdTfObjectReactor::modifyUndone ( const OdTfObject * pElement )

pure virtual

Notification function called whenever the notifying element is in the midst an Undo operation that is undoing modifications.

Parameters

pElement [in] Pointer to the notifying element.

Remarks: The notifying element is open OdDg::kForRead.

The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ openedForModify()

virtual void OdTfObjectReactor::openedForModify ( const OdTfObject * pElement )

pure virtual

Notification function called whenever an element is opened for modify OdDg::kForWrite.

Parameters

pElement [in] Pointer to the element that is being opened.

Remarks: The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ reappended()

virtual void OdTfObjectReactor::reappended ( const OdTfObject * pElement )

pure virtual

Notification function called whenever a Redo process processes the reappending of the notifying element to the database.

Parameters

pElement [in] Pointer to the notifying element.

Remarks

The default implementation of this function does nothing. This function can be overridden in custom classes.

◆ subElementModified()

virtual void OdTfObjectReactor::subElementModified	(	const OdTfObject *	pElement,
		const OdTfObject *	pSubElm
	)

pure virtual

Notification function called whenever a method of the specified subelement has called assertWriteEnabled()

Parameters

pElement	[in] Pointer to the notifying element.
pSubElm	[in] A pointer to the subelement owned by pElement.

Remarks: Notification is made upon pElement->close().

◆ unappended()

virtual void OdTfObjectReactor::unappended ( const OdTfObject * pElement )

pure virtual

Notification function called whenever the Undo process processes the appending of the notifying element to the database.

Parameters

pElement [in] Pointer to the notifying element.

Remarks: The notifying element is marked as erased. It is not removed the database, and can be unerased, even 'before' it was created.

The default implementation of this function does nothing. This function can be overridden in custom classes.

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

TfObjectReactor.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ closed()

◆ copied()

◆ erased()

◆ goodbye()

◆ modified()

◆ modifiedGraphics()

◆ modifiedLinkages()

◆ modifyUndone()

◆ openedForModify()

◆ reappended()

◆ subElementModified()

◆ unappended()