DesignCommand Class Reference

A command for safely modifying something in a DesignObjectLookup. Modifications will be done in a seperate thread from the UI and will be recorded for undo-redo. Most user modifications of data should occur via a DesignCommand. More...

#include <DesignCommand.h>

Inheritance diagram for DesignCommand:

Collaboration diagram for DesignCommand:

Public Member Functions
virtual bool	canCombineWith (const DynamicPointer< DesignCommand > &command)
virtual bool	canGroupWith (const DynamicPointer< DesignCommand > &)
virtual void	combineWith (const DynamicPointer< DesignCommand > &command)
	DesignCommand ()
virtual void	execute (DesignObjectLookup *)
virtual String	icon () const =0
virtual bool	isAsyncExecution () const
virtual TranslatedString	name () const =0
void	setUndoRedoID (UUID undo_redo_group)
UUID	undoRedoID () const
virtual	~DesignCommand ()

Public Attributes
bool	can_undo = true
bool	has_executed = false
UUID	id
bool	is_undo = false
ProgressInfo *	log = nullptr
Buffer< UUID >	targets
Time	time = Constant<Time>::Invalid
bool	update_project_modified = true

Protected Attributes
UUID	m_undo_redo_group

Detailed Description

A command for safely modifying something in a DesignObjectLookup. Modifications will be done in a seperate thread from the UI and will be recorded for undo-redo. Most user modifications of data should occur via a DesignCommand.

---

Constructor & Destructor Documentation

DesignCommand()

DesignCommand

(

)

~DesignCommand()

virtual ~DesignCommand ( )

inlinevirtual

Member Function Documentation

canCombineWith()

virtual bool canCombineWith ( const DynamicPointer< DesignCommand > & command )

inlinevirtual

Reimplemented in ManagedDesignCommand.

canGroupWith()

virtual bool canGroupWith ( const DynamicPointer< DesignCommand > & )

inlinevirtual

Reimplemented in ManagedDesignCommand.

combineWith()

virtual void combineWith ( const DynamicPointer< DesignCommand > & command )

virtual

Reimplemented in ManagedDesignCommand.

execute()

virtual void execute ( DesignObjectLookup * )

inlinevirtual

Reimplemented in ManagedDesignCommand, NewModelCommand, and VisibleCommand.

icon()

virtual String icon ( ) const

pure virtual

Implemented in ManagedDesignCommand, NewModelCommand, and VisibleCommand.

isAsyncExecution()

virtual bool isAsyncExecution ( ) const

inlinevirtual

Reimplemented in ManagedDesignCommand.

name()

virtual TranslatedString name ( ) const

pure virtual

Implemented in ManagedDesignCommand, NewModelCommand, and VisibleCommand.

setUndoRedoID()

void setUndoRedoID

(

UUID

undo_redo_group

)

undoRedoID()

UUID undoRedoID

(

)

const

Member Data Documentation

can_undo

bool can_undo = true

has_executed

bool has_executed = false

id

UUID id

is_undo

bool is_undo = false

log

ProgressInfo* log = nullptr

m_undo_redo_group

UUID m_undo_redo_group

protected

targets

Buffer<UUID> targets

time

Time time = Constant<Time>::Invalid

update_project_modified

bool update_project_modified = true

---

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

• Design/Headers/DesignCommand.h