oaDesignUndoObserverBase Class Reference
Inheritance diagram for oaDesignUndoObserverBase:
Detailed Description
The oaDesignUndoObserver class implements an observer for actions associated with undo and redo functions. Applications that need to receive notification of these actions should derive from this class and implement the appropriate observer functions.
See oaObserver for a general description of how callbacks are used.
Constructor & Destructor Documentation
| oaDesignUndoObserverBase::oaDesignUndoObserverBase |
( |
|
) |
|
|
| oaDesignUndoObserverBase::~oaDesignUndoObserverBase |
( |
|
) |
[virtual] |
|
|
|
This function destroys this oaDesignUndoObserver object, deactivating and deleting the callback and freeing all resources associated with the callback. |
Member Function Documentation
| void oaDesignUndoObserverBase::enable |
( |
oaBoolean |
enabledIn |
) |
|
|
|
|
This function activates or deactivates this observer.
- Parameters:
-
| enabledIn | Indicates whether to make this observer active or inactive |
|
| oaBoolean oaDesignUndoObserverBase::isEnabled |
( |
|
) |
|
|
|
|
This function returns a boolean value indicating whether this observer is active. |
| void oaDesignUndoObserverBase::onEndRedo |
( |
oaDesign * |
design |
) |
[virtual] |
|
|
|
This function is called just after the undo mechanism finishes redoing changes to the specified design. The application's derived class should implement this function to receive notification when a redo event has occurred. |
| void oaDesignUndoObserverBase::onEndUndo |
( |
oaDesign * |
design |
) |
[virtual] |
|
|
|
This function is called just after the undo mechanism finishes undoing changes to the specified design. The application's derived class should implement this function to receive notification when an undo event occurs. |
| void oaDesignUndoObserverBase::onSetCp |
( |
oaDesign * |
design, |
|
|
oaUInt4 |
cpID |
|
) |
[virtual] |
|
|
|
This function is called when a checkpoint is set on a design. The application's derived class should implement this function to receive notification when a design checkpoint is set. |
| void oaDesignUndoObserverBase::onStartRedo |
( |
oaDesign * |
design |
) |
[virtual] |
|
|
|
This function is called just before the undo mechanism redoes changes to the specified design. The application's derived class should implement this function to receive notification when a redo event is about to occur. |
| void oaDesignUndoObserverBase::onStartUndo |
( |
oaDesign * |
design |
) |
[virtual] |
|
|
|
This function is called just before the undo mechanism undoes changes to the specified design. The application's derived class should implement this function to receive notification when an undo event is about to occur. |
| void oaDesignUndoObserverBase::onUnsetCp |
( |
oaDesign * |
design |
) |
[virtual] |
|
|
|
This function is called when a checkpoint is unset on a design. The application's derived class should implement this function to receive notification when a design checkpoint is unset. |
The documentation for this class was generated from the following files:
Return to top of page
Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.
