KisSurrogateUndoStore Class Reference

#include <kis_undo_stores.h>

Inheritance diagram for KisSurrogateUndoStore:

Public Member Functions
void	addCommand (KUndo2Command *cmd) override
void	beginMacro (const KUndo2MagicString &macroName) override
void	clear ()
void	endMacro () override
	KisSurrogateUndoStore ()
const KUndo2Command *	presentCommand () override
void	purgeRedoState () override
void	redo ()
void	redoAll ()
void	undo ()
void	undoAll ()
void	undoLastCommand () override
	~KisSurrogateUndoStore () override
Public Member Functions inherited from KisUndoStore
	KisUndoStore ()
virtual	~KisUndoStore ()

Private Attributes
KUndo2Stack *	m_undoStack

Additional Inherited Members
Signals inherited from KisUndoStore
void	historyStateChanged ()

Detailed Description

KisSurrogateUndoAdapter – saves commands directly to the internal stack. Used for wrapping around legacy code into a single command.

Definition at line 21 of file kis_undo_stores.h.

Constructor & Destructor Documentation

KisSurrogateUndoStore()

KisSurrogateUndoStore::KisSurrogateUndoStore

(

)

Definition at line 16 of file kis_undo_stores.cpp.

    : m_undoStack(new KUndo2Stack)
{
    // Use direct connection to avoid queueing the signal forwarding (BUG:447985)
    connect(m_undoStack, SIGNAL(indexChanged(int)), this, SIGNAL(historyStateChanged()), Qt::DirectConnection);
}

References connect(), KisUndoStore::historyStateChanged(), and m_undoStack.

~KisSurrogateUndoStore()

KisSurrogateUndoStore::~KisSurrogateUndoStore ( )

override

Definition at line 23 of file kis_undo_stores.cpp.

{
    // disconnect the signal to avoid the it being emitted on destruction
    disconnect(m_undoStack, SIGNAL(indexChanged(int)), this, SIGNAL(historyStateChanged()));
    delete m_undoStack;
}

References KisUndoStore::historyStateChanged(), and m_undoStack.

Member Function Documentation

addCommand()

void KisSurrogateUndoStore::addCommand ( KUndo2Command * cmd )

overridevirtual

Implements KisUndoStore.

Definition at line 40 of file kis_undo_stores.cpp.

{
    if(!command) return;
    m_undoStack->push(command);
}

References m_undoStack, and KUndo2QStack::push().

beginMacro()

void KisSurrogateUndoStore::beginMacro ( const KUndo2MagicString & macroName )

overridevirtual

Implements KisUndoStore.

Definition at line 46 of file kis_undo_stores.cpp.

{
    m_undoStack->beginMacro(macroName);
}

References KUndo2QStack::beginMacro(), and m_undoStack.

clear()

void KisSurrogateUndoStore::clear

(

)

Definition at line 71 of file kis_undo_stores.cpp.

{
    m_undoStack->clear();
}

References KUndo2QStack::clear(), and m_undoStack.

endMacro()

void KisSurrogateUndoStore::endMacro ( )

overridevirtual

Implements KisUndoStore.

Definition at line 51 of file kis_undo_stores.cpp.

{
    m_undoStack->endMacro();
}

References KUndo2QStack::endMacro(), and m_undoStack.

presentCommand()

const KUndo2Command * KisSurrogateUndoStore::presentCommand ( )

overridevirtual

WARNING: All these methods are not considered as thread-safe

Implements KisUndoStore.

Definition at line 30 of file kis_undo_stores.cpp.

{
    return m_undoStack->command(m_undoStack->index() - 1);
}

References KUndo2QStack::command(), KUndo2QStack::index(), and m_undoStack.

purgeRedoState()

void KisSurrogateUndoStore::purgeRedoState ( )

overridevirtual

Implements KisUndoStore.

Definition at line 66 of file kis_undo_stores.cpp.

{
    m_undoStack->purgeRedoState();
}

References m_undoStack, and KUndo2QStack::purgeRedoState().

redo()

void KisSurrogateUndoStore::redo

(

)

Definition at line 61 of file kis_undo_stores.cpp.

{
    m_undoStack->redo();
}

References m_undoStack, and KUndo2QStack::redo().

redoAll()

void KisSurrogateUndoStore::redoAll

(

)

Definition at line 83 of file kis_undo_stores.cpp.

{
    while(m_undoStack->canRedo()) {
        m_undoStack->redo();
    }
}

References KUndo2QStack::canRedo(), m_undoStack, and KUndo2QStack::redo().

undo()

void KisSurrogateUndoStore::undo

(

)

Definition at line 56 of file kis_undo_stores.cpp.

{
    m_undoStack->undo();
}

References m_undoStack, and KUndo2QStack::undo().

undoAll()

void KisSurrogateUndoStore::undoAll

(

)

Definition at line 76 of file kis_undo_stores.cpp.

{
    while(m_undoStack->canUndo()) {
        m_undoStack->undo();
    }
}

References KUndo2QStack::canUndo(), m_undoStack, and KUndo2QStack::undo().

undoLastCommand()

void KisSurrogateUndoStore::undoLastCommand ( )

overridevirtual

Implements KisUndoStore.

Definition at line 35 of file kis_undo_stores.cpp.

{
    m_undoStack->undo();
}

References m_undoStack, and KUndo2QStack::undo().

Member Data Documentation

m_undoStack

KUndo2Stack* KisSurrogateUndoStore::m_undoStack

private

Definition at line 44 of file kis_undo_stores.h.

---

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

• libs/command/kis_undo_stores.h
• libs/command/kis_undo_stores.cpp