OdEditorReactor Class Reference

#include <Editor.h>

Inheritance diagram for OdEditorReactor:

Public Types
enum	XrefSubcommandActivities {   kStart = 0 , kStartItem = 2 , kEndItem = 3 , kEnd = 4 ,   kWillAbort = 5 , kAborted = 6 , kStartXBindBlock = 7 , kStartXBindSymbol = 8 }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdEditorReactor)
virtual void	beginDwgOpen (const OdString &filename)
virtual void	endDwgOpen (const OdString &filename)
virtual void	beginClose (OdDbDatabase *pDb)
virtual void	dwgFileOpened (OdDbDatabase *pDb, const OdString &filename)
virtual void	beginAttach (OdDbDatabase *pToDb, const OdString &filename, OdDbDatabase *pFromDb)
virtual void	otherAttach (OdDbDatabase *pToDb, OdDbDatabase *pFromDb)
virtual void	abortAttach (OdDbDatabase *pFromDb)
virtual void	endAttach (OdDbDatabase *pToDb)
virtual void	redirected (OdDbObjectId newId, OdDbObjectId oldId)
virtual void	comandeered (OdDbDatabase *pToDb, OdDbObjectId id, OdDbDatabase *pFromDb)
virtual void	beginRestore (OdDbDatabase *pToDb, const OdString &filename, OdDbDatabase *pFromDb)
virtual void	abortRestore (OdDbDatabase *pToDb)
virtual void	endRestore (OdDbDatabase *pToDb)
virtual void	xrefSubcommandBindItem (int activity, OdDbObjectId blockId)
virtual void	xrefSubcommandAttachItem (int activity, const OdString &xrefPath)
virtual void	xrefSubcommandOverlayItem (int activity, const OdString &xrefPath)
virtual void	xrefSubcommandDetachItem (int activity, OdDbObjectId blockId)
virtual void	xrefSubcommandPathItem (int activity, OdDbObjectId blockId, const OdString &newPath)
virtual void	xrefSubcommandReloadItem (int activity, OdDbObjectId blockId)
virtual void	xrefSubcommandUnloadItem (int activity, OdDbObjectId blockId)
virtual void	undoSubcommandAuto (int activity, bool undoAuto)
virtual void	undoSubcommandControl (int activity, int option)
virtual void	undoSubcommandBegin (int activity)
virtual void	undoSubcommandEnd (int activity)
virtual void	undoSubcommandMark (int activity)
virtual void	undoSubcommandBack (int activity)
virtual void	undoSubcommandNumber (int activity, int numSteps)
virtual void	pickfirstModified ()
virtual void	layoutSwitched (const OdString &newLayoutName)
virtual void	docFrameMovedOrResized (OdHWnd hwndDocFrame, bool moved)
virtual void	mainFrameMovedOrResized (OdHWnd hwndMainFrame, bool moved)
virtual void	beginDoubleClick (const OdGePoint3d &clickPoint)
virtual void	beginRightClick (const OdGePoint3d &clickPoint)
virtual void	toolbarBitmapSizeWillChange (bool largeBitmaps)
virtual void	toolbarBitmapSizeChanged (bool largeBitmaps)
virtual void	objectsLazyLoaded (const OdDbObjectIdArray &objectIds)
virtual void	beginQuit ()
virtual void	quitAborted ()
virtual void	quitWillStart ()
virtual void	modelessOperationWillStart (const OdString &contextString)
virtual void	modelessOperationEnded (const OdString &contextString)
virtual void	sysVarChanged (OdDbDatabase *pDb, const OdString &varName)
virtual void	sysVarWillChange (OdDbDatabase *pDb, const OdString &varName)
virtual void	xrefSubCommandStart (OdDbDatabase *pHostDb, OdXrefSubCommand subCmd, const OdDbObjectIdArray &btrIds, const OdStringArray &btrNames, const OdStringArray &paths)
virtual void	xrefSubCommandStart (OdDbDatabase *pHostDb, OdXrefSubCommand subCmd, const OdDbObjectIdArray &btrIds, const OdStringArray &btrNames, const OdStringArray &paths, bool &veto) ODRX_OVERRIDE
Public Member Functions inherited from OdRxEventReactor
	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 OdEditor events.

