LibrePCB Developers Documentation
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
CmdLibraryElementEdit Class Reference

The CmdLibraryElementEdit class. More...

#include <cmdlibraryelementedit.h>

+ Inheritance diagram for CmdLibraryElementEdit:
+ Collaboration diagram for CmdLibraryElementEdit:

Public Member Functions

 CmdLibraryElementEdit ()=delete
 
 CmdLibraryElementEdit (const CmdLibraryElementEdit &other)=delete
 
 CmdLibraryElementEdit (LibraryElement &element, const QString &text) noexcept
 
virtual ~CmdLibraryElementEdit () noexcept
 
void setCategories (const QSet< Uuid > &uuids) noexcept
 
void setResources (const ResourceList &resources) noexcept
 
CmdLibraryElementEdit & operator= (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
 
CmdLibraryBaseElementEdit & operator= (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...
 
UndoCommand & operator= (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...
 
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...
 
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...
 

Private Attributes

LibraryElement & mElement
 
QSet< Uuid > mOldCategories
 
QSet< Uuid > mNewCategories
 
ResourceList mOldResources
 
ResourceList mNewResources
 

Detailed Description

The CmdLibraryElementEdit class.

Constructor & Destructor Documentation

◆ CmdLibraryElementEdit() [1/3]

CmdLibraryElementEdit ( )
delete

◆ CmdLibraryElementEdit() [2/3]

CmdLibraryElementEdit ( const CmdLibraryElementEdit &  other)
delete

◆ CmdLibraryElementEdit() [3/3]

CmdLibraryElementEdit ( LibraryElement &  element,
const QString &  text 
)
explicitnoexcept

◆ ~CmdLibraryElementEdit()

~CmdLibraryElementEdit ( )
virtualnoexcept

Member Function Documentation

◆ setCategories()

void setCategories ( const QSet< Uuid > &  uuids)
noexcept

◆ setResources()

void setResources ( const ResourceList &  resources)
noexcept

◆ operator=()

CmdLibraryElementEdit & operator= ( const CmdLibraryElementEdit &  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 CmdLibraryBaseElementEdit.

Reimplemented in CmdComponentEdit, and CmdPackageEdit.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ performUndo()

void performUndo ( )
overrideprotectedvirtual

Undo the command.

Note
This method must be implemented in all derived classes.

Reimplemented from CmdLibraryBaseElementEdit.

Reimplemented in CmdComponentEdit, and CmdPackageEdit.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ performRedo()

void performRedo ( )
overrideprotectedvirtual

Redo the command.

Note
This method must be implemented in all derived classes.

Reimplemented from CmdLibraryBaseElementEdit.

Reimplemented in CmdComponentEdit, and CmdPackageEdit.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ mElement

LibraryElement& mElement
private

◆ mOldCategories

QSet<Uuid> mOldCategories
private

◆ mNewCategories

QSet<Uuid> mNewCategories
private

◆ mOldResources

ResourceList mOldResources
private

◆ mNewResources

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