#include <kis_gui_context_command.h>

Inheritance diagram for KisGuiContextCommand:

Signals
void	sigExecuteCommand (KUndo2Command *command, bool undo)

Public Member Functions
	KisGuiContextCommand (KUndo2Command command, QObject guiObject)

void	redo () override

void	undo () override

	~KisGuiContextCommand () 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
QScopedPointer< KUndo2Command >	m_command

QScopedPointer< KisGuiContextCommandDelegate >	m_delegate

Detailed Description

KisGuiContextCommand is a special command-wrapper which ensures that the holding command is executed in the GUI thread only. Please note that any activity done by the containing command must not lead to the blocking on the image, otherwise you'll get a deadlock!

Definition at line 21 of file kis_gui_context_command.h.

Constructor & Destructor Documentation

◆ KisGuiContextCommand()

KisGuiContextCommand::KisGuiContextCommand	(	KUndo2Command *	command,
		QObject *	guiObject )

We owe the delegate ourselves, so don't assign a parent to it, but just move it to the GUI thread

Definition at line 11 of file kis_gui_context_command.cpp.

    : m_command(command),
      m_delegate(new KisGuiContextCommandDelegate(0))
{
    m_delegate->moveToThread(guiObject->thread());
 
    connect(this, SIGNAL(sigExecuteCommand(KUndo2Command*,bool)),
            m_delegate.data(), SLOT(executeCommand(KUndo2Command*,bool)),
            Qt::BlockingQueuedConnection);
}

References connect(), m_delegate, and sigExecuteCommand().

◆ ~KisGuiContextCommand()

KisGuiContextCommand::~KisGuiContextCommand ( )

override

Definition at line 26 of file kis_gui_context_command.cpp.

27{

28}

Member Function Documentation

◆ redo()

void KisGuiContextCommand::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 35 of file kis_gui_context_command.cpp.

{
    Q_EMIT sigExecuteCommand(m_command.data(), false);
}

References m_command, and sigExecuteCommand().

◆ sigExecuteCommand

void KisGuiContextCommand::sigExecuteCommand	(	KUndo2Command *	command,
		bool	undo )

signal

◆ undo()

void KisGuiContextCommand::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_gui_context_command.cpp.

{
    Q_EMIT sigExecuteCommand(m_command.data(), true);
}

References m_command, and sigExecuteCommand().

Member Data Documentation

◆ m_command

QScopedPointer<KUndo2Command> KisGuiContextCommand::m_command

private

Definition at line 35 of file kis_gui_context_command.h.

◆ m_delegate

QScopedPointer<KisGuiContextCommandDelegate> KisGuiContextCommand::m_delegate