Remarks

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

<group Other_Classes>

Definition at line 53 of file Editor.h.

Member Enumeration Documentation

XrefSubcommandActivities

enum OdEditorReactor::XrefSubcommandActivities

Enumerator
kStart
kStartItem
kEndItem
kEnd
kWillAbort
kAborted
kStartXBindBlock
kStartXBindSymbol

Definition at line 268 of file Editor.h.

Member Function Documentation

abortAttach()

virtual void OdEditorReactor::abortAttach ( OdDbDatabase *  pFromDb )

virtual

Notification function called whenever the attachment of an Xref database has failed.

Parameters

pToDb

[in] Host database.

Remarks

This function is called after the operation.

See also

beginAttach endAttach
otherAttach

abortRestore()

virtual void OdEditorReactor::abortRestore ( OdDbDatabase *  pToDb )

virtual

Notification function called whenever the restore of an Xref database has failed.

Parameters

pToDb

[in] Host database.

Remarks

This function is called after the operation.

See also

beginRestore endRestore

beginAttach()

virtual void OdEditorReactor::beginAttach ( OdDbDatabase *  pToDb, const OdString &  filename, OdDbDatabase *  pFromDb  )

virtual

Notification function called whenever an Xref database is about to be attached to a host database.

Parameters

pToDb	[in] Host database.
pFromDb	[in] Xref database.
filename	[in] Xref filename.

Remarks

This function is called before the operation.

filename may not have a path or extension.

See also

abortAttach endAttach
otherAttach

beginClose()

virtual void OdEditorReactor::beginClose ( OdDbDatabase *  pDb )

virtual

Notification function called whenever an OdDbDatabase instance is about to be closed.

Parameters

pDb	[in] Pointer to the database being closed.

Remarks

This function is called before the operation.

beginDoubleClick()

virtual void OdEditorReactor::beginDoubleClick ( const OdGePoint3d &  clickPoint )

virtual

Notification function called to indicate the mouse button has been double-clicked in the graphics screen area.

Parameters

clickPoint

[in] WCS double-click point.

See also

beginRightClick

beginDwgOpen()

virtual void OdEditorReactor::beginDwgOpen ( const OdString &  filename )

virtual

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

Parameters

filename

[in] Name of the .dwg file.

Remarks

This function is called before the operation.

See also

dwgFileOpened endDwgOpen

beginQuit()

virtual void OdEditorReactor::beginQuit ( )

virtual

Notification function called whenever the Editor is about to shut down.

Remarks

Calling veto() will cancel the shutdown.

beginRestore()

virtual void OdEditorReactor::beginRestore ( OdDbDatabase *  pToDb, const OdString &  filename, OdDbDatabase *  pFromDb  )

virtual

Notification function called whenever an Xref database is about to be reloaded to a host database, when the Xref drawing file is unchanged.

Parameters

pToDb	[in] Host database.
pFromDb	[in] Xref database.
filename	[in] Xref filename.

Remarks

This function is called before the operation.

filename may not have a path or extension.

See also

abortRestore endRestore

beginRightClick()

virtual void OdEditorReactor::beginRightClick ( const OdGePoint3d &  clickPoint )

virtual

Notification function called to indicate the mouse button has been right-clicked in the graphics area.

Parameters

clickPoint

[in] WCS right-click point.

See also

beginDoubleClick

comandeered()

virtual void OdEditorReactor::comandeered ( OdDbDatabase *  pToDb, OdDbObjectId  id, OdDbDatabase *  pFromDb  )

virtual

Notification function called whenever an object in an Xref database has been comandeered.

Parameters

pToDb	[in] Host database.
pFromDb	[in] Xref database.
objectId	[in] Object ID of the comandeered object.

Remarks

Rather than copy an Xref dependent object to the host database, the Object ID of the object is merely appended to the host database symbol table with the name of the Xref prepended to it.

Thus, the block BAR in the xrefed database FOO, becomes FOO|BAR in the host database.

docFrameMovedOrResized()

virtual void OdEditorReactor::docFrameMovedOrResized ( OdHWnd  hwndDocFrame, bool  moved  )

