LibrePCB Developers Documentation
CmdComponentInstanceEdit Class Referencefinal

The CmdComponentInstanceEdit class. More...

#include <cmdcomponentinstanceedit.h>

+ Inheritance diagram for CmdComponentInstanceEdit:
+ Collaboration diagram for CmdComponentInstanceEdit:

Public Member Functions

 CmdComponentInstanceEdit (Circuit &circuit, ComponentInstance &cmp) noexcept
 
 ~CmdComponentInstanceEdit () noexcept
 
void setName (const CircuitIdentifier &name) noexcept
 
void setValue (const QString &value) noexcept
 
void setAttributes (const AttributeList &attributes) noexcept
 
void setDefaultDeviceUuid (const tl::optional< Uuid > &device) noexcept
 
- Public Member Functions inherited from UndoCommand
 UndoCommand ()=delete
 
 UndoCommand (const UndoCommand &other)=delete
 
 UndoCommand (const QString &text) noexcept
 
virtual ~UndoCommand () noexcept
 
const QString & getText () const noexcept
 
bool wasEverExecuted () const noexcept
 This method shows whether that command was ever executed (execute() called successfully) More...
 
bool wasEverReverted () const noexcept
 This method shows whether that command was ever reverted (undo() called at least one time) More...
 
bool isCurrentlyExecuted () const noexcept
 This method shows whether that command is currently executed (redo() called one time more than undo()) More...
 
virtual bool execute () final
 Execute the command (must only be called once) More...
 
virtual void undo () final
 Undo the command. More...
 
virtual void redo () final
 Redo the command. More...
 
UndoCommandoperator= (const UndoCommand &rhs)=delete
 

Private Member Functions

bool performExecute () override
 Execute the command the first time. More...
 
void performUndo () override
 Undo the command. More...
 
void performRedo () override
 Redo the command. More...
 

Private Attributes

CircuitmCircuit
 
ComponentInstancemComponentInstance
 
CircuitIdentifier mOldName
 
CircuitIdentifier mNewName
 
QString mOldValue
 
QString mNewValue
 
AttributeList mOldAttributes
 
AttributeList mNewAttributes
 
tl::optional< UuidmOldDefaultDeviceUuid
 
tl::optional< UuidmNewDefaultDeviceUuid
 

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CmdComponentInstanceEdit()

CmdComponentInstanceEdit ( Circuit circuit,
ComponentInstance cmp 
)
noexcept

◆ ~CmdComponentInstanceEdit()

~CmdComponentInstanceEdit ( )
noexcept

Member Function Documentation

◆ setName()

void setName ( const CircuitIdentifier name)
noexcept
+ Here is the call graph for this function:

◆ setValue()

void setValue ( const QString &  value)
noexcept
+ Here is the call graph for this function:

◆ setAttributes()

void setAttributes ( const AttributeList attributes)
noexcept
+ Here is the call graph for this function:

◆ setDefaultDeviceUuid()

void setDefaultDeviceUuid ( const tl::optional< Uuid > &  device)
noexcept
+ Here is the call graph for this function:

◆ performExecute()

bool performExecute ( )
overrideprivatevirtual

Execute the command the first time.

Note
This method must be implemented in all derived classes. If the first time execution is exactly identical to an "redo" action, you can simple call performRedo() in the implementation of this method.
Return values
trueIf the command has done some changes
falseIf the command has done nothing (the command can be deleted)

Implements UndoCommand.

+ Here is the call graph for this function:

◆ performUndo()

void performUndo ( )
overrideprivatevirtual

Undo the command.

Note
This method must be implemented in all derived classes.

Implements UndoCommand.

+ Here is the call graph for this function:

◆ performRedo()

void performRedo ( )
overrideprivatevirtual

Redo the command.

Note
This method must be implemented in all derived classes.

Implements UndoCommand.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ mCircuit

Circuit& mCircuit
private

◆ mComponentInstance

ComponentInstance& mComponentInstance
private

◆ mOldName

CircuitIdentifier mOldName
private

◆ mNewName

CircuitIdentifier mNewName
private

◆ mOldValue

QString mOldValue
private

◆ mNewValue

QString mNewValue
private

◆ mOldAttributes

AttributeList mOldAttributes
private

◆ mNewAttributes

AttributeList mNewAttributes
private

◆ mOldDefaultDeviceUuid

tl::optional<Uuid> mOldDefaultDeviceUuid
private

◆ mNewDefaultDeviceUuid

tl::optional<Uuid> mNewDefaultDeviceUuid
private

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