CmdComponentInstanceEdit Class Reference

The CmdComponentInstanceEdit class. More...

#include <cmdcomponentinstanceedit.h>

Inheritance diagram for CmdComponentInstanceEdit:

Collaboration diagram for CmdComponentInstanceEdit:

Public Member Functions
	CmdComponentInstanceEdit (Circuit &circuit, ComponentInstance &cmp) noexcept
	~CmdComponentInstanceEdit () noexcept
void	setName (const CircuitIdentifier &name) noexcept
void	setValue (const QString &value) noexcept
void	setAttributes (const AttributeList &attributes) noexcept
void	setAssemblyOptions (const ComponentAssemblyOptionList &options) 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)
bool	wasEverReverted () const noexcept
	This method shows whether that command was ever reverted (undo() called at least one time)
bool	isCurrentlyExecuted () const noexcept
	This method shows whether that command is currently executed (redo() called one time more than undo())
virtual bool	execute () final
	Execute the command (must only be called once)
virtual void	undo () final
	Undo the command.
virtual void	redo () final
	Redo the command.
UndoCommand &	operator= (const UndoCommand &rhs)=delete

Private Member Functions
bool	performExecute () override
	Execute the command the first time.
void	performUndo () override
	Undo the command.
void	performRedo () override
	Redo the command.

Private Attributes
Circuit &	mCircuit
ComponentInstance &	mComponentInstance
CircuitIdentifier	mOldName
CircuitIdentifier	mNewName
QString	mOldValue
QString	mNewValue
AttributeList	mOldAttributes
AttributeList	mNewAttributes
ComponentAssemblyOptionList	mOldAssemblyOptions
ComponentAssemblyOptionList	mNewAssemblyOptions

Additional Inherited Members

Detailed Description

The CmdComponentInstanceEdit class.

Constructor & Destructor Documentation

CmdComponentInstanceEdit()

CmdComponentInstanceEdit ( Circuit &  circuit, ComponentInstance &  cmp  )

noexcept

~CmdComponentInstanceEdit()

~CmdComponentInstanceEdit ( )

noexcept

Member Function Documentation

setName()

void setName ( const CircuitIdentifier &  name )

noexcept

setValue()

void setValue ( const QString &  value )

noexcept

setAttributes()

void setAttributes ( const AttributeList &  attributes )

noexcept

setAssemblyOptions()

void setAssemblyOptions ( const ComponentAssemblyOptionList &  options )

noexcept

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

true	If the command has done some changes
false	If 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

mCircuit

Circuit& mCircuit

private

mComponentInstance

ComponentInstance& mComponentInstance

private

mOldName

CircuitIdentifier mOldName

private

mNewName

CircuitIdentifier mNewName

private

mOldValue

QString mOldValue

private

mNewValue

QString mNewValue

private

mOldAttributes

AttributeList mOldAttributes

private

mNewAttributes

AttributeList mNewAttributes

private

mOldAssemblyOptions

ComponentAssemblyOptionList mOldAssemblyOptions

private

mNewAssemblyOptions

ComponentAssemblyOptionList mNewAssemblyOptions

private

---

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

• /__w/1/s/libs/librepcb/editor/project/cmd/cmdcomponentinstanceedit.h
• /__w/1/s/libs/librepcb/editor/project/cmd/cmdcomponentinstanceedit.cpp