ufe 5.5
Universal Front End is a DCC-agnostic component that will allow a DCC to browse and edit data in multiple data models
Public Types | Public Member Functions | List of all members
Ufe::SetValueUndoableCommand< VALUE_TYPE > Class Template Referenceabstract

Abstract class for set value command. More...

#include <baseUndoableCommands.h>

Inheritance diagram for Ufe::SetValueUndoableCommand< VALUE_TYPE >:
Inheritance graph
[legend]
Collaboration diagram for Ufe::SetValueUndoableCommand< VALUE_TYPE >:
Collaboration graph
[legend]

Public Types

typedef std::shared_ptr< SetValueUndoableCommand > Ptr
 
typedef VALUE_TYPE ValueType
 
- Public Types inherited from Ufe::UndoableCommand
typedef std::shared_ptr< UndoableCommand > Ptr
 

Public Member Functions

 SetValueUndoableCommand (const Path &path)
 Constructor. More...
 
 ~SetValueUndoableCommand () override
 Destructor. More...
 
virtual bool set (VALUE_TYPE v)=0
 
- Public Member Functions inherited from Ufe::BaseUndoableCommand
 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
 

Additional Inherited Members

- Protected Member Functions inherited from Ufe::UndoableCommand
 UndoableCommand ()
 Constructor. More...
 
 UndoableCommand (const UndoableCommand &)=delete
 Deleting copy constructor. More...
 

Detailed Description

template<typename VALUE_TYPE>
class Ufe::SetValueUndoableCommand< VALUE_TYPE >

Abstract class for set value command.

Definition at line 51 of file baseUndoableCommands.h.

Member Typedef Documentation

◆ Ptr

template<typename VALUE_TYPE >
typedef std::shared_ptr<SetValueUndoableCommand> Ufe::SetValueUndoableCommand< VALUE_TYPE >::Ptr

Definition at line 54 of file baseUndoableCommands.h.

◆ ValueType

template<typename VALUE_TYPE >
typedef VALUE_TYPE Ufe::SetValueUndoableCommand< VALUE_TYPE >::ValueType

Definition at line 55 of file baseUndoableCommands.h.

Constructor & Destructor Documentation

◆ SetValueUndoableCommand()

template<typename VALUE_TYPE >
Ufe::SetValueUndoableCommand< VALUE_TYPE >::SetValueUndoableCommand ( const Path &  path)
inline

Constructor.

Definition at line 58 of file baseUndoableCommands.h.

◆ ~SetValueUndoableCommand()

template<typename VALUE_TYPE >
Ufe::SetValueUndoableCommand< VALUE_TYPE >::~SetValueUndoableCommand ( )
inlineoverride

Destructor.

Definition at line 60 of file baseUndoableCommands.h.

Member Function Documentation

◆ set()

template<typename VALUE_TYPE >
virtual bool Ufe::SetValueUndoableCommand< VALUE_TYPE >::set ( VALUE_TYPE  v)
pure virtual 
        Set the VALUE_TYPE value to the argument VALUE_TYPE.

!

Parameters
vnew VALUE_TYPE value.
The documentation for this class was generated from the following file: