LibrePCB Developers Documentation
CmdProjectLibraryRemoveElement< ElementType > Class Template Referencefinal

The CmdProjectLibraryRemoveElement class. More...

#include <cmdprojectlibraryremoveelement.h>

+ Inheritance diagram for CmdProjectLibraryRemoveElement< ElementType >:
+ Collaboration diagram for CmdProjectLibraryRemoveElement< ElementType >:

Public Member Functions

 CmdProjectLibraryRemoveElement (ProjectLibrary &library, ElementType &element) noexcept
 
 ~CmdProjectLibraryRemoveElement () 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...
 
void addElement ()
 
void removeElement ()
 
void addElement ()
 
void addElement ()
 
void addElement ()
 
void addElement ()
 
void removeElement ()
 
void removeElement ()
 
void removeElement ()
 
void removeElement ()
 

Private Attributes

ProjectLibrarymLibrary
 
ElementType & mElement
 

Additional Inherited Members

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

Detailed Description

template<typename ElementType>
class librepcb::editor::CmdProjectLibraryRemoveElement< ElementType >

The CmdProjectLibraryRemoveElement class.

Constructor & Destructor Documentation

◆ CmdProjectLibraryRemoveElement()

CmdProjectLibraryRemoveElement ( ProjectLibrary library,
ElementType &  element 
)
noexcept

◆ ~CmdProjectLibraryRemoveElement()

Member Function Documentation

◆ 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.

◆ performUndo()

void performUndo
overrideprivatevirtual

Undo the command.

Note
This method must be implemented in all derived classes.

Implements UndoCommand.

◆ performRedo()

void performRedo
overrideprivatevirtual

Redo the command.

Note
This method must be implemented in all derived classes.

Implements UndoCommand.

◆ addElement() [1/5]

void addElement ( )
private

◆ removeElement() [1/5]

void removeElement ( )
private

◆ addElement() [2/5]

void addElement ( )
private

◆ addElement() [3/5]

void addElement ( )
private

◆ addElement() [4/5]

void addElement ( )
private

◆ addElement() [5/5]

void addElement ( )
private

◆ removeElement() [2/5]

void removeElement ( )
private

◆ removeElement() [3/5]

void removeElement ( )
private

◆ removeElement() [4/5]

void removeElement ( )
private

◆ removeElement() [5/5]

void removeElement ( )
private

Member Data Documentation

◆ mLibrary

ProjectLibrary& mLibrary
private

◆ mElement

ElementType& mElement
private

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