CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdDbLayoutManagerReactor Class Reference

#include <DbLayoutManager.h>

Inheritance diagram for OdDbLayoutManagerReactor:
OdRxObject CFxLayoutManagerReactor

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdDbLayoutManagerReactor)
 
virtual void layoutCreated (const OdString &layoutName, const OdDbObjectId &layoutId)
 
virtual void layoutToBeRemoved (const OdString &layoutName, const OdDbObjectId &layoutId)
 
virtual void layoutRemoved (const OdString &layoutName, const OdDbObjectId &layoutId)
 
virtual void abortLayoutRemoved (const OdString &layoutName, const OdDbObjectId &layoutId)
 
virtual void layoutToBeCopied (const OdString &layoutName, const OdDbObjectId &layoutId)
 
virtual void layoutCopied (const OdString &oldLayoutName, const OdDbObjectId &oldLayoutId, const OdString &newLayoutName, const OdDbObjectId &newLayoutId)
 
virtual void abortLayoutCopied (const OdString &layoutName, const OdDbObjectId &layoutId)
 
virtual void layoutToBeRenamed (const OdString &oldLayoutName, const OdString &newLayoutName, const OdDbObjectId &layoutId)
 
virtual void layoutRenamed (const OdString &oldLayoutName, const OdString &newLayoutName, const OdDbObjectId &layoutId)
 
virtual void abortLayoutRename (const OdString &oldLayoutName, const OdString &newLayoutName, const OdDbObjectId &layoutId)
 
virtual void layoutSwitched (const OdString &newLayoutName, const OdDbObjectId &newLayoutId)
 
virtual void plotStyleTableChanged (const OdString &newTableName, const OdDbObjectId &layoutId)
 
virtual void layoutToBeDeactivated (const OdString &layoutName, const OdDbObjectId &layoutId)
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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 OdRxClassdesc ()
 

Detailed Description

This class is the base class for custom classes that receive notification of OdDbLayout events.

Remarks
The default implementations of all methods in this class do nothing but return.
See also
TD_Db

<group OdDb_Classes>

Definition at line 50 of file DbLayoutManager.h.

Member Function Documentation

◆ abortLayoutCopied()

virtual void OdDbLayoutManagerReactor::abortLayoutCopied ( const OdString layoutName,
const OdDbObjectId layoutId 
)
virtual

Notification function called whenever the copying of a layout has been terminated.

Parameters
layoutName[in] Layout name.
layoutId[in] Object ID of the layout.
  \remarks
  This function is called after the operation.

◆ abortLayoutRemoved()

virtual void OdDbLayoutManagerReactor::abortLayoutRemoved ( const OdString layoutName,
const OdDbObjectId layoutId 
)
virtual

Notification function called whenever the removal of a layout has been terminated.

Parameters
layoutName[in] Layout name.
layoutId[in] Object ID of the layout.
  \remarks
  This function is called before the operation.

◆ abortLayoutRename()

virtual void OdDbLayoutManagerReactor::abortLayoutRename ( const OdString oldLayoutName,
const OdString newLayoutName,
const OdDbObjectId layoutId 
)
virtual

Notification function called whenever the renaming of a layout has been terminated.

Parameters
oldLayoutName[in] Old layout name.
newLayoutName[in] New layout name.
layoutId[in] Object ID of the layout.
  \remarks
  This function is called after the operation.

◆ layoutCopied()

virtual void OdDbLayoutManagerReactor::layoutCopied ( const OdString oldLayoutName,
const OdDbObjectId oldLayoutId,
const OdString newLayoutName,
const OdDbObjectId newLayoutId 
)
virtual

Notification function called whenever a layout has been copied.

Parameters
oldLayoutName[in] Old layout name.
oldLayoutId[in] Object ID of the old layout.
newLayoutName[in] New layout name.
newLayoutId[in] Object ID of the new layout.
  \remarks
  This function is after the operation.

◆ layoutCreated()

virtual void OdDbLayoutManagerReactor::layoutCreated ( const OdString layoutName,
const OdDbObjectId layoutId 
)
virtual

Notification function called whenever a layout has been added to an OdDbDatabase.

Parameters
layoutName[in] Layout name.
layoutId[in] Object ID of layout.
  \remarks
  This function is called after the operation.

◆ layoutRemoved()

virtual void OdDbLayoutManagerReactor::layoutRemoved ( const OdString layoutName,
const OdDbObjectId layoutId 
)
virtual

Notification function called whenever a layout has been removed from an OdDbDatabase.

Parameters
layoutName[in] Layout name.
layoutId[in] Object ID of the layout.
  \remarks
  This function is called before the operation.

◆ layoutRenamed()

virtual void OdDbLayoutManagerReactor::layoutRenamed ( const OdString oldLayoutName,
const OdString newLayoutName,
const OdDbObjectId layoutId 
)
virtual

Notification function called whenever a layout has been renamed.

Parameters
oldLayoutName[in] Old layout name.
newLayoutName[in] New layout name.
layoutId[in] Object ID of the layout.
  \remarks
  This function is called after the operation.

◆ layoutSwitched()

virtual void OdDbLayoutManagerReactor::layoutSwitched ( const OdString newLayoutName,
const OdDbObjectId newLayoutId 
)
virtual

Notification function called whenever the active layout has changed.

Parameters
newLayoutName[in] New layout name.
newLayoutId[in] Object ID of the new layout.
  \remarks
  This function is called after the operation.

◆ layoutToBeCopied()

virtual void OdDbLayoutManagerReactor::layoutToBeCopied ( const OdString layoutName,
const OdDbObjectId layoutId 
)
virtual

Notification function called whenever a layout is about to be copied.

Parameters
layoutName[in] Layout name.
layoutId[in] Object ID of the layout.
  \remarks
  This function is called before the operation.

◆ layoutToBeDeactivated()

virtual void OdDbLayoutManagerReactor::layoutToBeDeactivated ( const OdString layoutName,
const OdDbObjectId layoutId 
)
virtual

Notification function called before the active layout gets deactivated.

Parameters
layoutName[in] Layout name.
layoutId[in] Object ID of the layout.
  \remarks
  This function is called after the operation.

Reimplemented in CFxLayoutManagerReactor.

◆ layoutToBeRemoved()

virtual void OdDbLayoutManagerReactor::layoutToBeRemoved ( const OdString layoutName,
const OdDbObjectId layoutId 
)
virtual

Notification function called whenever a layout is about to be removed from an OdDbDatabase.

Parameters
layoutName[in] Layout name.
layoutId[in] Object ID of layout.
  \remarks
  This function is called before the operation.

◆ layoutToBeRenamed()

virtual void OdDbLayoutManagerReactor::layoutToBeRenamed ( const OdString oldLayoutName,
const OdString newLayoutName,
const OdDbObjectId layoutId 
)
virtual

Notification function called whenever a layout is about to be renamed.

Parameters
oldLayoutName[in] Old layout name.
newLayoutName[in] New layout name.
layoutId[in] Object ID of the layout.
  \remarks
  This function is called before the operation.

◆ ODRX_DECLARE_MEMBERS()

OdDbLayoutManagerReactor::ODRX_DECLARE_MEMBERS ( OdDbLayoutManagerReactor  )

◆ plotStyleTableChanged()

virtual void OdDbLayoutManagerReactor::plotStyleTableChanged ( const OdString newTableName,
const OdDbObjectId layoutId 
)
virtual

Notification function called whenever the plot style table associated with a layout has changed.

Parameters
newTableName[in] New PlotStyleTable name.
layoutId[in] Object ID of the layout.
  \remarks
  This function is called after the operation.

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