#include <kis_command_utils.h>

Inheritance diagram for KisCommandUtils::FlipFlopCommand:

Public Types
enum	State { INITIALIZING , FINALIZING }

Public Member Functions
	FlipFlopCommand (bool finalizing=false, KUndo2Command *parent=0)

	FlipFlopCommand (State initialState, KUndo2Command *parent=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 ()

Protected Member Functions
State	getState () const

bool	isFirstRedo () const

virtual void	partA ()

virtual void	partB ()

Private Attributes
State	m_currentState

bool	m_firstRedo {true}

Detailed Description

Definition at line 97 of file kis_command_utils.h.

Member Enumeration Documentation

◆ State

enum KisCommandUtils::FlipFlopCommand::State

Enumerator
INITIALIZING
FINALIZING

Definition at line 98 of file kis_command_utils.h.

                   {
            INITIALIZING, // Before redo; after undo.
            FINALIZING    // After redo; before undo.
        };

Constructor & Destructor Documentation

◆ FlipFlopCommand() [1/2]

KisCommandUtils::FlipFlopCommand::FlipFlopCommand	(	State	initialState,
		KUndo2Command *	parent = 0 )

Definition at line 146 of file kis_command_utils.cpp.

        : KUndo2Command(parent),
          m_currentState(initialState)
    {}

◆ FlipFlopCommand() [2/2]

KisCommandUtils::FlipFlopCommand::FlipFlopCommand	(	bool	finalizing = false,
		KUndo2Command *	parent = 0 )

Definition at line 140 of file kis_command_utils.cpp.

        : KUndo2Command(parent)
    {
        m_currentState = finalizing ? State::FINALIZING : State::INITIALIZING;
    }

References FINALIZING, INITIALIZING, and m_currentState.

Member Function Documentation

◆ getState()

State KisCommandUtils::FlipFlopCommand::getState ( ) const

inlineprotected

Definition at line 113 of file kis_command_utils.h.

113{ return m_currentState; }

◆ isFirstRedo()

bool KisCommandUtils::FlipFlopCommand::isFirstRedo ( ) const

inlineprotected

Definition at line 114 of file kis_command_utils.h.

114{ return m_firstRedo; }

KisCommandUtils::FlipFlopCommand::m_firstRedo

bool m_firstRedo

Definition kis_command_utils.h:118

◆ partA()

void KisCommandUtils::FlipFlopCommand::partA ( )

protectedvirtual

Reimplemented in KoAddRemoveShapeCommandImpl, KisDisableDirtyRequestsCommand, KisHoldUIUpdatesCommand, KisImage::KisImagePrivate::SetImageProjectionColorSpace, KisLayerUtils::SwitchFrameCommand, DisableUIUpdatesCommand, UpdateCommand, KeyStrokeAddRemoveCommand, and ActivateSelectionMasksCommand.

Definition at line 171 of file kis_command_utils.cpp.

171{}

◆ partB()

void KisCommandUtils::FlipFlopCommand::partB ( )

protectedvirtual

Reimplemented in KisNotifySelectionChangedCommand, KoAddRemoveShapeCommandImpl, KoKeepShapesSelectedCommand, KisDisableDirtyRequestsCommand, KisHoldUIUpdatesCommand, KisResetGroupLayerCacheCommand, KisUpdateCommandEx, KisLayerUtils::SwitchFrameCommand, KisLayerUtils::KeepNodesSelectedCommand, KisLayerUtils::KisSimpleUpdateCommand, DisableUIUpdatesCommand, UpdateCommand, EmitImageSignalsCommand, KeyStrokeAddRemoveCommand, UpdateMovedNodesCommand, and ActivateSelectionMasksCommand.

Definition at line 172 of file kis_command_utils.cpp.

172{}

◆ redo()

void KisCommandUtils::FlipFlopCommand::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.

Reimplemented in KisBatchUpdateLayerModificationCommand.

Definition at line 151 of file kis_command_utils.cpp.

    {
        if (m_currentState == FlipFlopCommand::State::INITIALIZING) {
            partA();
        } else {
            partB();
        }
 
        m_firstRedo = false;
    }

References INITIALIZING, m_currentState, m_firstRedo, partA(), and partB().

◆ undo()

void KisCommandUtils::FlipFlopCommand::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.

Reimplemented in KisBatchUpdateLayerModificationCommand.

Definition at line 162 of file kis_command_utils.cpp.

    {
        if (m_currentState == FlipFlopCommand::State::FINALIZING) {
            partA();
        } else {
            partB();
        }
    }

References FINALIZING, m_currentState, partA(), and partB().

Member Data Documentation

◆ m_currentState

State KisCommandUtils::FlipFlopCommand::m_currentState

private

Definition at line 117 of file kis_command_utils.h.

◆ m_firstRedo

bool KisCommandUtils::FlipFlopCommand::m_firstRedo {true}