oaTechUndoObserverBase Class Reference
Inheritance diagram for oaTechUndoObserverBase:
Detailed Description
The oaTechUndoObserver 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
| oaTechUndoObserverBase::oaTechUndoObserverBase |
( |
|
) |
|
|
| oaTechUndoObserverBase::~oaTechUndoObserverBase |
( |
|
) |
[virtual] |
|
|
|
This function destroys this oaTechUndoObserver object, deactivating and deleting the callback and freeing all resources associated with the callback. |
Member Function Documentation
| void oaTechUndoObserverBase::enable |
( |
oaBoolean |
enabledIn |
) |
|
|
|
|
This function activates or deactivates this observer.
- Parameters:
-
| enabledIn | Indicates whether to make this observer active or inactive |
|
| oaBoolean oaTechUndoObserverBase::isEnabled |
( |
|
) |
|
|
|
|
This function returns a boolean value indicating whether this observer is active. |
| void oaTechUndoObserverBase::onEndRedo |
( |
oaTech * |
Tech |
) |
[virtual] |
|
|
|
This function is called just after the undo mechanism finishes redoing changes to the specified tech. The application's derived class must implement this function in order to receive notification when a redo event has occurred. |
| void oaTechUndoObserverBase::onEndUndo |
( |
oaTech * |
Tech |
) |
[virtual] |
|
|
|
This function is called just after the undo mechanism finishes undoing changes to the specified tech. The application's derived class must implement this function in order to receive notification when an undo event occurs. |
| void oaTechUndoObserverBase::onSetCp |
( |
oaTech * |
Tech, |
|
|
oaUInt4 |
cpID |
|
) |
[virtual] |
|
|
|
This function is called when the an undo checkpoint is set on the specified tech. The application's derived class must implement this function to receive notification when a checkpoint for the tech is set.
- Parameters:
-
| Tech | The technology database on which the checkpoint was set |
| cpID | The ID of the checkpoint that was set |
|
| void oaTechUndoObserverBase::onStartRedo |
( |
oaTech * |
Tech |
) |
[virtual] |
|
|
|
This function is called just before the undo mechanism restores changes to the specified tech. The application's derived class must implement this function in order to receive notification when a redo event is about to occur. |
| void oaTechUndoObserverBase::onStartUndo |
( |
oaTech * |
Tech |
) |
[virtual] |
|
|
|
This function is called just before the undo mechanism reverses changes to the specified tech. The application's derived class must implement this function in order to receive notification when an undo event is about to occur. |
| void oaTechUndoObserverBase::onUnsetCp |
( |
oaTech * |
Tech |
) |
[virtual] |
|
|
|
This function is called when a checkpoint is unset on the specified tech. The application's derived class must implement this function in order to receive notification when a checkpoint for the tech is unset.
- Parameters:
-
| Tech | The technology database on which the observer is set |
|
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.
