Ufe::BaseUndoableCommand Class Reference

Base class for undoable set operation commands. More...

#include <baseUndoableCommands.h>

Inheritance diagram for Ufe::BaseUndoableCommand:

Collaboration diagram for Ufe::BaseUndoableCommand:

Public Member Functions
	BaseUndoableCommand (const Path &path)
	~BaseUndoableCommand () override
void	setPath (const Path &path)
	Set the path of the object onto which the command is applied. More...
const Path &	path () const
Ufe::SceneItem::Ptr	sceneItem () const
Public Member Functions inherited from Ufe::UndoableCommand
virtual	~UndoableCommand ()
	Destructor. More...
virtual std::string	commandString () const
	Get a user friendly string representation of the command. More...
virtual void	execute ()
virtual void	undo ()=0
virtual void	redo ()=0

Private Attributes
Path	fPath

Additional Inherited Members
Public Types inherited from Ufe::UndoableCommand
typedef std::shared_ptr< UndoableCommand >	Ptr
Protected Member Functions inherited from Ufe::UndoableCommand
	UndoableCommand ()
	Constructor. More...
	UndoableCommand (const UndoableCommand &)=delete
	Deleting copy constructor. More...

Detailed Description

Base class for undoable set operation commands.

Definition at line 30 of file baseUndoableCommands.h.

Constructor & Destructor Documentation

BaseUndoableCommand()

Ufe::BaseUndoableCommand::BaseUndoableCommand

(

const Path &

path

)

~BaseUndoableCommand()

Ufe::BaseUndoableCommand::~BaseUndoableCommand ( )

override

Member Function Documentation

path()

const Path & Ufe::BaseUndoableCommand::path ( ) const

inline

Returns

the path of the object onto which the command is applied.

Definition at line 40 of file baseUndoableCommands.h.

sceneItem()

Ufe::SceneItem::Ptr Ufe::BaseUndoableCommand::sceneItem ( ) const

inline

Returns

the object's SceneItem

Definition at line 43 of file baseUndoableCommands.h.

References Ufe::Hierarchy::createItem(), and Ufe::PathString::path().

Here is the call graph for this function:

setPath()

void Ufe::BaseUndoableCommand::setPath ( const Path &  path )

inline

Set the path of the object onto which the command is applied.

Definition at line 37 of file baseUndoableCommands.h.

References Ufe::PathString::path().

Here is the call graph for this function:

Member Data Documentation

fPath

Path Ufe::BaseUndoableCommand::fPath

private

Definition at line 46 of file baseUndoableCommands.h.

---

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

• common/include/ufe/baseUndoableCommands.h