KisDoSomethingCommand< DoSomethingOp, LayerType > Class Template Reference

#include <kis_do_something_command.h>

Inheritance diagram for KisDoSomethingCommand< DoSomethingOp, LayerType >:

Public Member Functions
	KisDoSomethingCommand (LayerType layer, bool finalUpdate, KUndo2Command *parentCommand=0)
void	redo () override
void	undo () override
Public Member Functions inherited from KUndo2Command
QString	actionText () const
virtual bool	canAnnihilateWith (const KUndo2Command *other) const
const KUndo2Command *	child (int index) const
int	childCount () const
virtual QTime	endTime () const
KUndo2CommandExtraData *	extraData () 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
bool	m_finalUpdate
LayerType	m_layer

Detailed Description

template<template< class T > class DoSomethingOp, class LayerType>
class KisDoSomethingCommand< DoSomethingOp, LayerType >

Definition at line 13 of file kis_do_something_command.h.

Constructor & Destructor Documentation

KisDoSomethingCommand()

template<template< class T > class DoSomethingOp, class LayerType >

KisDoSomethingCommand< DoSomethingOp, LayerType >::KisDoSomethingCommand ( LayerType layer, bool finalUpdate, KUndo2Command * parentCommand = 0 )

inline

Definition at line 16 of file kis_do_something_command.h.

        : KUndo2Command(parentCommand),
          m_layer(layer),
          m_finalUpdate(finalUpdate) {}

Member Function Documentation

redo()

template<template< class T > class DoSomethingOp, class LayerType >

void KisDoSomethingCommand< DoSomethingOp, LayerType >::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 28 of file kis_do_something_command.h.

                         {
        DoSomethingOp<LayerType> op;
        if (m_finalUpdate) {
            op(m_layer);
        }
    }

References KisDoSomethingCommand< DoSomethingOp, LayerType >::m_finalUpdate, and KisDoSomethingCommand< DoSomethingOp, LayerType >::m_layer.

undo()

template<template< class T > class DoSomethingOp, class LayerType >

void KisDoSomethingCommand< DoSomethingOp, LayerType >::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 21 of file kis_do_something_command.h.

                         {
        DoSomethingOp<LayerType> op;
        if (!m_finalUpdate) {
            op(m_layer);
        }
    }

References KisDoSomethingCommand< DoSomethingOp, LayerType >::m_finalUpdate, and KisDoSomethingCommand< DoSomethingOp, LayerType >::m_layer.

Member Data Documentation

m_finalUpdate

template<template< class T > class DoSomethingOp, class LayerType >

bool KisDoSomethingCommand< DoSomethingOp, LayerType >::m_finalUpdate

private

Definition at line 37 of file kis_do_something_command.h.

m_layer

template<template< class T > class DoSomethingOp, class LayerType >

LayerType KisDoSomethingCommand< DoSomethingOp, LayerType >::m_layer

private

Definition at line 36 of file kis_do_something_command.h.

---

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

• libs/image/kis_do_something_command.h