Command that handles a selection. More...

#include <undoableCommand.h>

Inheritance diagram for Ufe::SelectionUndoableCommand:

Collaboration diagram for Ufe::SelectionUndoableCommand:

Public Types
typedef std::shared_ptr< SelectionUndoableCommand >	Ptr

Public Types inherited from Ufe::UndoableCommand
typedef std::shared_ptr< UndoableCommand >	Ptr

Public Member Functions
	SelectionUndoableCommand ()=default

	~SelectionUndoableCommand () override
	Destructor. More...

virtual SceneItem::Ptr	targetItem (const Path &sourcePath) const =0

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

Additional Inherited Members
Protected Member Functions inherited from Ufe::UndoableCommand
	UndoableCommand ()
	Constructor. More...

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

Detailed Description

Command that handles a selection.

This class provides the interface to retrieve a scene item that corresponds to one of the source items from the initial selection once the command has been executed.

This class is flexible enough to support the newly created items of a batched duplicate operation, or the existing items of a bached rename.

Definition at line 201 of file undoableCommand.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 204 of file undoableCommand.h.

Constructor & Destructor Documentation

◆ SelectionUndoableCommand()

Ufe::SelectionUndoableCommand::SelectionUndoableCommand ( )

default

Default constructor. We are not mandating how the selection is passed to this command or how it is stored.

◆ ~SelectionUndoableCommand()

Ufe::SelectionUndoableCommand::~SelectionUndoableCommand ( )

override

Destructor.

Member Function Documentation

◆ targetItem()

virtual SceneItem::Ptr Ufe::SelectionUndoableCommand::targetItem ( const Path & sourcePath ) const

pure virtual

Pure virtual method to retrieve the target item that corresponds to one of the source items. Returning nullptr is a perfectly valid answer if that command did not actually process that source item. This can happen if the source selection contains items from multiple runtimes.

Parameters

sourcePath Item path found in the original selection for which we want to get a corresponding target item.

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

common/include/ufe/undoableCommand.h

Public Types

Public Member Functions

Additional Inherited Members