LibrePCB Developers Documentation
Loading...
Searching...
No Matches
CmdImageAdd Class Referencefinal

The CmdImageAdd class. More...

#include <cmdimageadd.h>

+ Inheritance diagram for CmdImageAdd:
+ Collaboration diagram for CmdImageAdd:

Public Member Functions

 CmdImageAdd ()=delete
 
 CmdImageAdd (const CmdImageAdd &other)=delete
 
 CmdImageAdd (ImageList &list, TransactionalDirectory &dir, std::shared_ptr< Image > image, const QByteArray &fileContent) noexcept
 Constructor.
 
 ~CmdImageAdd () noexcept
 
CmdImageAddoperator= (const CmdImageAdd &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)
 
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.
 
UndoCommandoperator= (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

ImageListmList
 
TransactionalDirectorymDirectory
 
std::shared_ptr< ImagemImage
 
const QByteArray mFileContent
 

Additional Inherited Members

- Protected Attributes inherited from UndoCommand
QString mText
 

Detailed Description

The CmdImageAdd class.

Constructor & Destructor Documentation

◆ CmdImageAdd() [1/3]

CmdImageAdd ( )
delete

◆ CmdImageAdd() [2/3]

CmdImageAdd ( const CmdImageAdd other)
delete

◆ CmdImageAdd() [3/3]

CmdImageAdd ( ImageList list,
TransactionalDirectory dir,
std::shared_ptr< Image image,
const QByteArray &  fileContent 
)
noexcept

Constructor.

Parameters
listThe list to add the image to.
dirThe directory to add the file to.
imageThe image to add.
fileContentThe file content to add. If NULL, no file is added, only verified that the file exists already. If not NULL, it is verified that the file does not exist yet.

◆ ~CmdImageAdd()

~CmdImageAdd ( )
noexcept

Member Function Documentation

◆ operator=()

CmdImageAdd & operator= ( const CmdImageAdd 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:

◆ 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

◆ mList

ImageList& mList
private

◆ mDirectory

TransactionalDirectory& mDirectory
private

◆ mImage

std::shared_ptr<Image> mImage
private

◆ mFileContent

const QByteArray mFileContent
private

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