API reference - Class ManagerNotation used in Ruby API documentation Description: A transaction manager class
Manager objects control layout and potentially other objects in the layout database and allow to queue operations to form transactions. A transaction is a sequence of operations that can be undone or redone. In order to equip a layout object with undo/redo support, instantiate the layout object with a manager attached and embrace the operations to undo/redo with transaction/commit calls. The use of transactions is subject to certain constraints, i.e. transacted sequences may not be mixed with non-transacted ones. This class has been introduced in version 0.19. Public constructors
Public methods
Deprecated methods (protected, public, static, non-static and constructors)
Detailed descriptionvoid _createDescription: Ensures the C++ object is created Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created. void _destroyDescription: Explicitly destroys the object Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing. [const] bool _destroyed?Description: Returns a value indicating whether the object was already destroyed This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself. [const] bool _is_const_object?Description: Returns a value indicating whether the reference is a const reference This method returns true, if self is a const reference. In that case, only const methods may be called on self. void _manageDescription: Marks the object as managed by the script side. After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required. Usually it's not required to call this method. It has been introduced in version 0.24. void _unmanageDescription: Marks the object as no longer owned by the script side. Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur. Usually it's not required to call this method. It has been introduced in version 0.24. void commitDescription: Close a transaction. void createDescription: Ensures the C++ object is created Use of this method is deprecated. Use _create instead void destroyDescription: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead [const] bool destroyed?Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead [const] bool has_redo?Description: Determine if a transaction is available for 'redo'
[const] bool has_undo?Description: Determine if a transaction is available for 'undo'
[const] bool is_const_object?Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead [static] new Manager ptr newDescription: Creates a new object of this class Python specific notes:This method is the default initializer of the object void redoDescription: Redo the next available transaction The next transaction is redone with this method. The 'has_redo' method can be used to determine wether there are transactions to undo. unsigned long transaction(string description)Description: Begin a transaction
This call will open a new transaction. A transaction consists of a set of operations issued with the 'queue' method. A transaction is closed with the 'commit' method. unsigned long transaction(string description,unsigned long join_with)Description: Begin a joined transaction
This call will open a new transaction and join if with the previous transaction. The ID of the previous transaction must be equal to the ID given with 'join_with'. This overload was introduced in version 0.22. [const] string transaction_for_redoDescription: Return the description of the next transaction for 'redo' [const] string transaction_for_undoDescription: Return the description of the next transaction for 'undo' void undoDescription: Undo the current transaction The current transaction is undone with this method. The 'has_undo' method can be used to determine wether there are transactions to undo. |