openshot-audio  0.1.5
Public Member Functions | List of all members
ValueTree::SharedObject::MoveChildAction Class Reference
Inheritance diagram for ValueTree::SharedObject::MoveChildAction:
UndoableAction

Public Member Functions

 MoveChildAction (SharedObject *parentObject, int fromIndex, int toIndex) noexcept
 
bool perform ()
 
bool undo ()
 
int getSizeInUnits ()
 
UndoableActioncreateCoalescedAction (UndoableAction *nextAction)
 
- Public Member Functions inherited from UndoableAction
virtual ~UndoableAction ()
 

Additional Inherited Members

- Protected Member Functions inherited from UndoableAction
 UndoableAction () noexcept
 

Constructor & Destructor Documentation

◆ MoveChildAction()

ValueTree::SharedObject::MoveChildAction::MoveChildAction ( SharedObject parentObject,
int  fromIndex,
int  toIndex 
)
inlinenoexcept

Member Function Documentation

◆ createCoalescedAction()

UndoableAction* ValueTree::SharedObject::MoveChildAction::createCoalescedAction ( UndoableAction nextAction)
inlinevirtual

Allows multiple actions to be coalesced into a single action object, to reduce storage space.

If possible, this method should create and return a single action that does the same job as this one followed by the supplied action.

If it's not possible to merge the two actions, the method should return zero.

Reimplemented from UndoableAction.

◆ getSizeInUnits()

int ValueTree::SharedObject::MoveChildAction::getSizeInUnits ( )
inlinevirtual

Returns a value to indicate how much memory this object takes up.

Because the UndoManager keeps a list of UndoableActions, this is used to work out how much space each one will take up, so that the UndoManager can work out how many to keep.

The default value returned here is 10 - units are arbitrary and don't have to be accurate.

See also
UndoManager::getNumberOfUnitsTakenUpByStoredCommands, UndoManager::setMaxNumberOfStoredUnits

Reimplemented from UndoableAction.

◆ perform()

bool ValueTree::SharedObject::MoveChildAction::perform ( )
inlinevirtual

Overridden by a subclass to perform the action.

This method is called by the UndoManager, and shouldn't be used directly by applications.

Be careful not to make any calls in a perform() method that could call recursively back into the UndoManager::perform() method

Returns
true if the action could be performed.
See also
UndoManager::perform

Implements UndoableAction.

◆ undo()

bool ValueTree::SharedObject::MoveChildAction::undo ( )
inlinevirtual

Overridden by a subclass to undo the action.

This method is called by the UndoManager, and shouldn't be used directly by applications.

Be careful not to make any calls in an undo() method that could call recursively back into the UndoManager::perform() method

Returns
true if the action could be undone without any errors.
See also
UndoManager::perform

Implements UndoableAction.


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