Krita Source Code Documentation
Loading...
Searching...
No Matches
AddReferenceImagesCommand Struct Reference
+ Inheritance diagram for AddReferenceImagesCommand:

Public Member Functions

 AddReferenceImagesCommand (KisDocument *document, KisSharedPtr< KisReferenceImagesLayer > layer, const QList< KoShape * > referenceImages, KUndo2Command *parent=nullptr)
 
void redo () override
 
void undo () override
 
- Public Member Functions inherited from KoShapeCreateCommand
 KoShapeCreateCommand (KoShapeControllerBase *controller, const QList< KoShape * > shape, KoShapeContainer *parentShape=0, KUndo2Command *parent=0)
 
 KoShapeCreateCommand (KoShapeControllerBase *controller, KoShape *shape, KoShapeContainer *parentShape=0, KUndo2Command *parent=0)
 
 Private (KoShapeControllerBase *_document, const QList< KoShape * > &_shapes, KoShapeContainer *_parentShape)
 
void redo () override
 redo the command
 
void undo () override
 revert the actions done in redo
 
 ~KoShapeCreateCommand () override
 
- Public Member Functions inherited from KUndo2Command
QString actionText () const
 
virtual bool canAnnihilateWith (const KUndo2Command *other) const
 
const KUndo2Commandchild (int index) const
 
int childCount () const
 
virtual QTime endTime () const
 
KUndo2CommandExtraDataextraData () const
 
bool hasParent () const
 
virtual int id () const
 
virtual bool isMerged () const
 
 KUndo2Command (const KUndo2MagicString &text, KUndo2Command *parent=0)
 
 KUndo2Command (KUndo2Command *parent=0)
 
virtual QVector< KUndo2Command * > mergeCommandsVector () const
 
virtual bool mergeWith (const KUndo2Command *other)
 
virtual void redoMergedCommands ()
 
void setEndTime ()
 
virtual void setEndTime (const QTime &time)
 
void setExtraData (KUndo2CommandExtraData *data)
 
void setText (const KUndo2MagicString &text)
 
void setTime ()
 
virtual void setTime (const QTime &time)
 
virtual void setTimedID (int timedID)
 
KUndo2MagicString text () const
 
virtual QTime time () const
 
virtual int timedId () const
 
virtual bool timedMergeWith (KUndo2Command *other)
 
virtual void undoMergedCommands ()
 
virtual ~KUndo2Command ()
 

Private Attributes

KisDocumentm_document
 
KisSharedPtr< KisReferenceImagesLayerm_layer
 

Additional Inherited Members

- Public Attributes inherited from KoShapeCreateCommand
KoShapeContainerexplicitParentShape
 
bool firstRedo = true
 
QList< KoShape * > shapes
 
KoShapeControllerBaseshapesDocument
 
KisSurrogateUndoStore undoStore
 
- Protected Member Functions inherited from KoShapeCreateCommand
 KoShapeCreateCommand (KoShapeControllerBase *controller, const QList< KoShape * > shapes, KoShapeContainer *parentShape, KUndo2Command *parent, const KUndo2MagicString &undoString)
 

Detailed Description

Definition at line 21 of file KisReferenceImagesLayer.cpp.

Constructor & Destructor Documentation

◆ AddReferenceImagesCommand()

AddReferenceImagesCommand::AddReferenceImagesCommand ( KisDocument * document,
KisSharedPtr< KisReferenceImagesLayer > layer,
const QList< KoShape * > referenceImages,
KUndo2Command * parent = nullptr )
inline

Definition at line 23 of file KisReferenceImagesLayer.cpp.

24 : KoShapeCreateCommand(layer->shapeController(), referenceImages, layer.data(), parent, kundo2_i18n("Add reference image"))
25 , m_document(document)
26 , m_layer(layer)
27 {}
KoShapeControllerBase * shapeController() const
KoShapeCreateCommand(KoShapeControllerBase *controller, KoShape *shape, KoShapeContainer *parentShape=0, KUndo2Command *parent=0)
KUndo2MagicString kundo2_i18n(const char *text)
KisSharedPtr< KisReferenceImagesLayer > m_layer

Member Function Documentation

◆ redo()

void AddReferenceImagesCommand::redo ( )
inlineoverridevirtual

Applies a change to the document. This function must be implemented in the derived class. Calling KUndo2QStack::push(), KUndo2QStack::undo() or KUndo2QStack::redo() from this function leads to undefined behavior.

The default implementation calls redo() on all child commands.

See also
undo()

Reimplemented from KUndo2Command.

Definition at line 29 of file KisReferenceImagesLayer.cpp.

29 {
30 auto layer = m_document->referenceImagesLayer();
31 KIS_SAFE_ASSERT_RECOVER_NOOP(!layer || layer == m_layer);
32
33 if (!layer) {
35 }
36
38 }
KisSharedPtr< KisReferenceImagesLayer > referenceImagesLayer() const
void setReferenceImagesLayer(KisSharedPtr< KisReferenceImagesLayer > layer, bool updateImage)
void redo() override
redo the command
#define KIS_SAFE_ASSERT_RECOVER_NOOP(cond)
Definition kis_assert.h:130

References KIS_SAFE_ASSERT_RECOVER_NOOP, m_document, m_layer, KoShapeCreateCommand::redo(), KisDocument::referenceImagesLayer(), and KisDocument::setReferenceImagesLayer().

◆ undo()

void AddReferenceImagesCommand::undo ( )
inlineoverridevirtual

Reverts a change to the document. After undo() is called, the state of the document should be the same as before redo() was called. This function must be implemented in the derived class. Calling KUndo2QStack::push(), KUndo2QStack::undo() or KUndo2QStack::redo() from this function leads to undefined behavior.

The default implementation calls undo() on all child commands in reverse order.

See also
redo()

Reimplemented from KUndo2Command.

Definition at line 40 of file KisReferenceImagesLayer.cpp.

40 {
42
43 if (m_layer->shapeCount() == 0) {
44 m_document->setReferenceImagesLayer(nullptr, true);
45 }
46 }
void undo() override
revert the actions done in redo

References m_document, m_layer, KisDocument::setReferenceImagesLayer(), KoShapeContainer::shapeCount(), and KoShapeCreateCommand::undo().

Member Data Documentation

◆ m_document

KisDocument* AddReferenceImagesCommand::m_document
private

Definition at line 49 of file KisReferenceImagesLayer.cpp.

◆ m_layer

KisSharedPtr<KisReferenceImagesLayer> AddReferenceImagesCommand::m_layer
private

Definition at line 50 of file KisReferenceImagesLayer.cpp.


The documentation for this struct was generated from the following file: