KisNodeCommandsAdapter Class Reference

#include <kis_node_commands_adapter.h>

Inheritance diagram for KisNodeCommandsAdapter:

Public Member Functions
void	addExtraCommand (KUndo2Command *command)
void	addNode (KisNodeSP node, KisNodeSP parent, KisNodeSP aboveThis, KisImageLayerAddCommand::Flags flags=KisImageLayerAddCommand::DoRedoUpdates|KisImageLayerAddCommand::DoUndoUpdates)
void	addNode (KisNodeSP node, KisNodeSP parent, quint32 index, KisImageLayerAddCommand::Flags flags=KisImageLayerAddCommand::DoRedoUpdates|KisImageLayerAddCommand::DoUndoUpdates)
void	addNodeAsync (KisNodeSP node, KisNodeSP parent, KisNodeSP aboveThis, bool doRedoUpdates=true, bool doUndoUpdates=true, KisProcessingApplicator *applicator=0)
void	addNodeAsync (KisNodeSP node, KisNodeSP parent, quint32 index, bool doRedoUpdates=true, bool doUndoUpdates=true, KisProcessingApplicator *applicator=0)
void	applyOneCommandAsync (KUndo2Command *cmd, KisProcessingApplicator *applicator=0)
void	beginMacro (const KUndo2MagicString &macroName)
void	endMacro ()
	KisNodeCommandsAdapter (KisViewManager *view)
void	moveNode (KisNodeSP node, KisNodeSP parent, KisNodeSP aboveThis)
void	moveNode (KisNodeSP node, KisNodeSP parent, quint32 indexaboveThis)
void	removeNode (KisNodeSP node)
void	setCompositeOp (KisNodeSP node, const KoCompositeOp *compositeOp)
void	setNodeName (KisNodeSP node, const QString &name)
void	setOpacity (KisNodeSP node, qint32 opacity)
void	undoLastCommand ()
	~KisNodeCommandsAdapter () override

Private Attributes
KisViewManager *	m_view

Detailed Description

This class allows the manipulation of nodes in a KisImage and creates commands as needed.

Definition at line 26 of file kis_node_commands_adapter.h.

Constructor & Destructor Documentation

KisNodeCommandsAdapter()

KisNodeCommandsAdapter::KisNodeCommandsAdapter

(

KisViewManager *

view

)

Definition at line 19 of file kis_node_commands_adapter.cpp.

        : QObject(view)
        , m_view(view)
{
 
}

~KisNodeCommandsAdapter()

KisNodeCommandsAdapter::~KisNodeCommandsAdapter ( )

override

Definition at line 26 of file kis_node_commands_adapter.cpp.

{
}

Member Function Documentation

addExtraCommand()

void KisNodeCommandsAdapter::addExtraCommand

(

KUndo2Command *

command

)

Definition at line 63 of file kis_node_commands_adapter.cpp.

{
    Q_ASSERT(m_view->image()->undoAdapter());
    m_view->image()->undoAdapter()->addCommand(command);
}

References KisUndoAdapter::addCommand(), KisViewManager::image(), m_view, and KisImage::undoAdapter().

addNode() [1/2]

void KisNodeCommandsAdapter::addNode	(	KisNodeSP	node,
		KisNodeSP	parent,
		KisNodeSP	aboveThis,
		KisImageLayerAddCommand::Flags	flags = KisImageLayerAddCommand::DoRedoUpdates | KisImageLayerAddCommand::DoUndoUpdates )

Definition at line 75 of file kis_node_commands_adapter.cpp.

{
    Q_ASSERT(m_view->image()->undoAdapter());
    m_view->image()->undoAdapter()->addCommand(new KisImageLayerAddCommand(m_view->image(), node, parent, aboveThis, flags));
}

References KisUndoAdapter::addCommand(), KisViewManager::image(), m_view, and KisImage::undoAdapter().

addNode() [2/2]

void KisNodeCommandsAdapter::addNode	(	KisNodeSP	node,
		KisNodeSP	parent,
		quint32	index,
		KisImageLayerAddCommand::Flags	flags = KisImageLayerAddCommand::DoRedoUpdates | KisImageLayerAddCommand::DoUndoUpdates )

Definition at line 81 of file kis_node_commands_adapter.cpp.

{
    Q_ASSERT(m_view->image()->undoAdapter());
    m_view->image()->undoAdapter()->addCommand(new KisImageLayerAddCommand(m_view->image(), node, parent, index, flags));
}

References KisUndoAdapter::addCommand(), KisViewManager::image(), m_view, and KisImage::undoAdapter().

addNodeAsync() [1/2]

void KisNodeCommandsAdapter::addNodeAsync	(	KisNodeSP	node,
		KisNodeSP	parent,
		KisNodeSP	aboveThis,
		bool	doRedoUpdates = true,
		bool	doUndoUpdates = true,
		KisProcessingApplicator *	applicator = 0 )

Same as addNode(), but adds a node using the provided applicator in an asynchronous way. If applicator is null, then a temporary applicator (with a stroke) is created.

Definition at line 45 of file kis_node_commands_adapter.cpp.

{
    KUndo2Command *cmd = new KisImageLayerAddCommand(m_view->image(), node, parent, aboveThis, doRedoUpdates, doUndoUpdates);
    applyOneCommandAsync(cmd, applicator);
}

References applyOneCommandAsync(), KisViewManager::image(), and m_view.

addNodeAsync() [2/2]

void KisNodeCommandsAdapter::addNodeAsync	(	KisNodeSP	node,
		KisNodeSP	parent,
		quint32	index,
		bool	doRedoUpdates = true,
		bool	doUndoUpdates = true,
		KisProcessingApplicator *	applicator = 0 )

Definition at line 51 of file kis_node_commands_adapter.cpp.

