The command for setting the node's name. More...

#include <KisNodeRenameCommand.h>

Inheritance diagram for KisNodeRenameCommand:

Public Member Functions
bool	canMergeWith (const KUndo2Command *command) const override

int	id () const override

	KisNodeRenameCommand (KisNodeSP node, const QString &oldName, const QString &newName)

bool	mergeWith (const KUndo2Command *command) override

void	redo () override

void	undo () override

Public Member Functions inherited from KisNodeCommand
	KisNodeCommand (const KUndo2MagicString &name, KisNodeSP node)

	~KisNodeCommand () 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 bool	isMerged () const

	KUndo2Command (const KUndo2MagicString &text, KUndo2Command *parent=0)

	KUndo2Command (KUndo2Command *parent=0)

virtual QVector< KUndo2Command * >	mergeCommandsVector () const

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 ()

Public Member Functions inherited from KisAsynchronouslyMergeableCommandInterface
virtual	~KisAsynchronouslyMergeableCommandInterface ()

Private Attributes
QString	m_newName

QString	m_oldName

Additional Inherited Members
Protected Attributes inherited from KisNodeCommand
KisNodeSP	m_node

Detailed Description

The command for setting the node's name.

Definition at line 13 of file KisNodeRenameCommand.h.

Constructor & Destructor Documentation

◆ KisNodeRenameCommand()

KisNodeRenameCommand::KisNodeRenameCommand	(	KisNodeSP	node,
		const QString &	oldName,
		const QString &	newName )

Definition at line 14 of file KisNodeRenameCommand.cpp.

    : KisNodeCommand(kundo2_i18n("Node Rename"), node)
{
    m_oldName = oldName;
    m_newName = newName;
}

References m_newName, and m_oldName.

Member Function Documentation

◆ canMergeWith()

bool KisNodeRenameCommand::canMergeWith ( const KUndo2Command * command ) const

overridevirtual

Returns: true if command can be merged with (*this) command using KUndo2Command::mergeWith() call.

WARNING: if canMergeWith() returned true, then mergeWith() must also return true. Otherwise KisSavedMacroCommand will be able to enter inconsistent state and assert.

Implements KisAsynchronouslyMergeableCommandInterface.

Definition at line 50 of file KisNodeRenameCommand.cpp.

{
    const KisNodeRenameCommand *other =
        dynamic_cast<const KisNodeRenameCommand*>(command);
 
    return other && other->m_node == m_node;
}

References KisNodeCommand::m_node.

◆ id()

int KisNodeRenameCommand::id ( ) const

overridevirtual

Returns the ID of this command.

A command ID is used in command compression. It must be an integer unique to this command's class, or -1 if the command doesn't support compression.

If the command supports compression this function must be overridden in the derived class to return the correct ID. The base implementation returns -1.

KUndo2QStack::push() will only try to merge two commands if they have the same ID, and the ID is not -1.

See also: mergeWith(), KUndo2QStack::push()

Reimplemented from KUndo2Command.

Definition at line 31 of file KisNodeRenameCommand.cpp.

{
    return KisCommandUtils::ChangeNodeNameId;
}

References KisCommandUtils::ChangeNodeNameId.

◆ mergeWith()

bool KisNodeRenameCommand::mergeWith ( const KUndo2Command * command )

overridevirtual

Attempts to merge this command with command. Returns true on success; otherwise returns false.

If this function returns true, calling this command's redo() must have the same effect as redoing both this command and command. Similarly, calling this command's undo() must have the same effect as undoing command and this command.

KUndo2QStack will only try to merge two commands if they have the same id, and the id is not -1.

The default implementation returns false.

See also: id() KUndo2QStack::push()

Reimplemented from KUndo2Command.

Definition at line 36 of file KisNodeRenameCommand.cpp.

{
    const KisNodeRenameCommand *other =
        dynamic_cast<const KisNodeRenameCommand*>(command);
 
    if (other && other->m_node == m_node) {
        KIS_SAFE_ASSERT_RECOVER_NOOP(m_newName == other->m_oldName);
        m_newName = other->m_newName;
        return true;
    }
 
    return false;
}

References KIS_SAFE_ASSERT_RECOVER_NOOP, m_newName, KisNodeCommand::m_node, and m_oldName.

◆ redo()

void KisNodeRenameCommand::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 21 of file KisNodeRenameCommand.cpp.

{
    m_node->setName(m_newName);
}

References m_newName, KisNodeCommand::m_node, and KisBaseNode::setName().

◆ undo()

void KisNodeRenameCommand::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 26 of file KisNodeRenameCommand.cpp.

{
    m_node->setName(m_oldName);
}

References KisNodeCommand::m_node, m_oldName, and KisBaseNode::setName().

Member Data Documentation

◆ m_newName

QString KisNodeRenameCommand::m_newName

private

Definition at line 30 of file KisNodeRenameCommand.h.

◆ m_oldName

QString KisNodeRenameCommand::m_oldName

private

Definition at line 29 of file KisNodeRenameCommand.h.

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

libs/image/commands/KisNodeRenameCommand.h
libs/image/commands/KisNodeRenameCommand.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisNodeRenameCommand()

Member Function Documentation

◆ canMergeWith()

◆ id()

◆ mergeWith()

◆ redo()

◆ undo()

Member Data Documentation

◆ m_newName

◆ m_oldName