LibrePCB Developers Documentation
CmdComponentSymbolVariantEdit Class Referencefinal

The CmdComponentSymbolVariantEdit class. More...

#include <cmdcomponentsymbolvariantedit.h>

+ Inheritance diagram for CmdComponentSymbolVariantEdit:
+ Collaboration diagram for CmdComponentSymbolVariantEdit:

Public Member Functions

 CmdComponentSymbolVariantEdit ()=delete
 
 CmdComponentSymbolVariantEdit (const CmdComponentSymbolVariantEdit &other)=delete
 
 CmdComponentSymbolVariantEdit (ComponentSymbolVariant &variant) noexcept
 
 ~CmdComponentSymbolVariantEdit () noexcept
 
void setNorm (const QString &norm) noexcept
 
void setNames (const LocalizedNameMap &names) noexcept
 
void setDescriptions (const LocalizedDescriptionMap &descriptions) noexcept
 
void setSymbolItems (const ComponentSymbolVariantItemList &items) noexcept
 
CmdComponentSymbolVariantEditoperator= (const CmdComponentSymbolVariantEdit &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

ComponentSymbolVariantmVariant
 
QString mOldNorm
 
QString mNewNorm
 
LocalizedNameMap mOldNames
 
LocalizedNameMap mNewNames
 
LocalizedDescriptionMap mOldDescriptions
 
LocalizedDescriptionMap mNewDescriptions
 
ComponentSymbolVariantItemList mOldSymbolItems
 
ComponentSymbolVariantItemList mNewSymbolItems
 

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

Constructor & Destructor Documentation

◆ CmdComponentSymbolVariantEdit() [1/3]

◆ CmdComponentSymbolVariantEdit() [2/3]

◆ CmdComponentSymbolVariantEdit() [3/3]

CmdComponentSymbolVariantEdit ( ComponentSymbolVariant variant)
explicitnoexcept

◆ ~CmdComponentSymbolVariantEdit()

Member Function Documentation

◆ setNorm()

void setNorm ( const QString &  norm)
noexcept

◆ setNames()

void setNames ( const LocalizedNameMap names)
noexcept

◆ setDescriptions()

void setDescriptions ( const LocalizedDescriptionMap descriptions)
noexcept

◆ setSymbolItems()

void setSymbolItems ( const ComponentSymbolVariantItemList items)
noexcept

◆ operator=()

CmdComponentSymbolVariantEdit & operator= ( const CmdComponentSymbolVariantEdit 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

◆ mVariant

ComponentSymbolVariant& mVariant
private

◆ mOldNorm

QString mOldNorm
private

◆ mNewNorm

QString mNewNorm
private

◆ mOldNames

LocalizedNameMap mOldNames
private

◆ mNewNames

LocalizedNameMap mNewNames
private

◆ mOldDescriptions

LocalizedDescriptionMap mOldDescriptions
private

◆ mNewDescriptions

LocalizedDescriptionMap mNewDescriptions
private

◆ mOldSymbolItems

ComponentSymbolVariantItemList mOldSymbolItems
private

◆ mNewSymbolItems

ComponentSymbolVariantItemList mNewSymbolItems
private

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