ufe  1.0
Universal Front End is a DCC-agnostic component that will allow a DCC to browse and edit data in multiple data models
Ufe::UndoableCommand Class Referenceabstract

Abstract base class for undoable commands. More...

#include <undoableCommand.h>

Inheritance diagram for Ufe::UndoableCommand:

Public Types

typedef std::shared_ptr< UndoableCommandPtr
 

Public Member Functions

virtual ~UndoableCommand ()
 Destructor. More...
 
virtual void execute ()
 
virtual void undo ()=0
 
virtual void redo ()=0
 

Protected Member Functions

 UndoableCommand ()
 Constructor. More...
 
 UndoableCommand (const UndoableCommand &)=delete
 Deleting copy constructor. More...
 

Detailed Description

Abstract base class for undoable commands.

This base class defines the trivial interface to implement the Command pattern

https://en.wikipedia.org/wiki/Command_pattern

for interactive multi-level undo.

Definition at line 30 of file undoableCommand.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<UndoableCommand> Ufe::UndoableCommand::Ptr

Definition at line 33 of file undoableCommand.h.

Constructor & Destructor Documentation

◆ ~UndoableCommand()

virtual Ufe::UndoableCommand::~UndoableCommand ( )
virtual

Destructor.

◆ UndoableCommand() [1/2]

Ufe::UndoableCommand::UndoableCommand ( )
protected

Constructor.

◆ UndoableCommand() [2/2]

Ufe::UndoableCommand::UndoableCommand ( const UndoableCommand )
protecteddelete

Deleting copy constructor.

Member Function Documentation

◆ execute()

virtual void Ufe::UndoableCommand::execute ( )
virtual

Initial execution of the command, which should be called exactly once. Implementation in this class calls redo().

Reimplemented in Ufe::CompositeUndoableCommand.

◆ redo()

virtual void Ufe::UndoableCommand::redo ( )
pure virtual

◆ undo()

virtual void Ufe::UndoableCommand::undo ( )
pure virtual

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