Class for synchronization of transactions within multiple documents. Each transaction of this class involvess one transaction in each modified document. More...
#include <TDocStd_MultiTransactionManager.hxx>
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 opening 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 committed. | |
| 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_SequenceOfDocument & | Documents () 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. | |
 Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
Detailed Description
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 used 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 (committed).
Constructor & Destructor Documentation
◆ TDocStd_MultiTransactionManager()
| TDocStd_MultiTransactionManager::TDocStd_MultiTransactionManager | ( | ) |
Constructor.
Member Function Documentation
◆ AbortCommand()
| void TDocStd_MultiTransactionManager::AbortCommand | ( | ) |
Unsets the flag of started manager transaction and aborts transaction in each document.
◆ AddDocument()
| void TDocStd_MultiTransactionManager::AddDocument | ( | const Handle< TDocStd_Document > & | theDoc | ) |
Adds the document to the transaction manager and checks if it has been already added.
◆ ClearRedos()
| void TDocStd_MultiTransactionManager::ClearRedos | ( | ) |
Clears redos in the manager and in documents.
◆ ClearUndos()
| void TDocStd_MultiTransactionManager::ClearUndos | ( | ) |
Clears undos in the manager and in documents.
◆ CommitCommand() [1/2]
| Standard_Boolean TDocStd_MultiTransactionManager::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 committed.
◆ CommitCommand() [2/2]
| Standard_Boolean TDocStd_MultiTransactionManager::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.
◆ Documents()
| const TDocStd_SequenceOfDocument & TDocStd_MultiTransactionManager::Documents | ( | ) | const |
Returns the added documents to the transaction manager.
◆ DumpTransaction()
| void TDocStd_MultiTransactionManager::DumpTransaction | ( | Standard_OStream & | theOS | ) | const |
Dumps transactions in undos and redos.
◆ GetAvailableRedos()
| const TDocStd_SequenceOfApplicationDelta & TDocStd_MultiTransactionManager::GetAvailableRedos | ( | ) | const |
Returns available manager redos.
◆ GetAvailableUndos()
| const TDocStd_SequenceOfApplicationDelta & TDocStd_MultiTransactionManager::GetAvailableUndos | ( | ) | const |
Returns available manager undos.
◆ GetUndoLimit()
| Standard_Integer TDocStd_MultiTransactionManager::GetUndoLimit | ( | ) | const |
Returns undo limit for the manager.
◆ HasOpenCommand()
| Standard_Boolean TDocStd_MultiTransactionManager::HasOpenCommand | ( | ) | const |
Returns true if a transaction is opened.
◆ IsNestedTransactionMode()
| Standard_Boolean TDocStd_MultiTransactionManager::IsNestedTransactionMode | ( | ) | const |
Returns Standard_True if NestedTransaction mode is set. Methods for protection of changes outside transactions.
◆ ModificationMode()
| Standard_Boolean TDocStd_MultiTransactionManager::ModificationMode | ( | ) | const |
Returns True if changes are allowed only inside transactions.
◆ OpenCommand()
| void TDocStd_MultiTransactionManager::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 opening new ones.
◆ Redo()
| void TDocStd_MultiTransactionManager::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)).
◆ RemoveDocument()
| void TDocStd_MultiTransactionManager::RemoveDocument | ( | const Handle< TDocStd_Document > & | theDoc | ) |
Removes the document from the transaction manager.
◆ RemoveLastUndo()
| void TDocStd_MultiTransactionManager::RemoveLastUndo | ( | ) |
Removes undo information from the list of undos of the manager and all documents which have been modified during the transaction.
◆ SetModificationMode()
| void TDocStd_MultiTransactionManager::SetModificationMode | ( | const Standard_Boolean | theTransactionOnly | ) |
If theTransactionOnly is True, denies all changes outside transactions.
◆ SetNestedTransactionMode()
| void TDocStd_MultiTransactionManager::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.
◆ SetUndoLimit()
| void TDocStd_MultiTransactionManager::SetUndoLimit | ( | const Standard_Integer | theLimit | ) |
Sets undo limit for the manager and all documents.
◆ Undo()
| void TDocStd_MultiTransactionManager::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)).
The documentation for this class was generated from the following file:
