openshot-audio  0.1.2
Public Member Functions | Protected Member Functions | List of all members
UndoableAction Class Referenceabstract

#include <juce_UndoableAction.h>

Inheritance diagram for UndoableAction:
CodeDocumentDeleteAction CodeDocumentInsertAction TextEditor::InsertAction TextEditor::RemoveAction ValueTree::SharedObject::AddOrRemoveChildAction ValueTree::SharedObject::MoveChildAction ValueTree::SharedObject::SetPropertyAction

Public Member Functions

virtual ~UndoableAction ()
 
virtual bool perform ()=0
 
virtual bool undo ()=0
 
virtual int getSizeInUnits ()
 
virtual UndoableActioncreateCoalescedAction (UndoableAction *nextAction)
 

Protected Member Functions

 UndoableAction () noexcept
 

Detailed Description

Used by the UndoManager class to store an action which can be done and undone.

See also
UndoManager

Constructor & Destructor Documentation

UndoableAction::UndoableAction ( )
inlineprotectednoexcept

Creates an action.

virtual UndoableAction::~UndoableAction ( )
inlinevirtual

Destructor.

Member Function Documentation

virtual UndoableAction* UndoableAction::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 in ValueTree::SharedObject::MoveChildAction, and ValueTree::SharedObject::SetPropertyAction.

virtual int UndoableAction::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 in CodeDocumentDeleteAction, CodeDocumentInsertAction, TextEditor::RemoveAction, TextEditor::InsertAction, ValueTree::SharedObject::MoveChildAction, ValueTree::SharedObject::AddOrRemoveChildAction, and ValueTree::SharedObject::SetPropertyAction.

virtual bool UndoableAction::perform ( )
pure virtual

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

Implemented in CodeDocumentDeleteAction, CodeDocumentInsertAction, TextEditor::RemoveAction, TextEditor::InsertAction, ValueTree::SharedObject::MoveChildAction, ValueTree::SharedObject::AddOrRemoveChildAction, and ValueTree::SharedObject::SetPropertyAction.

virtual bool UndoableAction::undo ( )
pure virtual

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

Implemented in CodeDocumentDeleteAction, CodeDocumentInsertAction, TextEditor::RemoveAction, TextEditor::InsertAction, ValueTree::SharedObject::MoveChildAction, ValueTree::SharedObject::AddOrRemoveChildAction, and ValueTree::SharedObject::SetPropertyAction.


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