virtual

Notification function called to indicate an MDI document frame window has been moved or resized.

Parameters

hwndDocFrame	[in] HWND of document frame.
moved	[in] True if moved, false if resized.

See also

mainFrameMovedOrResized

dwgFileOpened()

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

virtual

See also

beginDwgOpen endDwgOpen

Reimplemented from OdRxEventReactor.

endAttach()

virtual void OdEditorReactor::endAttach ( OdDbDatabase *  pToDb )

virtual

Notification function called whenever the attachment of an Xref database has succeeded.

Parameters

pToDb

[in] Host database.

Remarks

This function is called after the operation.

See also

abortAttach beginAttach otherAttach

endDwgOpen()

virtual void OdEditorReactor::endDwgOpen ( const OdString &  filename )

virtual

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

Parameters

filename

[in] Name of the .dwg file.

Remarks

This function is called after the operation.

See also

beginDwgOpen dwgFileOpened

endRestore()

virtual void OdEditorReactor::endRestore ( OdDbDatabase *  pToDb )

virtual

Notification function called whenever the restore of an Xref database has succeeded.

Parameters

pToDb

[in] Host database.

Remarks

This function is called after the operation.

See also

abortRestore beginAttach

layoutSwitched()

virtual void OdEditorReactor::layoutSwitched ( const OdString &  newLayoutName )

virtual

Notification function called to indicate the current layout has changed.

Parameters

newLayoutName

[in] New layout name.

mainFrameMovedOrResized()

virtual void OdEditorReactor::mainFrameMovedOrResized ( OdHWnd  hwndMainFrame, bool  moved  )

virtual

Notification function called to indicate the Editor main frame window has been moved or resized.

Parameters

hwndMainFrame	[in] HWND of the main frame.
moved	[in] True if moved, false if resized.

See also

docFrameMovedOrResized

modelessOperationEnded()

virtual void OdEditorReactor::modelessOperationEnded ( const OdString &  contextString )

virtual

Notification function called whenever a modeless operation has ended.

Parameters

contextString

[in] Context string identifying the operation.

See also

modelessOperationWillStart

modelessOperationWillStart()

virtual void OdEditorReactor::modelessOperationWillStart ( const OdString &  contextString )

virtual

Notification function called whenever a modeless operation is about to start.

Parameters

contextString

[in] Context string identifying the operation.

See also

modelessOperationEnded

objectsLazyLoaded()

virtual void OdEditorReactor::objectsLazyLoaded ( const OdDbObjectIdArray &  objectIds )

virtual

Notification function called after objects are lazy during a partial open of a drawing.

Parameters

objectIDs

[in] Object IDs lazy loaded.

ODRX_DECLARE_MEMBERS()

OdEditorReactor::ODRX_DECLARE_MEMBERS

(

OdEditorReactor

)

otherAttach()

virtual void OdEditorReactor::otherAttach ( OdDbDatabase *  pToDb, OdDbDatabase *  pFromDb  )

virtual

Notification function called whenever an Xref database has been attached to a host database.

Parameters

pToDb	[in] Host database.
pFromDb	[in] Xref database.

Remarks

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

See also

abortAttach beginAttach endAttach

pickfirstModified()

virtual void OdEditorReactor::pickfirstModified ( )

virtual

Notification function called to indicate the number of entities in the pickfirst selection set has been changed.

quitAborted()

virtual void OdEditorReactor::quitAborted ( )

virtual

Notification function called whenever the Editor has failed to shut down.

See also

beginQuit quitWillStart

quitWillStart()

virtual void OdEditorReactor::quitWillStart ( )

virtual

Notification function called whenever the Editor is about to shut down.

Remarks

This function is called after beginQuit was not vetoed.

See also

beginQuit quitAborted

redirected()

virtual void OdEditorReactor::redirected ( OdDbObjectId  newId, OdDbObjectId  oldId  )

virtual

Notification function called whenever an Object ID in an Xref database has been modified to point at an associated object in a host database.

Parameters

oldId	[in] Object Id in the Xref database.
neId	[in] Object Id in the host database.

Remarks

