#include <kis_saved_commands.h>

Inheritance diagram for KisSavedCommandBase:

Public Member Functions
	KisSavedCommandBase (const KUndo2MagicString &name, KisStrokesFacade *strokesFacade)

void	redo () override

void	undo () override

	~KisSavedCommandBase () 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 void	addCommands (KisStrokeId id, bool undo)=0

KisStrokesFacade *	strokesFacade ()

Private Member Functions
void	runStroke (bool undo)

Private Attributes
bool	m_skipOneRedo

KisStrokesFacade *	m_strokesFacade

Detailed Description

Definition at line 18 of file kis_saved_commands.h.

Constructor & Destructor Documentation

◆ KisSavedCommandBase()

KisSavedCommandBase::KisSavedCommandBase	(	const KUndo2MagicString &	name,
		KisStrokesFacade *	strokesFacade )

Definition at line 16 of file kis_saved_commands.cpp.

    : KUndo2Command(name),
      m_strokesFacade(strokesFacade),
      m_skipOneRedo(true)
{
}

◆ ~KisSavedCommandBase()

KisSavedCommandBase::~KisSavedCommandBase ( )

override

Definition at line 24 of file kis_saved_commands.cpp.

25{

26}

Member Function Documentation

◆ addCommands()

virtual void KisSavedCommandBase::addCommands	(	KisStrokeId	id,
		bool	undo )

protectedpure virtual

Implemented in KisSavedCommand, and KisSavedMacroCommand.

◆ redo()

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

All the commands are first executed in the stroke and then added to the undo stack. It means that the first redo should be skipped

Reimplemented from KUndo2Command.

Definition at line 52 of file kis_saved_commands.cpp.

{
    if(m_skipOneRedo) {
        m_skipOneRedo = false;
        return;
    }
 
    runStroke(false);
}

References m_skipOneRedo, and runStroke().

◆ runStroke()

void KisSavedCommandBase::runStroke ( bool undo )

private

Definition at line 33 of file kis_saved_commands.cpp.

{
    KisStrokeStrategyUndoCommandBased *strategy =
        new KisStrokeStrategyUndoCommandBased(text(), undo, 0);
    strategy->setUsedWhileUndoRedo(true);
 
    KisStrokeId id = m_strokesFacade->startStroke(strategy);
    addCommands(id, undo);
    m_strokesFacade->endStroke(id);
}

References addCommands(), KisStrokesFacade::endStroke(), m_strokesFacade, KisStrokeStrategyUndoCommandBased::setUsedWhileUndoRedo(), KisStrokesFacade::startStroke(), KUndo2Command::text(), and undo().

◆ strokesFacade()

KisStrokesFacade * KisSavedCommandBase::strokesFacade ( )

protected

Definition at line 28 of file kis_saved_commands.cpp.

{
    return m_strokesFacade;
}

References m_strokesFacade.

◆ undo()

void KisSavedCommandBase::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 44 of file kis_saved_commands.cpp.

{
 
    runStroke(true);
}

References runStroke().

Member Data Documentation

◆ m_skipOneRedo

bool KisSavedCommandBase::m_skipOneRedo

private

Definition at line 37 of file kis_saved_commands.h.

◆ m_strokesFacade

KisStrokesFacade* KisSavedCommandBase::m_strokesFacade

private

Definition at line 36 of file kis_saved_commands.h.

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

libs/image/commands_new/kis_saved_commands.h
libs/image/commands_new/kis_saved_commands.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisSavedCommandBase()

◆ ~KisSavedCommandBase()

Member Function Documentation

◆ addCommands()

◆ redo()

◆ runStroke()

◆ strokesFacade()

◆ undo()

Member Data Documentation

◆ m_skipOneRedo

◆ m_strokesFacade