LibrePCB Developers Documentation
CmdDeviceEdit Class Referencefinal

The CmdDeviceEdit class. More...

#include <cmddeviceedit.h>

+ Inheritance diagram for CmdDeviceEdit:
+ Collaboration diagram for CmdDeviceEdit:

Public Member Functions

 CmdDeviceEdit ()=delete
 
 CmdDeviceEdit (const CmdDeviceEdit &other)=delete
 
 CmdDeviceEdit (Device &device) noexcept
 
 ~CmdDeviceEdit () noexcept
 
void setComponentUuid (const Uuid &uuid) noexcept
 
void setPackageUuid (const Uuid &uuid) noexcept
 
CmdDeviceEditoperator= (const CmdDeviceEdit &rhs)=delete
 
- 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

DevicemDevice
 
Uuid mOldComponentUuid
 
Uuid mNewComponentUuid
 
Uuid mOldPackageUuid
 
Uuid mNewPackageUuid
 

Additional Inherited Members

Detailed Description

The CmdDeviceEdit class.

Constructor & Destructor Documentation

◆ CmdDeviceEdit() [1/3]

CmdDeviceEdit ( )
delete

◆ CmdDeviceEdit() [2/3]

CmdDeviceEdit ( const CmdDeviceEdit other)
delete

◆ CmdDeviceEdit() [3/3]

CmdDeviceEdit ( Device device)
explicitnoexcept

◆ ~CmdDeviceEdit()

~CmdDeviceEdit ( )
noexcept

Member Function Documentation

◆ setComponentUuid()

void setComponentUuid ( const Uuid uuid)
noexcept
+ Here is the call graph for this function:

◆ setPackageUuid()

void setPackageUuid ( const Uuid uuid)
noexcept
+ Here is the call graph for this function:

◆ operator=()

CmdDeviceEdit& operator= ( const CmdDeviceEdit rhs)
delete

◆ 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 librepcb::editor::UndoCommand::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

◆ mDevice

Device& mDevice
private

◆ mOldComponentUuid

Uuid mOldComponentUuid
private

◆ mNewComponentUuid

Uuid mNewComponentUuid
private

◆ mOldPackageUuid

Uuid mOldPackageUuid
private

◆ mNewPackageUuid

Uuid mNewPackageUuid
private

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