LibrePCB Developers Documentation
CmdAddSymbolToSchematic Class Referencefinal

The CmdAddSymbolToSchematic class. More...

#include <cmdaddsymboltoschematic.h>

+ Inheritance diagram for CmdAddSymbolToSchematic:
+ Collaboration diagram for CmdAddSymbolToSchematic:

Public Member Functions

 CmdAddSymbolToSchematic (Workspace &workspace, Schematic &schematic, ComponentInstance &cmpInstance, const Uuid &symbolItem, const Point &position=Point(), const Angle &angle=Angle()) noexcept
 
 ~CmdAddSymbolToSchematic () noexcept
 
SI_SymbolgetSymbolInstance () const noexcept
 
- Public Member Functions inherited from UndoCommandGroup
 UndoCommandGroup ()=delete
 
 UndoCommandGroup (const UndoCommandGroup &other)=delete
 
 UndoCommandGroup (const QString &text) noexcept
 
virtual ~UndoCommandGroup () noexcept
 
int getChildCount () const noexcept
 
bool appendChild (UndoCommand *cmd)
 Append a new command to the list of child commands. More...
 
UndoCommandGroupoperator= (const UndoCommandGroup &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
 

Private Member Functions

bool performExecute () override
 Execute the command the first time. More...
 

Private Attributes

WorkspacemWorkspace
 
SchematicmSchematic
 
ComponentInstancemComponentInstance
 
Uuid mSymbolItemUuid
 
Point mPosition
 
Angle mAngle
 
SI_SymbolmSymbolInstance
 

Additional Inherited Members

- Protected Member Functions inherited from UndoCommandGroup
virtual void performUndo () override
 Undo the command. More...
 
virtual void performRedo () override
 Redo the command. More...
 
virtual void performPostExecution () noexcept
 Perform custom actions after modifying the undo stack state. More...
 
void execNewChildCmd (UndoCommand *cmd)
 Helper method for derived classes to execute and add new child commands. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ CmdAddSymbolToSchematic()

CmdAddSymbolToSchematic ( Workspace workspace,
Schematic schematic,
ComponentInstance cmpInstance,
const Uuid symbolItem,
const Point position = Point(),
const Angle angle = Angle() 
)
noexcept

◆ ~CmdAddSymbolToSchematic()

~CmdAddSymbolToSchematic ( )
noexcept

Member Function Documentation

◆ getSymbolInstance()

SI_Symbol* getSymbolInstance ( ) const
inlinenoexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ 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)

Reimplemented from UndoCommandGroup.

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

Member Data Documentation

◆ mWorkspace

Workspace& mWorkspace
private

◆ mSchematic

Schematic& mSchematic
private

◆ mComponentInstance

ComponentInstance& mComponentInstance
private

◆ mSymbolItemUuid

Uuid mSymbolItemUuid
private

◆ mPosition

Point mPosition
private

◆ mAngle

Angle mAngle
private

◆ mSymbolInstance

SI_Symbol* mSymbolInstance
private

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