Ufe::SelectionClear Class Reference

Clear the argument selection. More...

#include <selectionUndoableCommands.h>

Inheritance diagram for Ufe::SelectionClear:

Collaboration diagram for Ufe::SelectionClear:

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

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

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

Clear the argument selection.

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

Definition at line 104 of file selectionUndoableCommands.h.

Constructor & Destructor Documentation

SelectionClear()

Ufe::SelectionClear::SelectionClear

(

const GlobalSelection::Ptr &

sn

)

Constructor.

Member Function Documentation

commandString()

std::string Ufe::SelectionClear::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 115 of file selectionUndoableCommands.h.

createAndExecute()

static Ptr Ufe::SelectionClear::createAndExecute ( const GlobalSelection::Ptr &  sn )

static

Convenience method to create the undoable command and execute it.

Returns

Pointer to the undoable command.

redo()

void Ufe::SelectionClear::redo ( )

overridevirtual

Redo the clear.

Implements Ufe::UndoableCommand.

undo()

void Ufe::SelectionClear::undo ( )

overridevirtual

Undo the clear.

Implements Ufe::UndoableCommand.

Member Data Documentation

fPaths

const std::list<Path> Ufe::SelectionClear::fPaths

private

Definition at line 128 of file selectionUndoableCommands.h.

fSn

const GlobalSelection::Ptr Ufe::SelectionClear::fSn

private

Definition at line 124 of file selectionUndoableCommands.h.

---

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

• common/include/ufe/selectionUndoableCommands.h