#include <kis_transaction_based_command.h>

Inheritance diagram for KisTransactionBasedCommand:

Public Member Functions
	KisTransactionBasedCommand (const KUndo2MagicString &text=KUndo2MagicString(), KUndo2Command *parent=0)

void	redo () override

void	undo () override

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

Protected Member Functions
virtual KUndo2Command *	paint ()=0

Private Attributes
KUndo2Command *	m_transactionData

Detailed Description

Definition at line 13 of file kis_transaction_based_command.h.

Constructor & Destructor Documentation

◆ KisTransactionBasedCommand()

KisTransactionBasedCommand::KisTransactionBasedCommand	(	const KUndo2MagicString &	text = KUndo2MagicString(),
		KUndo2Command *	parent = 0 )

Definition at line 9 of file kis_transaction_based_command.cpp.

    : KUndo2Command(text, parent), m_transactionData(0)
{
}

◆ ~KisTransactionBasedCommand()

KisTransactionBasedCommand::~KisTransactionBasedCommand ( )

override

Definition at line 14 of file kis_transaction_based_command.cpp.

{
    delete m_transactionData;
}

References m_transactionData.

Member Function Documentation

◆ paint()

virtual KUndo2Command * KisTransactionBasedCommand::paint ( )

protectedpure virtual

Implemented in LazyInitGlobalSelection, and KisToolSmartPatch::InpaintCommand.

◆ redo()

void KisTransactionBasedCommand::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 19 of file kis_transaction_based_command.cpp.

{
    if (!m_transactionData) {
        m_transactionData = paint();
    }
 
    if (m_transactionData) {
        m_transactionData->redo();
    }
}

References m_transactionData, paint(), and KUndo2Command::redo().

◆ undo()

void KisTransactionBasedCommand::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()

Reimplemented from KUndo2Command.

Definition at line 30 of file kis_transaction_based_command.cpp.

{
    if (m_transactionData) {
        m_transactionData->undo();
    }
}

References m_transactionData, and KUndo2Command::undo().

Member Data Documentation

◆ m_transactionData

KUndo2Command* KisTransactionBasedCommand::m_transactionData

private

Definition at line 26 of file kis_transaction_based_command.h.

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

libs/image/commands_new/kis_transaction_based_command.h
libs/image/commands_new/kis_transaction_based_command.cpp

Public Member Functions

Protected Member Functions

Private Attributes