FBUndoManager Class Reference

FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager FBUndoManager

Inheritance diagram for FBUndoManager:

[legend]

List of all members.

---

Detailed Description

Access to global undo and redo functionality.

Users have the possibility of undoing and redoing actions performed using the GUI, and interacting with the undo and redo stacks with custom actions.All undo/redo related functions should only be called inside UI event callback. Users should call TransactionBegin()/TransactionEnd() in pairs, Transaction stack must be closed before UI event callback return.This class cannot be used as a base class.

See sample: IndividualUndoCalls.py.

Public Member Functions
	FBUndoManager ()
	Constructor.
bool	ActiveOperation ()
	Determine if an undo operation is in action.
bool	Clear ()
	Clear the undo and redo stacks.
	Redo ()
	Redo last undone action.
bool	TransactionAddModelTRS (FBModel pModel)
	Add Transaction if transaction stack is open.
bool	TransactionAddObjectDestroy (FBObject pObject)
	Add Transaction if transaction stack is open.
bool	TransactionAddProperty (FBProperty pProperty)
	Add Transaction if transaction stack is open.
bool	TransactionBegin (str pTransactionName)
	Open transaction stack for adding transactions.
bool	TransactionEnd ()
	Close transaction stack.
bool	TransactionIsOpen ()
	Query if transaction stack is already open.
	Undo (bool pNoRedo=False)
	Undo last action.

---

Constructor & Destructor Documentation

FBUndoManager

(

)

Constructor.

---

Member Function Documentation

bool ActiveOperation

(

)

Determine if an undo operation is in action.

Returns:

true the Undo Manager is performing an Undo or a Redo operation.

bool Clear

(

)

Clear the undo and redo stacks.

Returns:

A boolean value indicating success (true) or failure (false).

Redo

(

)

Redo last undone action.

bool TransactionAddModelTRS

(

FBModel

pModel

)

Add Transaction if transaction stack is open.

Quick Function to add Model TRS in Undo Stack

Parameters:

pModel

Model to backup TRS

Returns:

true if add transaction successfully.

bool TransactionAddObjectDestroy

(

FBObject

pObject

)

Add Transaction if transaction stack is open.

Function to add object to destroy in Undo Stack

Parameters:

pObject

Object to backup

Returns:

true if add transaction successfully.

bool TransactionAddProperty

(

FBProperty

pProperty

)

Add Transaction if transaction stack is open.

Quick Function to add property value in Undo Stack

Parameters:

pProperty

Property to backup

Returns:

true if add transaction successfully.

bool TransactionBegin

(

str

pTransactionName

)

Open transaction stack for adding transactions.

Users should call TransactionBegin()/TransactionEnd() in pairs, Transaction stack must be closed before UI event callback return.

Parameters:

pTransactionName

Name of Transaction.

Returns:

true if open transaction stack successfully.

bool TransactionEnd

(

)

Close transaction stack.

Users should call TransactionBegin()/TransactionEnd() in pairs, Transaction stack must be closed before UI event callback return.

Returns:

true if transaction close successfully.

bool TransactionIsOpen

(

)

Query if transaction stack is already open.

Returns:

true if transaction is already open.

Undo

(

bool

pNoRedo = False

)

Undo last action.

Parameters:

pNoRedo

If true, once the action is undone, it cannot be redone.

---