LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CmdLibraryBaseElementEdit Class Reference

The CmdLibraryBaseElementEdit class. More...

#include <cmdlibrarybaseelementedit.h>

+ Inheritance diagram for CmdLibraryBaseElementEdit:
+ Collaboration diagram for CmdLibraryBaseElementEdit:

Public Member Functions

 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

LibraryBaseElementmElement
 
LocalizedNameMap mOldNames
 
LocalizedNameMap mNewNames
 
LocalizedDescriptionMap mOldDescriptions
 
LocalizedDescriptionMap mNewDescriptions
 
LocalizedKeywordsMap mOldKeywords
 
LocalizedKeywordsMap mNewKeywords
 
Version mOldVersion
 
Version mNewVersion
 
QString mOldAuthor
 
QString mNewAuthor
 
bool mOldDeprecated
 
bool mNewDeprecated
 

Detailed Description

Constructor & Destructor Documentation

CmdLibraryBaseElementEdit ( LibraryBaseElement element,
const QString &  text 
)
explicitnoexcept
~CmdLibraryBaseElementEdit ( )
virtualnoexcept

Member Function Documentation

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

Reimplemented in CmdComponentEdit, CmdLibraryEdit, CmdLibraryElementEdit, and CmdLibraryCategoryEdit.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void performUndo ( )
overrideprotectedvirtual

Undo the command.

Note
This method must be implemented in all derived classes.

Implements UndoCommand.

Reimplemented in CmdComponentEdit, CmdLibraryEdit, CmdLibraryElementEdit, and CmdLibraryCategoryEdit.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void performRedo ( )
overrideprotectedvirtual

Redo the command.

Note
This method must be implemented in all derived classes.

Implements UndoCommand.

Reimplemented in CmdComponentEdit, CmdLibraryEdit, CmdLibraryElementEdit, and CmdLibraryCategoryEdit.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

LibraryBaseElement& mElement
private
LocalizedNameMap mOldNames
private
LocalizedNameMap mNewNames
private
LocalizedDescriptionMap mOldDescriptions
private
LocalizedDescriptionMap mNewDescriptions
private
LocalizedKeywordsMap mOldKeywords
private
LocalizedKeywordsMap mNewKeywords
private
Version mOldVersion
private
Version mNewVersion
private
QString mOldAuthor
private
QString mNewAuthor
private
bool mOldDeprecated
private
bool mNewDeprecated
private

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