LibrePCB Developers Documentation
CmdPackageEdit Class Reference

The CmdPackageEdit class. More...

#include <cmdpackageedit.h>

+ Inheritance diagram for CmdPackageEdit:
+ Collaboration diagram for CmdPackageEdit:

Public Member Functions

 CmdPackageEdit ()=delete
 
 CmdPackageEdit (const CmdPackageEdit &other)=delete
 
 CmdPackageEdit (Package &package) noexcept
 
virtual ~CmdPackageEdit () noexcept
 
void setAssemblyType (Package::AssemblyType type) noexcept
 
CmdPackageEditoperator= (const CmdPackageEdit &rhs)=delete
 
- Public Member Functions inherited from CmdLibraryElementEdit
 CmdLibraryElementEdit ()=delete
 
 CmdLibraryElementEdit (const CmdLibraryElementEdit &other)=delete
 
 CmdLibraryElementEdit (LibraryElement &element, const QString &text) noexcept
 
virtual ~CmdLibraryElementEdit () noexcept
 
void setCategories (const QSet< Uuid > &uuids) noexcept
 
CmdLibraryElementEditoperator= (const CmdLibraryElementEdit &rhs)=delete
 
- Public Member Functions inherited from CmdLibraryBaseElementEdit
 CmdLibraryBaseElementEdit ()=delete
 
 CmdLibraryBaseElementEdit (const CmdLibraryBaseElementEdit &other)=delete
 
 CmdLibraryBaseElementEdit (LibraryBaseElement &element, const QString &text) noexcept
 
virtual ~CmdLibraryBaseElementEdit () noexcept
 
void setName (const QString &locale, const ElementName &name) noexcept
 
void setNames (const LocalizedNameMap &names) noexcept
 
void setDescription (const QString &locale, const QString &desc) noexcept
 
void setDescriptions (const LocalizedDescriptionMap &descriptions) noexcept
 
void setKeywords (const QString &locale, const QString &keywords) noexcept
 
void setKeywords (const LocalizedKeywordsMap &keywords) noexcept
 
void setVersion (const Version &version) noexcept
 
void setAuthor (const QString &author) noexcept
 
void setDeprecated (bool deprecated) noexcept
 
CmdLibraryBaseElementEditoperator= (const CmdLibraryBaseElementEdit &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
 

Protected Member Functions

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

Private Attributes

PackagemPackage
 
Package::AssemblyType mOldAssemblyType
 
Package::AssemblyType mNewAssemblyType
 

Detailed Description

The CmdPackageEdit class.

Constructor & Destructor Documentation

◆ CmdPackageEdit() [1/3]

CmdPackageEdit ( )
delete

◆ CmdPackageEdit() [2/3]

CmdPackageEdit ( const CmdPackageEdit other)
delete

◆ CmdPackageEdit() [3/3]

CmdPackageEdit ( Package package)
explicitnoexcept

◆ ~CmdPackageEdit()

~CmdPackageEdit ( )
virtualnoexcept

Member Function Documentation

◆ setAssemblyType()

void setAssemblyType ( Package::AssemblyType  type)
noexcept
+ Here is the call graph for this function:

◆ operator=()

CmdPackageEdit& operator= ( const CmdPackageEdit rhs)
delete

◆ performExecute()

bool performExecute ( )
overrideprotectedvirtual

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)

Reimplemented from CmdLibraryElementEdit.

+ Here is the call graph for this function:

◆ performUndo()

void performUndo ( )
overrideprotectedvirtual

Undo the command.

Note
This method must be implemented in all derived classes.

Reimplemented from CmdLibraryElementEdit.

+ Here is the call graph for this function:

◆ performRedo()

void performRedo ( )
overrideprotectedvirtual

Redo the command.

Note
This method must be implemented in all derived classes.

Reimplemented from CmdLibraryElementEdit.

+ Here is the call graph for this function:

Member Data Documentation

◆ mPackage

Package& mPackage
private

◆ mOldAssemblyType

Package::AssemblyType mOldAssemblyType
private

◆ mNewAssemblyType

Package::AssemblyType mNewAssemblyType
private

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