LibrePCB Developers Documentation
CmdSymbolPinEdit Class Referencefinal

The CmdSymbolPinEdit class. More...

#include <cmdsymbolpinedit.h>

+ Inheritance diagram for CmdSymbolPinEdit:
+ Collaboration diagram for CmdSymbolPinEdit:

Public Member Functions

 CmdSymbolPinEdit ()=delete
 
 CmdSymbolPinEdit (const CmdSymbolPinEdit &other)=delete
 
 CmdSymbolPinEdit (std::shared_ptr< SymbolPin > pin) noexcept
 
 ~CmdSymbolPinEdit () noexcept
 
void setName (const CircuitIdentifier &name, bool immediate) noexcept
 
void setLength (const UnsignedLength &length, bool immediate) noexcept
 
void setNamePosition (const Point &position, bool immediate) noexcept
 
void setNameRotation (const Angle &rotation, bool immediate) noexcept
 
void setNameHeight (const PositiveLength &height, bool immediate) noexcept
 
void setNameAlignment (const Alignment &align, bool immediate) noexcept
 
void setPosition (const Point &pos, bool immediate) noexcept
 
void translate (const Point &deltaPos, bool immediate) noexcept
 
void snapToGrid (const PositiveLength &gridInterval, bool immediate) noexcept
 
void setRotation (const Angle &angle, 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
 
CmdSymbolPinEditoperator= (const CmdSymbolPinEdit &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

std::shared_ptr< SymbolPinmPin
 
CircuitIdentifier mOldName
 
CircuitIdentifier mNewName
 
UnsignedLength mOldLength
 
UnsignedLength mNewLength
 
Point mOldPos
 
Point mNewPos
 
Angle mOldRotation
 
Angle mNewRotation
 
Point mOldNamePosition
 
Point mNewNamePosition
 
Angle mOldNameRotation
 
Angle mNewNameRotation
 
PositiveLength mOldNameHeight
 
PositiveLength mNewNameHeight
 
Alignment mOldNameAlignment
 
Alignment mNewNameAlignment
 

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

Constructor & Destructor Documentation

◆ CmdSymbolPinEdit() [1/3]

CmdSymbolPinEdit ( )
delete

◆ CmdSymbolPinEdit() [2/3]

CmdSymbolPinEdit ( const CmdSymbolPinEdit other)
delete

◆ CmdSymbolPinEdit() [3/3]

CmdSymbolPinEdit ( std::shared_ptr< SymbolPin pin)
explicitnoexcept

◆ ~CmdSymbolPinEdit()

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

Member Function Documentation

◆ setName()

void setName ( const CircuitIdentifier name,
bool  immediate 
)
noexcept

◆ setLength()

void setLength ( const UnsignedLength length,
bool  immediate 
)
noexcept

◆ setNamePosition()

void setNamePosition ( const Point position,
bool  immediate 
)
noexcept

◆ setNameRotation()

void setNameRotation ( const Angle rotation,
bool  immediate 
)
noexcept

◆ setNameHeight()

void setNameHeight ( const PositiveLength height,
bool  immediate 
)
noexcept

◆ setNameAlignment()

void setNameAlignment ( const Alignment align,
bool  immediate 
)
noexcept

◆ setPosition()

void setPosition ( const Point pos,
bool  immediate 
)
noexcept

◆ translate()

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

◆ snapToGrid()

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

◆ setRotation()

void setRotation ( const Angle angle,
bool  immediate 
)
noexcept

◆ rotate()

void rotate ( const Angle angle,
const Point center,
bool  immediate 
)
noexcept
+ 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:
+ Here is the caller graph for this function:

◆ operator=()

CmdSymbolPinEdit & operator= ( const CmdSymbolPinEdit 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 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 caller graph for this function:

Member Data Documentation

◆ mPin

std::shared_ptr<SymbolPin> mPin
private

◆ mOldName

CircuitIdentifier mOldName
private

◆ mNewName

CircuitIdentifier mNewName
private

◆ mOldLength

UnsignedLength mOldLength
private

◆ mNewLength

UnsignedLength mNewLength
private

◆ mOldPos

Point mOldPos
private

◆ mNewPos

Point mNewPos
private

◆ mOldRotation

Angle mOldRotation
private

◆ mNewRotation

Angle mNewRotation
private

◆ mOldNamePosition

Point mOldNamePosition
private

◆ mNewNamePosition

Point mNewNamePosition
private

◆ mOldNameRotation

Angle mOldNameRotation
private

◆ mNewNameRotation

Angle mNewNameRotation
private

◆ mOldNameHeight

PositiveLength mOldNameHeight
private

◆ mNewNameHeight

PositiveLength mNewNameHeight
private

◆ mOldNameAlignment

Alignment mOldNameAlignment
private

◆ mNewNameAlignment

Alignment mNewNameAlignment
private

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