The undo / redo command for shape moving. More...

#include <KoShapeMoveCommand.h>

Inheritance diagram for KoShapeMoveCommand:

Public Member Functions
int	id () const override

	KoShapeMoveCommand (const QList< KoShape * > &shapes, const QPointF &offset, KUndo2Command *parent=0)

	KoShapeMoveCommand (const QList< KoShape * > &shapes, QList< QPointF > &previousPositions, QList< QPointF > &newPositions, KoFlake::AnchorPosition anchor=KoFlake::Center, KUndo2Command *parent=0)

bool	mergeWith (const KUndo2Command *command) override

void	redo () override
	redo the command

void	undo () override
	revert the actions done in redo

	~KoShapeMoveCommand () 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 Attributes
KoFlake::AnchorPosition	anchor

QList< QPointF >	newPositions

QList< QPointF >	previousPositions

QList< KoShape * >	shapes

Private Attributes
Private *const	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

The undo / redo command for shape moving.

Definition at line 15 of file KoShapeMoveCommand.cpp.

Constructor & Destructor Documentation

◆ KoShapeMoveCommand() [1/2]

KoShapeMoveCommand::KoShapeMoveCommand	(	const QList< KoShape * > &	shapes,
		QList< QPointF > &	previousPositions,
		QList< QPointF > &	newPositions,
		KoFlake::AnchorPosition	anchor = KoFlake::Center,
		KUndo2Command *	parent = 0 )

Constructor.

Parameters

shapes	the set of objects that are moved.
previousPositions	the known set of previous positions for each of the objects. this list naturally must have the same amount of items as the shapes set.
newPositions	the new positions for the shapes. this list naturally must have the same amount of items as the shapes set.
parent	the parent command used for macro commands

Definition at line 23 of file KoShapeMoveCommand.cpp.

        : KUndo2Command(kundo2_i18n("Move shapes"), parent),
        d(new Private())
{
    d->shapes = shapes;
    d->previousPositions = previousPositions;
    d->newPositions = newPositions;
    d->anchor = anchor;
    Q_ASSERT(d->shapes.count() == d->previousPositions.count());
    Q_ASSERT(d->shapes.count() == d->newPositions.count());
}

References anchor, d, newPositions, previousPositions, and shapes.

◆ KoShapeMoveCommand() [2/2]

KoShapeMoveCommand::KoShapeMoveCommand	(	const QList< KoShape * > &	shapes,
		const QPointF &	offset,
		KUndo2Command *	parent = 0 )

Definition at line 35 of file KoShapeMoveCommand.cpp.

    : KUndo2Command(kundo2_i18n("Move shapes"), parent),
      d(new Private())
{
    d->shapes = shapes;
    d->anchor = KoFlake::Center;
 
    Q_FOREACH (KoShape *shape, d->shapes) {
        const QPointF pos = shape->absolutePosition();
 
        d->previousPositions << pos;
        d->newPositions << pos + offset;
    }
}

References KoShape::absolutePosition(), KoFlake::Center, d, and shapes.

◆ ~KoShapeMoveCommand()

KoShapeMoveCommand::~KoShapeMoveCommand ( )

override

Definition at line 50 of file KoShapeMoveCommand.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ id()

int KoShapeMoveCommand::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 80 of file KoShapeMoveCommand.cpp.

{
    return KisCommandUtils::MoveShapeId;
}

References KisCommandUtils::MoveShapeId.

◆ mergeWith()

bool KoShapeMoveCommand::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 85 of file KoShapeMoveCommand.cpp.

{
    const KoShapeMoveCommand *other = dynamic_cast<const KoShapeMoveCommand*>(command);
    KIS_ASSERT(other);
 
    if (other->d->shapes != d->shapes ||
        other->d->anchor != d->anchor) {
 
        return false;
    }
 
    d->newPositions = other->d->newPositions;
    return true;
}

References d, and KIS_ASSERT.

◆ redo()

void KoShapeMoveCommand::redo ( )

overridevirtual

redo the command

Reimplemented from KUndo2Command.

Definition at line 55 of file KoShapeMoveCommand.cpp.

{
    KUndo2Command::redo();
 
    for (int i = 0; i < d->shapes.count(); i++) {
        KoShape *shape = d->shapes.at(i);
 
        const QRectF oldDirtyRect = shape->boundingRect();
        shape->setAbsolutePosition(d->newPositions.at(i), d->anchor);
        shape->updateAbsolute(oldDirtyRect | shape->boundingRect());
    }
}

References KoShape::boundingRect(), d, KUndo2Command::redo(), KoShape::setAbsolutePosition(), and KoShape::updateAbsolute().

◆ undo()

void KoShapeMoveCommand::undo ( )

overridevirtual

revert the actions done in redo

Reimplemented from KUndo2Command.

Definition at line 68 of file KoShapeMoveCommand.cpp.

{
    KUndo2Command::undo();
    for (int i = 0; i < d->shapes.count(); i++) {
        KoShape *shape = d->shapes.at(i);
 
        const QRectF oldDirtyRect = shape->boundingRect();
        shape->setAbsolutePosition(d->previousPositions.at(i), d->anchor);
        shape->updateAbsolute(oldDirtyRect | shape->boundingRect());
    }
}

References KoShape::boundingRect(), d, KoShape::setAbsolutePosition(), KUndo2Command::undo(), and KoShape::updateAbsolute().

Member Data Documentation

◆ anchor

KoFlake::AnchorPosition KoShapeMoveCommand::anchor

Definition at line 20 of file KoShapeMoveCommand.cpp.

◆ d

Private* const KoShapeMoveCommand::d

private

Definition at line 49 of file KoShapeMoveCommand.h.

◆ newPositions

QList<QPointF> KoShapeMoveCommand::newPositions

Definition at line 19 of file KoShapeMoveCommand.cpp.

◆ previousPositions

QList<QPointF> KoShapeMoveCommand::previousPositions

Definition at line 19 of file KoShapeMoveCommand.cpp.

◆ shapes

QList<KoShape*> KoShapeMoveCommand::shapes

Definition at line 18 of file KoShapeMoveCommand.cpp.

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

libs/flake/commands/KoShapeMoveCommand.cpp
libs/flake/commands/KoShapeMoveCommand.h

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KoShapeMoveCommand() [1/2]

◆ KoShapeMoveCommand() [2/2]

◆ ~KoShapeMoveCommand()

Member Function Documentation

◆ id()

◆ mergeWith()

◆ redo()

◆ undo()

Member Data Documentation

◆ anchor

◆ d

◆ newPositions

◆ previousPositions

◆ shapes