LibrePCB Developers Documentation
CmdListElementRemove< T, P, OnEditedArgs > Class Template Referencefinal

The CmdListElementRemove class. More...

#include <cmdlistelementremove.h>

+ Inheritance diagram for CmdListElementRemove< T, P, OnEditedArgs >:
+ Collaboration diagram for CmdListElementRemove< T, P, OnEditedArgs >:

Public Member Functions

 CmdListElementRemove ()=delete
 
 CmdListElementRemove (const CmdListElementRemove &other)=delete
 
 CmdListElementRemove (SerializableObjectList< T, P, OnEditedArgs... > &list, const T *element) noexcept
 
 ~CmdListElementRemove () noexcept
 
CmdListElementRemoveoperator= (const CmdListElementRemove &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

SerializableObjectList< T, P, OnEditedArgs... > & mList
 
const T * mElement
 
std::shared_ptr< T > mMemorizedElement
 
int mIndex
 

Additional Inherited Members

Detailed Description

template<typename T, typename P, typename... OnEditedArgs>
class librepcb::CmdListElementRemove< T, P, OnEditedArgs >

The CmdListElementRemove class.

Constructor & Destructor Documentation

◆ CmdListElementRemove() [1/3]

◆ CmdListElementRemove() [2/3]

CmdListElementRemove ( const CmdListElementRemove< T, P, OnEditedArgs > &  other)
delete

◆ CmdListElementRemove() [3/3]

CmdListElementRemove ( SerializableObjectList< T, P, OnEditedArgs... > &  list,
const T *  element 
)
inlinenoexcept

◆ ~CmdListElementRemove()

~CmdListElementRemove ( )
inlinenoexcept
+ Here is the call graph for this function:

Member Function Documentation

◆ operator=()

CmdListElementRemove& operator= ( const CmdListElementRemove< T, P, OnEditedArgs > &  rhs)
delete
+ Here is the caller graph for this function:

◆ performExecute()

bool performExecute ( )
inlineoverrideprivatevirtual

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 ( )
inlineoverrideprivatevirtual

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 ( )
inlineoverrideprivatevirtual

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

◆ mList

SerializableObjectList<T, P, OnEditedArgs...>& mList
private

◆ mElement

const T* mElement
private

◆ mMemorizedElement

std::shared_ptr<T> mMemorizedElement
private

◆ mIndex

int mIndex
private

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