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

The CmdLibraryEdit class. More...

#include <cmdlibraryedit.h>

+ Inheritance diagram for CmdLibraryEdit:
+ Collaboration diagram for CmdLibraryEdit:

Public Member Functions

 CmdLibraryEdit ()=delete
 
 CmdLibraryEdit (const CmdLibraryEdit &other)=delete
 
 CmdLibraryEdit (Library &library) noexcept
 
virtual ~CmdLibraryEdit () noexcept
 
void setUrl (const QUrl &url) noexcept
 
void setDependencies (const QSet< Uuid > &deps) noexcept
 
void setIcon (const QByteArray &png) noexcept
 
void setManufacturer (const SimpleString &value) noexcept
 
CmdLibraryEdit & operator= (const CmdLibraryEdit &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

Library & mLibrary
 
QUrl mOldUrl
 
QUrl mNewUrl
 
QSet< Uuid > mOldDependencies
 
QSet< Uuid > mNewDependencies
 
QByteArray mOldIcon
 
QByteArray mNewIcon
 
SimpleString mOldManufacturer
 
SimpleString mNewManufacturer
 

Detailed Description

The CmdLibraryEdit class.

Constructor & Destructor Documentation

◆ CmdLibraryEdit() [1/3]

CmdLibraryEdit ( )
delete

◆ CmdLibraryEdit() [2/3]

CmdLibraryEdit ( const CmdLibraryEdit &  other)
delete

◆ CmdLibraryEdit() [3/3]

CmdLibraryEdit ( Library &  library)
explicitnoexcept

◆ ~CmdLibraryEdit()

~CmdLibraryEdit ( )
virtualnoexcept

Member Function Documentation

◆ setUrl()

void setUrl ( const QUrl &  url)
noexcept

◆ setDependencies()

void setDependencies ( const QSet< Uuid > &  deps)
noexcept

◆ setIcon()

void setIcon ( const QByteArray &  png)
noexcept

◆ setManufacturer()

void setManufacturer ( const SimpleString &  value)
noexcept

◆ operator=()

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

+ 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 CmdLibraryBaseElementEdit.

+ 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 CmdLibraryBaseElementEdit.

+ Here is the call graph for this function:

Member Data Documentation

◆ mLibrary

Library& mLibrary
private

◆ mOldUrl

QUrl mOldUrl
private

◆ mNewUrl

QUrl mNewUrl
private

◆ mOldDependencies

QSet<Uuid> mOldDependencies
private

◆ mNewDependencies

QSet<Uuid> mNewDependencies
private

◆ mOldIcon

QByteArray mOldIcon
private

◆ mNewIcon

QByteArray mNewIcon
private

◆ mOldManufacturer

SimpleString mOldManufacturer
private

◆ mNewManufacturer

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