LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CmdFootprintEdit Class Referencefinal

The CmdFootprintEdit class. More...

#include <cmdfootprintedit.h>

+ Inheritance diagram for CmdFootprintEdit:
+ Collaboration diagram for CmdFootprintEdit:

Public Member Functions

 CmdFootprintEdit ()=delete
 
 CmdFootprintEdit (const CmdFootprintEdit &other)=delete
 
 CmdFootprintEdit (Footprint &fpt) noexcept
 
 ~CmdFootprintEdit () noexcept
 
void setName (const ElementName &name) noexcept
 
CmdFootprintEditoperator= (const CmdFootprintEdit &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

FootprintmFootprint
 
ElementName mOldName
 
ElementName mNewName
 

Additional Inherited Members

Detailed Description

The CmdFootprintEdit class.

Constructor & Destructor Documentation

CmdFootprintEdit ( )
delete
CmdFootprintEdit ( const CmdFootprintEdit other)
delete
CmdFootprintEdit ( Footprint fpt)
explicitnoexcept
~CmdFootprintEdit ( )
noexcept

Member Function Documentation

void setName ( const ElementName name)
noexcept
CmdFootprintEdit& operator= ( const CmdFootprintEdit rhs)
delete
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:

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:

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

Footprint& mFootprint
private
ElementName mOldName
private
ElementName mNewName
private

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