{
    KUndo2Command *cmd = new KisImageLayerAddCommand(m_view->image(), node, parent, index, doRedoUpdates, doUndoUpdates);
    applyOneCommandAsync(cmd, applicator);
}

References applyOneCommandAsync(), KisViewManager::image(), and m_view.

applyOneCommandAsync()

void KisNodeCommandsAdapter::applyOneCommandAsync	(	KUndo2Command *	cmd,
		KisProcessingApplicator *	applicator = 0 )

Applies cmd on a provided applicator. If applicator is null, then a temporary applicator is created locally.

Definition at line 30 of file kis_node_commands_adapter.cpp.

{
    if (applicator) {
        applicator->applyCommand(cmd, KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::EXCLUSIVE);
    } else {
        QScopedPointer<KisProcessingApplicator> localApplicator(
            new KisProcessingApplicator(m_view->image(), 0, KisProcessingApplicator::NONE,
                                        KisImageSignalVector(),
                                        cmd->text(),
                                        0, cmd->id()));
        localApplicator->applyCommand(cmd);
        localApplicator->end();
    }
}

References KisProcessingApplicator::applyCommand(), KisStrokeJobData::EXCLUSIVE, KUndo2Command::id(), KisViewManager::image(), m_view, KisProcessingApplicator::NONE, KisStrokeJobData::SEQUENTIAL, and KUndo2Command::text().

beginMacro()

void KisNodeCommandsAdapter::beginMacro

(

const KUndo2MagicString &

macroName

)

Definition at line 57 of file kis_node_commands_adapter.cpp.

{
    Q_ASSERT(m_view->image()->undoAdapter());
    m_view->image()->undoAdapter()->beginMacro(macroName);
}

References KisUndoAdapter::beginMacro(), KisViewManager::image(), m_view, and KisImage::undoAdapter().

endMacro()

void KisNodeCommandsAdapter::endMacro

(

)

Definition at line 69 of file kis_node_commands_adapter.cpp.

{
    Q_ASSERT(m_view->image()->undoAdapter());
    m_view->image()->undoAdapter()->endMacro();
}

References KisUndoAdapter::endMacro(), KisViewManager::image(), m_view, and KisImage::undoAdapter().

moveNode() [1/2]

void KisNodeCommandsAdapter::moveNode	(	KisNodeSP	node,
		KisNodeSP	parent,
		KisNodeSP	aboveThis )

Definition at line 87 of file kis_node_commands_adapter.cpp.

{
    Q_ASSERT(m_view->image()->undoAdapter());
    m_view->image()->undoAdapter()->addCommand(new KisImageLayerMoveCommand(m_view->image(), node, parent, aboveThis));
}

References KisUndoAdapter::addCommand(), KisViewManager::image(), m_view, and KisImage::undoAdapter().

moveNode() [2/2]

void KisNodeCommandsAdapter::moveNode	(	KisNodeSP	node,
		KisNodeSP	parent,
		quint32	indexaboveThis )

Definition at line 93 of file kis_node_commands_adapter.cpp.

{
    Q_ASSERT(m_view->image()->undoAdapter());
    m_view->image()->undoAdapter()->addCommand(new KisImageLayerMoveCommand(m_view->image(), node, parent, indexaboveThis));
}

References KisUndoAdapter::addCommand(), KisViewManager::image(), m_view, and KisImage::undoAdapter().

removeNode()

void KisNodeCommandsAdapter::removeNode

(

KisNodeSP

node

)

Definition at line 99 of file kis_node_commands_adapter.cpp.

{
    Q_ASSERT(m_view->image()->undoAdapter());
    m_view->image()->undoAdapter()->addCommand(new KisImageLayerRemoveCommand(m_view->image(), node));
}

References KisUndoAdapter::addCommand(), KisViewManager::image(), m_view, and KisImage::undoAdapter().

setCompositeOp()

void KisNodeCommandsAdapter::setCompositeOp	(	KisNodeSP	node,
		const KoCompositeOp *	compositeOp )

Definition at line 111 of file kis_node_commands_adapter.cpp.

{
    KUndo2Command *cmd = new KisNodeCompositeOpCommand(node,
                                                       compositeOp->id());
    applyOneCommandAsync(cmd);
}

References applyOneCommandAsync(), and KoCompositeOp::id.

setNodeName()

void KisNodeCommandsAdapter::setNodeName	(	KisNodeSP	node,
		const QString &	name )

Definition at line 119 of file kis_node_commands_adapter.cpp.

{
    KUndo2Command *cmd = new KisNodeRenameCommand(node, node->name(), name);
    applyOneCommandAsync(cmd);
}

References applyOneCommandAsync(), and KisBaseNode::name().

setOpacity()

void KisNodeCommandsAdapter::setOpacity	(	KisNodeSP	node,
		qint32	opacity )

Definition at line 105 of file kis_node_commands_adapter.cpp.

{
    KUndo2Command *cmd = new KisNodeOpacityCommand(node, opacity);
    applyOneCommandAsync(cmd);
}

References applyOneCommandAsync().

undoLastCommand()

void KisNodeCommandsAdapter::undoLastCommand

(

)

Definition at line 125 of file kis_node_commands_adapter.cpp.

{
    Q_ASSERT(m_view->image()->undoAdapter());
    m_view->image()->undoAdapter()->undoLastCommand();
}

References KisViewManager::image(), m_view, KisImage::undoAdapter(), and KisUndoAdapter::undoLastCommand().

Member Data Documentation

m_view

KisViewManager* KisNodeCommandsAdapter::m_view

private

Definition at line 62 of file kis_node_commands_adapter.h.

---

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

• libs/ui/kis_node_commands_adapter.h
• libs/ui/kis_node_commands_adapter.cpp