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

The CmdBoardAdd class. More...

#include <cmdboardadd.h>

+ Inheritance diagram for CmdBoardAdd:
+ Collaboration diagram for CmdBoardAdd:

Public Member Functions

 CmdBoardAdd (Project &project, const ElementName &name) noexcept
 
 CmdBoardAdd (Project &project, const Board &boardToCopy, const ElementName &name) noexcept
 
 ~CmdBoardAdd () noexcept
 
BoardgetBoard () const 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) 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
 

Private Member Functions

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

Private Attributes

ProjectmProject
 
const BoardmBoardToCopy
 
ElementName mName
 
BoardmBoard
 
int mPageIndex
 

Additional Inherited Members

Detailed Description

The CmdBoardAdd class.

Constructor & Destructor Documentation

CmdBoardAdd ( Project project,
const ElementName name 
)
noexcept
CmdBoardAdd ( Project project,
const Board boardToCopy,
const ElementName name 
)
noexcept
~CmdBoardAdd ( )
noexcept

Member Function Documentation

Board* getBoard ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

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

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:

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

Project& mProject
private
const Board* mBoardToCopy
private
ElementName mName
private
Board* mBoard
private
int mPageIndex
private

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