This function is called after the operation.

Redirection is used to implement VISRETAIN.

sysVarChanged()

virtual void OdEditorReactor::sysVarChanged ( OdDbDatabase *  pDb, const OdString &  varName  )

virtual

sysVarWillChange()

virtual void OdEditorReactor::sysVarWillChange ( OdDbDatabase *  pDb, const OdString &  varName  )

virtual

toolbarBitmapSizeChanged()

virtual void OdEditorReactor::toolbarBitmapSizeChanged ( bool  largeBitmaps )

virtual

Notification function called to indicate the toolbar bitmap size has changed.

Parameters

largeBitmaps

[in] True if and only if large bitmaps. \remarks This function is called after the operation.

See also

toolbarBitmapSizeWillChange

toolbarBitmapSizeWillChange()

virtual void OdEditorReactor::toolbarBitmapSizeWillChange ( bool  largeBitmaps )

virtual

Notification function called to indicate the toolbar bitmap size is about to change.

Parameters

largeBitmaps

[in] True if and only if large bitmaps. \remarks This function is called before the operation.

See also

toolbarBitmapSizeChanged

undoSubcommandAuto()

virtual void OdEditorReactor::undoSubcommandAuto ( int  activity, bool  undoAuto  )

virtual

Notification function called during an Undo Auto operation.

Parameters

activity	[in] Auto activity.
undoAuto	[in] True if and only if Undo Auto mode is on.

Remarks

activity will always be:

Value Description kEnd 4 The Auto operation has completed successfully.

See also

undoSubcommandBack undoSubcommandBegin undoSubcommandControl undoSubcommandEnd undoSubcommandMark undoSubcommandNumber

undoSubcommandBack()

virtual void OdEditorReactor::undoSubcommandBack ( int  activity )

virtual

Notification function called during an Undo Back operation.

Parameters

activity

[in] Back activity.

Remarks

activity will always be:

Value Description kStart 0 The Undo Back has started.

See also

undoSubcommandAuto undoSubcommandBegin undoSubcommandControl undoSubcommandEnd undoSubcommandMark undoSubcommandNumber

undoSubcommandBegin()

virtual void OdEditorReactor::undoSubcommandBegin ( int  activity )

virtual

Notification function called during an Undo Begin or Undo Group operation.

Parameters

activity

[in] Begin activity.

Remarks

activity will always be:

Value Description kStart 0 The Undo Begin/Group has started.

See also

undoSubcommandAuto undoSubcommandBack undoSubcommandControl undoSubcommandEnd undoSubcommandMark undoSubcommandNumber

undoSubcommandControl()

virtual void OdEditorReactor::undoSubcommandControl ( int  activity, int  option  )

virtual

Notification function called during an Undo Control operation.

Parameters

activity	[in] Control activity.
option	[in] Undo option.

Remarks

activity will always be:

Value Description kEnd 4 The Control operation has completed successfully.

option must be one of the following:

Value Description kNone 0 Undo None kOne 1 Undo One
kAll 2 Undo All

See also

undoSubcommandAuto undoSubcommandBack undoSubcommandBegin undoSubcommandEnd undoSubcommandMark undoSubcommandNumber

undoSubcommandEnd()

virtual void OdEditorReactor::undoSubcommandEnd ( int  activity )

virtual

Notification function called during an Undo End or Undo Group operation.

Parameters

activity

[in] End activity.

Remarks

activity will always be:

Value Description kStart 0 The Undo End has started.

See also

undoSubcommandAuto undoSubcommandBack undoSubcommandBegin undoSubcommandControl undoSubcommandMark undoSubcommandNumber

undoSubcommandMark()

virtual void OdEditorReactor::undoSubcommandMark ( int  activity )

virtual

Notification function called during an Undo Mark operation.

Parameters

activity

[in] Mark activity.

Remarks

activity will always be:

Value Description kStart 0 The Undo Mark has started.

See also

undoSubcommandAuto undoSubcommandBack undoSubcommandBegin undoSubcommandControl undoSubcommandEnd undoSubcommandNumber

undoSubcommandNumber()

virtual void OdEditorReactor::undoSubcommandNumber ( int  activity, int  numSteps  )

