Uranium
Application Framework
UM.Operations.GroupedOperation.GroupedOperation Class Reference
Inheritance diagram for UM.Operations.GroupedOperation.GroupedOperation:
UM.Operations.Operation.Operation

Public Member Functions

def __init__ (self)
 
def getNumChildrenOperations (self)
 
def addOperation
 
def undo (self)
 
def redo (self)
 
def mergeWith (self, other)
 
def __repr__ (self)
 
- Public Member Functions inherited from UM.Operations.Operation.Operation
def __init__ (self)
 
def undo (self)
 
def redo (self)
 
def mergeWith (self, other)
 
def push (self)
 

Detailed Description

An operation that groups several other operations together.

The intent of this operation is to hide an underlying chain of operations
from the user if they correspond to only one interaction with the user, such
as an operation applied to multiple scene nodes or a re-arrangement of
multiple items in the scene.

Constructor & Destructor Documentation

◆ __init__()

def UM.Operations.GroupedOperation.GroupedOperation.__init__ (   self,
  None 
)
Creates a new grouped operation.

The grouped operation is empty after its initialisation.

Member Function Documentation

◆ mergeWith()

def UM.Operations.GroupedOperation.GroupedOperation.mergeWith (   self,
  other 
)
Merges this operation with another GroupOperation.

This prevents the user from having to undo multiple operations if they
were not his operations.

The older operation must have the same number of child operations, and
each pair of operations must succesfully merge, or the merge of the
groupOperation will fail.

:param other: The older GroupOperation to merge this with.
:return: A combination of the two group operations, or False if the operations
can not be merged.

◆ redo()

def UM.Operations.GroupedOperation.GroupedOperation.redo (   self,
  None 
)
Redoes all operations in this group.

◆ undo()

def UM.Operations.GroupedOperation.GroupedOperation.undo (   self,
  None 
)
Undo all operations in this group.

The operations are undone in reverse order as the order in which they
were added.

The documentation for this class was generated from the following file: