Krita Source Code Documentation
Loading...
Searching...
No Matches
KisImageLayerRemoveCommand Class Reference

#include <kis_image_layer_remove_command.h>

+ Inheritance diagram for KisImageLayerRemoveCommand:

Public Member Functions

 KisImageLayerRemoveCommand (KisImageWSP image, KisNodeSP node, bool doRedoUpdates=true, bool doUndoUpdates=true)
 
void redo () override
 
void undo () override
 
 ~KisImageLayerRemoveCommand () override
 
- Public Member Functions inherited from KisImageCommand
 KisImageCommand (const KUndo2MagicString &name, KisImageWSP image, KUndo2Command *parent=0)
 
 ~KisImageCommand () 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 Member Functions

void addSubtree (KisImageWSP image, KisNodeSP node)
 

Private Attributes

bool m_doRedoUpdates
 
bool m_doUndoUpdates
 
KisNodeSP m_node
 

Additional Inherited Members

- Protected Attributes inherited from KisImageCommand
KisImageWSP m_image
 

Detailed Description

Definition at line 15 of file kis_image_layer_remove_command.h.

Constructor & Destructor Documentation

◆ KisImageLayerRemoveCommand()

KisImageLayerRemoveCommand::KisImageLayerRemoveCommand ( KisImageWSP image,
KisNodeSP node,
bool doRedoUpdates = true,
bool doUndoUpdates = true )

Definition at line 14 of file kis_image_layer_remove_command.cpp.

18 : KisImageCommand(kundo2_i18n("Remove Layer"), image),
19 m_node(node),
20 m_doRedoUpdates(doRedoUpdates),
21 m_doUndoUpdates(doUndoUpdates)
22{
23 addSubtree(image, node);
24}
KisImageCommand(const KUndo2MagicString &name, KisImageWSP image, KUndo2Command *parent=0)
void addSubtree(KisImageWSP image, KisNodeSP node)
KUndo2MagicString kundo2_i18n(const char *text)

References addSubtree().

◆ ~KisImageLayerRemoveCommand()

KisImageLayerRemoveCommand::~KisImageLayerRemoveCommand ( )
override

Definition at line 26 of file kis_image_layer_remove_command.cpp.

27{
28}

Member Function Documentation

◆ addSubtree()

void KisImageLayerRemoveCommand::addSubtree ( KisImageWSP image,
KisNodeSP node )
private

Definition at line 30 of file kis_image_layer_remove_command.cpp.

31{
32 // Simple tail-recursion to remove nodes in bottom-up way
33 //
34 // Alert: the nodes must be traversed in last-to-first order,
35 // because each KisImageLayerRemoveCommandImpl stores a
36 // pointer to the previous node of the stack
37
38 KisNodeSP child = node->lastChild();
39 while (child) {
40 addSubtree(image, child);
41 child = child->prevSibling();
42 }
43
44 new KisImageLayerRemoveCommandImpl(image, node, this);
45}
const KUndo2Command * child(int index) const
KisNodeSP lastChild() const
Definition kis_node.cpp:367

References addSubtree(), KUndo2Command::child(), and KisNode::lastChild().

◆ redo()

void KisImageLayerRemoveCommand::redo ( )
overridevirtual

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 47 of file kis_image_layer_remove_command.cpp.

48{
50 if (!image) {
51 return;
52 }
53 UpdateTarget target(image, m_node, image->bounds());
55
56 if (m_doRedoUpdates) {
57 target.update();
58 }
59}
KisMagneticGraph::vertex_descriptor target(typename KisMagneticGraph::edge_descriptor e, KisMagneticGraph g)
virtual void redo()
QRect bounds() const override
KisSharedPtr< T > toStrongRef() const
toStrongRef returns a KisSharedPtr which may be dereferenced.

References KisImage::bounds(), m_doRedoUpdates, KisImageCommand::m_image, m_node, KUndo2Command::redo(), target(), and KisWeakSharedPtr< T >::toStrongRef().

◆ undo()

void KisImageLayerRemoveCommand::undo ( )
overridevirtual

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()

We are removing the group recursively, so the updates should come recursively as well

Reimplemented from KUndo2Command.

Definition at line 61 of file kis_image_layer_remove_command.cpp.

62{
64
65 if (m_doUndoUpdates) {
71 if (!image) {
72 return;
73 }
74 image->refreshGraphAsync(m_node, image->bounds());
75 }
76}
virtual void undo()
void refreshGraphAsync(KisNodeSP root, const QVector< QRect > &rects, const QRect &cropRect, KisProjectionUpdateFlags flags=KisProjectionUpdateFlag::None) override

References KisImage::bounds(), m_doUndoUpdates, KisImageCommand::m_image, m_node, KisImage::refreshGraphAsync(), KisWeakSharedPtr< T >::toStrongRef(), and KUndo2Command::undo().

Member Data Documentation

◆ m_doRedoUpdates

bool KisImageLayerRemoveCommand::m_doRedoUpdates
private

Definition at line 32 of file kis_image_layer_remove_command.h.

◆ m_doUndoUpdates

bool KisImageLayerRemoveCommand::m_doUndoUpdates
private

Definition at line 33 of file kis_image_layer_remove_command.h.

◆ m_node

KisNodeSP KisImageLayerRemoveCommand::m_node
private

Definition at line 31 of file kis_image_layer_remove_command.h.


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