virtual

Notification function called during an Undo <number>operation.

Parameters

activity	[in] Number activity.
numSteps	[in] Number of steps to be undone.

Remarks

activity will always be:

Value Description kStart 0 The Undo Back has started.

See also

undoSubcommandAuto undoSubcommandBack undoSubcommandBegin undoSubcommandControl undoSubcommandEnd undoSubcommandMark

xrefSubcommandAttachItem()

virtual void OdEditorReactor::xrefSubcommandAttachItem ( int  activity, const OdString &  xrefPath  )

virtual

Notification function called during an Xref Attach operation.

Parameters

activity	[in] Attach activity.
xrefPath	[in] Xref path.

Remarks

This function will called multiple times as an Xrefs are attached.

activity must be one of the following:

Value Description kStart 0 The Attach has started. xrefPath is undefined. kStartItem 2 The Attach of the Xref with the specified path has been started. Notification will be made for the original Xref and any dependent Xrefs. kEndItem 3 The Attach of the Xref with the specified path has been successfully completed. Notification will be made for the original Xref and any dependent Xrefs. kEnd 4 The Attach has completed successfully. xrefPath is undefined. kAborted 6 The Attach has failed to complete for the Xref with the specified filename.

Remarks

This function can be triggered by any action that results in the resolution of Xrefs. This includes plot, IGES and DXF input, block redefinition, and Xref Reload operations.

See also

xrefSubcommandBindItem xrefSubcommandDetachItem xrefSubcommandOverlayItem xrefSubcommandPathItem xrefSubcommandReloadItem xrefSubcommandUnloadItem

xrefSubcommandBindItem()

virtual void OdEditorReactor::xrefSubcommandBindItem ( int  activity, OdDbObjectId  blockId  )

virtual

Notification function called during an Xref Bind operation.

Parameters

activity	[in] Bind activity.
blockId	[in] Object ID of the Xref.

Remarks

This function will be called multiple times as an Xrefs are bound.

activity must be one of the following:

Value Description kStart 0 The Bind has started. blockId is undefined. kStartItem 2 The Bind of the Xref with the specified blockId has been started. Notification will be made for the original Xref and any dependent Xrefs. kEndItem 3 The Bind of the Xref with the specified blockId has been successfully completed. Notification will be made for the original Xref and any dependent Xrefs. kEnd 4 The Bind has completed successfully. blockId is undefined. kAborted 6 The Bind has failed to complete for the Xref with the specified blockId. kStartXBindBlock 7 Notification of an Xref-dependent block being bound. kStartXBindSymbol 8 Notification of all other Xref-dependent symbols.

See also

xrefSubcommandAttachItem xrefSubcommandDetachItem xrefSubcommandOverlayItem xrefSubcommandPathItem xrefSubcommandReloadItem xrefSubcommandUnloadItem

xrefSubcommandDetachItem()

virtual void OdEditorReactor::xrefSubcommandDetachItem ( int  activity, OdDbObjectId  blockId  )

virtual

Notification function called during an Xref Detach operation.

Parameters

activity	[in] Detach activity.
blockId	[in] Object ID of the Xref.

Remarks

This function will be called multiple times as an Xrefs are detached.

activity must be one of the following:

Value Description kStart 0 The Detach has started. blockId is undefined. kStartItem 2 The Detach of the Xref with the specified blockId has been started. Notification will be made for the original Xref and any dependent Xrefs. kEndItem 3 The Detach of the Xref with the specified blockId has been successfully completed. Notification will be made for the original Xref and any dependent Xrefs. kEnd 4 The Detach has completed successfully. blockId is undefined. kAborted 6 The Detach has failed to complete for the Xref with the specified blockId.

See also

xrefSubcommandAttachItem xrefSubcommandBindItem xrefSubcommandOverlayItem xrefSubcommandPathItem xrefSubcommandReloadItem xrefSubcommandUnloadItem

xrefSubcommandOverlayItem()

virtual void OdEditorReactor::xrefSubcommandOverlayItem ( int  activity, const OdString &  xrefPath  )

virtual

Notification function called during an Xref Overlay operation.

Parameters

activity	[in] Overlay activity.
xrefPath	[in] Xref path.

Remarks

This function will called multiple times as an Xrefs are overlayed.

activity must be one of the following:

Value Description kStart 0 The Overlay has started. xrefPath is undefined. kStartItem 2 The Overlay of the Xref with the specified path has been started. Notification will be made for the original Xref and any dependent Xrefs. kEndItem 3 The Overlay of the Xref with the specified path has been successfully completed. Notification will be made for the original Xref and any dependent Xrefs. kEnd 4 The Overlay has completed successfully. xrefPath is undefined. kAborted 6 The Overlay has failed to complete for the Xref with the specified filename.

Remarks

This function can be triggered by any action that results in the resolution of Xrefs. This includes plot, IGES and DXF input, block redefinition, and Xref Reload operations.

See also

xrefSubcommandAttachItem xrefSubcommandBindItem xrefSubcommandDetachItem xrefSubcommandPathItem xrefSubcommandReloadItem xrefSubcommandUnloadItem

xrefSubcommandPathItem()

virtual void OdEditorReactor::xrefSubcommandPathItem ( int  activity, OdDbObjectId  blockId, const OdString &  newPath  )

virtual

Notification function called during an Xref Path operation.

Parameters

activity	[in] Path activity.
newPath	[in] New Xref path.
blockId	[in] Object ID of the Xref.

Remarks

activity must be one of the following:

Value Description kStart 0 The Path operation has started. blockId and newPath are undefined. kStartItem 2 The Path operation the Xref with the specified blockId has been started. kEndItem 3 The Path of the Xref with the specified blockId has been successfully changed to newPath.
kEnd 4 The Path operation has completed successfully. blockId and newPath are undefined. kAborted 6 The Path has failed to complete for the Xref with the specified blockId.

See also

xrefSubcommandAttachItem xrefSubcommandBindItem xrefSubcommandDetachItem xrefSubcommandOverlayItem xrefSubcommandReloadItem xrefSubcommandUnloadItem

xrefSubcommandReloadItem()

virtual void OdEditorReactor::xrefSubcommandReloadItem ( int  activity, OdDbObjectId  blockId  )

virtual

Notification function called during an Xref Reload operation.

Parameters

activity	[in] Reload activity.
blockId	[in] Object ID of the Xref.

Remarks

This function will be called multiple times as an Xrefs are reloaded.

activity must be one of the following:

Value Description kStart 0 The Reload has started. blockId is undefined. kStartItem 2 The Reload of the Xref with the specified blockId has been started. Notification will be made for the original Xref and any dependent Xrefs. kEndItem 3 The Reload of the Xref with the specified blockId has been successfully completed. Notification will be made for the original Xref and any dependent Xrefs. kEnd 4 The Reload has completed successfully. blockId is undefined. kAborted 6 The Reload has failed to complete for the Xref with the specified blockId.

See also

xrefSubcommandAttachItem xrefSubcommandBindItem xrefSubcommandDetachItem xrefSubcommandOverlayItem xrefSubcommandPathItem xrefSubcommandUnloadItem

xrefSubCommandStart() [1/2]

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

virtual

xrefSubCommandStart() [2/2]

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

virtual

Reimplemented from OdRxEventReactor.

xrefSubcommandUnloadItem()

virtual void OdEditorReactor::xrefSubcommandUnloadItem ( int  activity, OdDbObjectId  blockId  )

virtual

Notification function called during an Xref Unload operation.

Parameters

activity	[in] Reload activity.
blockId	[in] Object ID of the Xref.

Remarks

This function will be called multiple times as an Xrefs are unloaded.

activity must be one of the following:

Value Description kStart 0 The Unload has started. blockId is undefined. kStartItem 2 The Unload of the Xref with the specified blockId has been started. Notification will be made for the original Xref and any dependent Xrefs. kEndItem 3 The Unload of the Xref with the specified blockId has been successfully completed. Notification will be made for the original Xref and any dependent Xrefs. kEnd 4 The Unload has completed successfully. blockId is undefined. kAborted 6 The Unload has failed to complete for the Xref with the specified blockId.

---

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

• Editor.h