Ufe::SelectionReplaceWith Class Reference

Replace the argument selection. More...

#include <selectionUndoableCommands.h>

Inheritance diagram for Ufe::SelectionReplaceWith:

Collaboration diagram for Ufe::SelectionReplaceWith:

Public Member Functions
	SelectionReplaceWith (const GlobalSelection::Ptr &sn, const Selection &replacementSn)
	Constructor. More...
std::string	commandString () const override
	Get a user friendly string representation of the command. More...
void	undo () override
	Undo the replace. More...
void	redo () override
	Redo the replace. More...
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

Static Public Member Functions
static Ptr	createAndExecute (const GlobalSelection::Ptr &sn, const Selection &replacementSn)

Private Attributes
const GlobalSelection::Ptr	fSn
const std::list< Path >	fSnPaths
const std::list< Path >	fReplacementSnPaths

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

Replace the argument selection.

Replace the argument selection on execution, and restore it on undo.

Definition at line 135 of file selectionUndoableCommands.h.

Constructor & Destructor Documentation

SelectionReplaceWith()

Ufe::SelectionReplaceWith::SelectionReplaceWith	(	const GlobalSelection::Ptr &	sn,
		const Selection &	replacementSn
	)

Constructor.

Member Function Documentation

commandString()

std::string Ufe::SelectionReplaceWith::commandString ( ) const

inlineoverridevirtual

Get a user friendly string representation of the command.

Note

For example, an application can print out the executed command to give an hint to the user of what was sucessfully done.

Reimplemented from Ufe::UndoableCommand.

Definition at line 152 of file selectionUndoableCommands.h.

createAndExecute()

static Ptr Ufe::SelectionReplaceWith::createAndExecute ( const GlobalSelection::Ptr &  sn, const Selection &  replacementSn  )

static

Convenience method to create the undoable command and execute it.

Returns

Pointer to the undoable command.

redo()

void Ufe::SelectionReplaceWith::redo ( )

overridevirtual

Redo the replace.

Implements Ufe::UndoableCommand.

undo()

void Ufe::SelectionReplaceWith::undo ( )

overridevirtual

Undo the replace.

Implements Ufe::UndoableCommand.

Member Data Documentation

fReplacementSnPaths

const std::list<Path> Ufe::SelectionReplaceWith::fReplacementSnPaths

private

Definition at line 166 of file selectionUndoableCommands.h.

fSn

const GlobalSelection::Ptr Ufe::SelectionReplaceWith::fSn

private

Definition at line 161 of file selectionUndoableCommands.h.

fSnPaths

const std::list<Path> Ufe::SelectionReplaceWith::fSnPaths

private

Definition at line 165 of file selectionUndoableCommands.h.

---

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

• common/include/ufe/selectionUndoableCommands.h