UndoLock Class Reference

Blocks and unblocks undo actions from being added to a view. More...

#include <Undo.h>

List of all members.

Public Member Functions

 UndoLock (View *pView)
 ~UndoLock ()


Detailed Description

Blocks and unblocks undo actions from being added to a view.

This class provides a means to temporarily block undo actions from being added to a view. Actions are blocked on the given view when creating the UndoLock object and unblocked when the lock is destroyed. Reference counting is performed such that destroying the lock will not allow actions to be added to the view again if actions were blocked when the lock was created.

See also:
View::isUndoBlocked()

Definition at line 75 of file Undo.h.


Constructor & Destructor Documentation

UndoLock::UndoLock ( View pView  ) 

Prevents undo actions from being added to a view.

The constructor creates the UndoLock object and blocks undo actions from being added to the given view.

Parameters:
pView The view in which undo actions should be blocked.

UndoLock::~UndoLock (  ) 

Allows undo actions to be added to a view.

The destructor destroys the UndoLock object and allow undo actions to be added to the view only if undo actions were not blocked when this object was created.

See also:
View::isUndoBlocked()


Software Development Kit - Opticks 4.9.0 Build 16218