LibrePCB Developers Documentation
CmdBoardSplitNetLine Class Reference

Undo command to split a librepcb::BI_NetLine. More...

#include <cmdboardsplitnetline.h>

+ Inheritance diagram for CmdBoardSplitNetLine:
+ Collaboration diagram for CmdBoardSplitNetLine:

Public Member Functions

 CmdBoardSplitNetLine (BI_NetLine &netline, const Point &pos) noexcept
 
 ~CmdBoardSplitNetLine () noexcept
 
BI_NetPointgetSplitPoint () 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

BI_NetLinemOldNetLine
 The BI_NetLine to be split. More...
 
BI_NetPointmSplitPoint
 The new BI_NetPoint at the split position. More...
 

Additional Inherited Members

- Protected Member Functions inherited from UndoCommandGroup
virtual bool performExecute () override
 Execute the command the first time. More...
 
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...
 
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

Undo command to split a librepcb::BI_NetLine.

Splits the BI_NetLine at the given position and creates a new librepcb::BI_NetPoint. It is not checked, whether the split position lies on the BI_NetLine or not.

Constructor & Destructor Documentation

◆ CmdBoardSplitNetLine()

CmdBoardSplitNetLine ( BI_NetLine netline,
const Point pos 
)
explicitnoexcept
+ Here is the call graph for this function:

◆ ~CmdBoardSplitNetLine()

~CmdBoardSplitNetLine ( )
noexcept

Member Function Documentation

◆ getSplitPoint()

BI_NetPoint * getSplitPoint ( )
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)

Reimplemented from UndoCommandGroup.

+ Here is the call graph for this function:

Member Data Documentation

◆ mOldNetLine

BI_NetLine& mOldNetLine
private

The BI_NetLine to be split.

◆ mSplitPoint

BI_NetPoint* mSplitPoint
private

The new BI_NetPoint at the split position.


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