LibrePCB Developers Documentation
Loading...
Searching...
No Matches
CmdProjectEdit Class Referencefinal

The CmdProjectEdit class. More...

#include <cmdprojectedit.h>

+ Inheritance diagram for CmdProjectEdit:
+ Collaboration diagram for CmdProjectEdit:

Public Member Functions

 CmdProjectEdit (Project &project) noexcept
 
 ~CmdProjectEdit () noexcept
 
void setName (const ElementName &newName) noexcept
 
void setAuthor (const QString &newAuthor) noexcept
 
void setVersion (const FileProofName &newVersion) noexcept
 
void setAttributes (const AttributeList &attributes) noexcept
 
void setLocaleOrder (const QStringList &order) noexcept
 
void setNormOrder (const QStringList &order) noexcept
 
void setOutputBaseDir (const QString &dir) noexcept
 
void setOutputJobs (const OutputJobList &jobs) noexcept
 
- 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.
 
UndoCommandoperator= (const UndoCommand &rhs)=delete
 

Private Member Functions

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

Private Attributes

ProjectmProject
 
ElementName mOldName
 
ElementName mNewName
 
QString mOldAuthor
 
QString mNewAuthor
 
FileProofName mOldVersion
 
FileProofName mNewVersion
 
AttributeList mOldAttributes
 
AttributeList mNewAttributes
 
QStringList mOldLocaleOrder
 
QStringList mNewLocaleOrder
 
QStringList mOldNormOrder
 
QStringList mNewNormOrder
 
OutputJobList mOldOutputJobs
 
OutputJobList mNewOutputJobs
 

Additional Inherited Members

Detailed Description

The CmdProjectEdit class.

Constructor & Destructor Documentation

◆ CmdProjectEdit()

CmdProjectEdit ( Project project)
explicitnoexcept

◆ ~CmdProjectEdit()

~CmdProjectEdit ( )
noexcept

Member Function Documentation

◆ setName()

void setName ( const ElementName newName)
noexcept

◆ setAuthor()

void setAuthor ( const QString &  newAuthor)
noexcept

◆ setVersion()

void setVersion ( const FileProofName newVersion)
noexcept

◆ setAttributes()

void setAttributes ( const AttributeList attributes)
noexcept

◆ setLocaleOrder()

void setLocaleOrder ( const QStringList &  order)
noexcept

◆ setNormOrder()

void setNormOrder ( const QStringList &  order)
noexcept

◆ setOutputBaseDir()

void setOutputBaseDir ( const QString &  dir)
noexcept

◆ setOutputJobs()

void setOutputJobs ( const OutputJobList jobs)
noexcept

◆ performExecute()

bool performExecute ( )
overrideprivatevirtual

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)

Implements UndoCommand.

+ Here is the call graph for this function:

◆ performUndo()

void performUndo ( )
overrideprivatevirtual

Undo the command.

Note
This method must be implemented in all derived classes.

Implements UndoCommand.

+ Here is the call graph for this function:

◆ performRedo()

void performRedo ( )
overrideprivatevirtual

Redo the command.

Note
This method must be implemented in all derived classes.

Implements UndoCommand.

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

Member Data Documentation

◆ mProject

Project& mProject
private

◆ mOldName

ElementName mOldName
private

◆ mNewName

ElementName mNewName
private

◆ mOldAuthor

QString mOldAuthor
private

◆ mNewAuthor

QString mNewAuthor
private

◆ mOldVersion

FileProofName mOldVersion
private

◆ mNewVersion

FileProofName mNewVersion
private

◆ mOldAttributes

AttributeList mOldAttributes
private

◆ mNewAttributes

AttributeList mNewAttributes
private

◆ mOldLocaleOrder

QStringList mOldLocaleOrder
private

◆ mNewLocaleOrder

QStringList mNewLocaleOrder
private

◆ mOldNormOrder

QStringList mOldNormOrder
private

◆ mNewNormOrder

QStringList mNewNormOrder
private

◆ mOldOutputJobs

OutputJobList mOldOutputJobs
private

◆ mNewOutputJobs

OutputJobList mNewOutputJobs
private

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