LibrePCB Developers Documentation
CmdBoardHoleEdit Class Referencefinal

The CmdBoardHoleEdit class. More...

#include <cmdboardholeedit.h>

+ Inheritance diagram for CmdBoardHoleEdit:
+ Collaboration diagram for CmdBoardHoleEdit:

Public Member Functions

 CmdBoardHoleEdit ()=delete
 
 CmdBoardHoleEdit (const CmdBoardHoleEdit &other)=delete
 
 CmdBoardHoleEdit (BI_Hole &hole) noexcept
 
 ~CmdBoardHoleEdit () noexcept
 
void setPath (const NonEmptyPath &path, bool immediate) noexcept
 
void translate (const Point &deltaPos, bool immediate) noexcept
 
void snapToGrid (const PositiveLength &gridInterval, bool immediate) noexcept
 
void rotate (const Angle &angle, const Point &center, bool immediate) noexcept
 
void mirror (Qt::Orientation orientation, const Point &center, bool immediate) noexcept
 
void setDiameter (const PositiveLength &diameter, bool immediate) noexcept
 
void setStopMaskConfig (const MaskConfig &config) noexcept
 
void setLocked (bool locked) noexcept
 
CmdBoardHoleEditoperator= (const CmdBoardHoleEdit &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...
 
void performUndo () override
 Undo the command. More...
 
void performRedo () override
 Redo the command. More...
 

Private Attributes

BI_HolemHole
 
BoardHoleData mOldData
 
BoardHoleData mNewData
 

Additional Inherited Members

Detailed Description

The CmdBoardHoleEdit class.

Constructor & Destructor Documentation

◆ CmdBoardHoleEdit() [1/3]

CmdBoardHoleEdit ( )
delete

◆ CmdBoardHoleEdit() [2/3]

CmdBoardHoleEdit ( const CmdBoardHoleEdit other)
delete

◆ CmdBoardHoleEdit() [3/3]

CmdBoardHoleEdit ( BI_Hole hole)
explicitnoexcept

◆ ~CmdBoardHoleEdit()

~CmdBoardHoleEdit ( )
noexcept
+ Here is the call graph for this function:

Member Function Documentation

◆ setPath()

void setPath ( const NonEmptyPath path,
bool  immediate 
)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ translate()

void translate ( const Point deltaPos,
bool  immediate 
)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ snapToGrid()

void snapToGrid ( const PositiveLength gridInterval,
bool  immediate 
)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ rotate()

void rotate ( const Angle angle,
const Point center,
bool  immediate 
)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mirror()

void mirror ( Qt::Orientation  orientation,
const Point center,
bool  immediate 
)
noexcept
+ Here is the call graph for this function:

◆ setDiameter()

void setDiameter ( const PositiveLength diameter,
bool  immediate 
)
noexcept
+ Here is the call graph for this function:

◆ setStopMaskConfig()

void setStopMaskConfig ( const MaskConfig config)
noexcept
+ Here is the call graph for this function:

◆ setLocked()

void setLocked ( bool  locked)
noexcept
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ operator=()

CmdBoardHoleEdit& operator= ( const CmdBoardHoleEdit rhs)
delete

◆ 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:
+ Here is the caller 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

◆ mHole

BI_Hole& mHole
private

◆ mOldData

BoardHoleData mOldData
private

◆ mNewData

BoardHoleData mNewData
private

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