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
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)
bool	wasEverReverted () const noexcept
	This method shows whether that command was ever reverted (undo() called at least one time)
bool	isCurrentlyExecuted () const noexcept
	This method shows whether that command is currently executed (redo() called one time more than undo())
virtual bool	execute () final
	Execute the command (must only be called once)
virtual void	undo () final
	Undo the command.
virtual void	redo () final
	Redo the command.
UndoCommand &	operator= (const UndoCommand &rhs)=delete

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

Private Attributes
LibraryBaseElement &	mElement
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

The CmdLibraryBaseElementEdit class.

Constructor & Destructor Documentation

CmdLibraryBaseElementEdit() [1/3]

CmdLibraryBaseElementEdit ( )

delete

CmdLibraryBaseElementEdit() [2/3]

CmdLibraryBaseElementEdit ( const CmdLibraryBaseElementEdit &  other )

delete

CmdLibraryBaseElementEdit() [3/3]

CmdLibraryBaseElementEdit ( LibraryBaseElement &  element, const QString &  text  )

explicitnoexcept

~CmdLibraryBaseElementEdit()

~CmdLibraryBaseElementEdit ( )

virtualnoexcept

Member Function Documentation

setName()

void setName ( const QString &  locale, const ElementName &  name  )

noexcept

setNames()

void setNames ( const LocalizedNameMap &  names )

noexcept

setDescription()

void setDescription ( const QString &  locale, const QString &  desc  )

noexcept

setDescriptions()

void setDescriptions ( const LocalizedDescriptionMap &  descriptions )

noexcept

setKeywords() [1/2]

void setKeywords ( const QString &  locale, const QString &  keywords  )

noexcept

setKeywords() [2/2]

void setKeywords ( const LocalizedKeywordsMap &  keywords )

noexcept

setVersion()

void setVersion ( const Version &  version )

noexcept

setAuthor()

void setAuthor ( const QString &  author )

noexcept

setDeprecated()

void setDeprecated ( bool  deprecated )

noexcept

operator=()

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

true	If the command has done some changes
false	If the command has done nothing (the command can be deleted)

Implements UndoCommand.

Reimplemented in CmdComponentEdit, CmdLibraryCategoryEdit, CmdLibraryEdit, CmdLibraryElementEdit, 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.

Implements UndoCommand.

Reimplemented in CmdComponentEdit, CmdLibraryCategoryEdit, CmdLibraryEdit, CmdLibraryElementEdit, 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.

Implements UndoCommand.

Reimplemented in CmdComponentEdit, CmdLibraryCategoryEdit, CmdLibraryEdit, CmdLibraryElementEdit, and CmdPackageEdit.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mElement

LibraryBaseElement& mElement

private

mOldNames

LocalizedNameMap mOldNames

private

mNewNames

LocalizedNameMap mNewNames

private

mOldDescriptions

LocalizedDescriptionMap mOldDescriptions

private

mNewDescriptions

LocalizedDescriptionMap mNewDescriptions

private

mOldKeywords

LocalizedKeywordsMap mOldKeywords

private

mNewKeywords

LocalizedKeywordsMap mNewKeywords

private

mOldVersion

Version mOldVersion

private

mNewVersion

Version mNewVersion

private

mOldAuthor

QString mOldAuthor

private

mNewAuthor

QString mNewAuthor

private

mOldDeprecated

bool mOldDeprecated

private

mNewDeprecated

bool mNewDeprecated

private

---

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

• /__w/1/s/libs/librepcb/editor/library/cmd/cmdlibrarybaseelementedit.h
• /__w/1/s/libs/librepcb/editor/library/cmd/cmdlibrarybaseelementedit.cpp