LibrePCB Developers Documentation
CmdSchematicAdd Class Referencefinal

The CmdSchematicAdd class. More...

#include <cmdschematicadd.h>

+ Inheritance diagram for CmdSchematicAdd:
+ Collaboration diagram for CmdSchematicAdd:

Public Member Functions

 CmdSchematicAdd (Project &project, const QString &dirName, const ElementName &name) noexcept
 
 ~CmdSchematicAdd () noexcept
 
SchematicgetSchematic () 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
 
QString mDirName
 
ElementName mName
 
SchematicmSchematic
 
int mPageIndex
 

Additional Inherited Members

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

Detailed Description

The CmdSchematicAdd class.

Constructor & Destructor Documentation

◆ CmdSchematicAdd()

CmdSchematicAdd ( Project project,
const QString &  dirName,
const ElementName name 
)
noexcept

◆ ~CmdSchematicAdd()

~CmdSchematicAdd ( )
noexcept

Member Function Documentation

◆ getSchematic()

Schematic * getSchematic ( ) const
inlinenoexcept

◆ 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

◆ mDirName

QString mDirName
private

◆ mName

ElementName mName
private

◆ mSchematic

Schematic* mSchematic
private

◆ mPageIndex

int mPageIndex
private

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