Open CASCADE Technology 6.6.0
Public Member Functions
TDocStd_MultiTransactionManager Class Reference

Class for synchronization of transactions within multiple documents.
Each transaction of this class involvess one transaction in each modified document.

The documents to be synchronized should be added explicitly to
the manager; then its interface is uesd to ensure that all transactions
(Open/Commit, Undo/Redo) are performed synchronously in all managed documents.

The current implementation does not support nested transactions
on multitransaction manager level. It only sets the flag enabling
or disabling nested transactions in all its documents, so that
a nested transaction can be opened for each particular document
with TDocStd_Document class interface.

NOTE: When you invoke CommitTransaction of multi transaction
manager, all nested transaction of its documents will be closed (commited).

#include <TDocStd_MultiTransactionManager.hxx>

Inheritance diagram for TDocStd_MultiTransactionManager:
Inheritance graph
[legend]

Public Member Functions

 TDocStd_MultiTransactionManager ()
 Constructor

void SetUndoLimit (const Standard_Integer theLimit)
 Sets undo limit for the manager and all documents.

Standard_Integer GetUndoLimit () const
 Returns undo limit for the manager.

void Undo ()
 Undoes the current transaction of the manager.
It calls the Undo () method of the document being
on top of the manager list of undos (list.First())
and moves the list item to the top of the list of manager
redos (list.Prepend(item)).

void Redo ()
 Redoes the current transaction of the application. It calls
the Redo () method of the document being on top of the
manager list of redos (list.First()) and moves the list
item to the top of the list of manager undos (list.Prepend(item)).

const
TDocStd_SequenceOfApplicationDelta
GetAvailableUndos () const
 Returns available manager undos.

const
TDocStd_SequenceOfApplicationDelta
GetAvailableRedos () const
 Returns available manager redos.

void OpenCommand ()
 Opens transaction in each document and sets the flag that
transaction is opened. If there are already opened transactions in the documents,
these transactions will be aborted before openning new ones.

void AbortCommand ()
 Unsets the flag of started manager transaction and aborts
transaction in each document.

Standard_Boolean CommitCommand ()
 Commits transaction in all documents and fills the transaction manager
with the documents that have been changed during the transaction.
Returns True if new data has been added to myUndos.
NOTE: All nested transactions in the documents will be commited.

Standard_Boolean CommitCommand (const TCollection_ExtendedString &theName)
 Makes the same steps as the previous function but defines the name for transaction.
Returns True if new data has been added to myUndos.

Standard_Boolean HasOpenCommand () const
 Returns true if a transaction is opened.

void RemoveLastUndo ()
 Removes undo information from the list of undos of the manager and
all documents which have been modified during the transaction.

void DumpTransaction (Standard_OStream &theOS) const
 Dumps transactions in undos and redos

void AddDocument (const Handle< TDocStd_Document > &theDoc)
 Adds the document to the transaction manager and
checks if it has been already added

void RemoveDocument (const Handle< TDocStd_Document > &theDoc)
 Removes the document from the transaction manager.

const TDocStd_SequenceOfDocumentDocuments () const
 Returns the added documents to the transaction manager.

void SetNestedTransactionMode (const Standard_Boolean isAllowed=Standard_True)
 Sets nested transaction mode if isAllowed == Standard_True
NOTE: field myIsNestedTransactionMode exists only for synchronization
between several documents and has no effect on transactions
of multitransaction manager.

Standard_Boolean IsNestedTransactionMode () const
 Returns Standard_True if NestedTransaction mode is set.
//! Methods for protection of changes outside transactions

void SetModificationMode (const Standard_Boolean theTransactionOnly)
 If theTransactionOnly is True, denies all changes outside transactions.

Standard_Boolean ModificationMode () const
 Returns True if changes are allowed only inside transactions.

void ClearUndos ()
 Clears undos in the manager and in documents.

void ClearRedos ()
 Clears redos in the manager and in documents.


Constructor & Destructor Documentation

TDocStd_MultiTransactionManager::TDocStd_MultiTransactionManager ( )

Member Function Documentation

void TDocStd_MultiTransactionManager::AbortCommand ( )
void TDocStd_MultiTransactionManager::AddDocument ( const Handle< TDocStd_Document > &  theDoc)
void TDocStd_MultiTransactionManager::ClearRedos ( )
void TDocStd_MultiTransactionManager::ClearUndos ( )
Standard_Boolean TDocStd_MultiTransactionManager::CommitCommand ( const TCollection_ExtendedString theName)
Standard_Boolean TDocStd_MultiTransactionManager::CommitCommand ( )
const TDocStd_SequenceOfDocument& TDocStd_MultiTransactionManager::Documents ( ) const
void TDocStd_MultiTransactionManager::DumpTransaction ( Standard_OStream theOS) const
const TDocStd_SequenceOfApplicationDelta& TDocStd_MultiTransactionManager::GetAvailableRedos ( ) const
const TDocStd_SequenceOfApplicationDelta& TDocStd_MultiTransactionManager::GetAvailableUndos ( ) const
Standard_Integer TDocStd_MultiTransactionManager::GetUndoLimit ( ) const
Standard_Boolean TDocStd_MultiTransactionManager::HasOpenCommand ( ) const
Standard_Boolean TDocStd_MultiTransactionManager::IsNestedTransactionMode ( ) const
Standard_Boolean TDocStd_MultiTransactionManager::ModificationMode ( ) const
void TDocStd_MultiTransactionManager::OpenCommand ( )
void TDocStd_MultiTransactionManager::Redo ( )
void TDocStd_MultiTransactionManager::RemoveDocument ( const Handle< TDocStd_Document > &  theDoc)
void TDocStd_MultiTransactionManager::RemoveLastUndo ( )
void TDocStd_MultiTransactionManager::SetModificationMode ( const Standard_Boolean  theTransactionOnly)
void TDocStd_MultiTransactionManager::SetNestedTransactionMode ( const Standard_Boolean  isAllowed = Standard_True)
void TDocStd_MultiTransactionManager::SetUndoLimit ( const Standard_Integer  theLimit)
void TDocStd_MultiTransactionManager::Undo ( )

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines