KoShapeGroupCommand Class Reference

The undo / redo command for grouping shapes. More...

#include <KoShapeGroupCommand.h>

Inheritance diagram for KoShapeGroupCommand:

Public Member Functions
	KoShapeGroupCommand (KoShapeContainer *container, const QList< KoShape * > &shapes, bool shouldNormalize, KUndo2Command *parent=0)
	KoShapeGroupCommand (KoShapeContainer *container, const QList< KoShape * > &shapes, KUndo2Command *parent=0)
void	redo () override
	redo the command
void	undo () override
	revert the actions done in redo
	~KoShapeGroupCommand () 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 ()

Static Public Member Functions
static KoShapeGroupCommand *	createCommand (KoShapeContainer *container, const QList< KoShape * > &shapes, bool shouldNormalize=false)

Protected Attributes
const QScopedPointer< KoShapeGroupCommandPrivate >	d

Detailed Description

The undo / redo command for grouping shapes.

Definition at line 23 of file KoShapeGroupCommand.h.

Constructor & Destructor Documentation

KoShapeGroupCommand() [1/2]

KoShapeGroupCommand::KoShapeGroupCommand	(	KoShapeContainer *	container,
		const QList< KoShape * > &	shapes,
		bool	shouldNormalize,
		KUndo2Command *	parent = 0 )

Command to group a set of shapes into a predefined container.

Parameters

container	the container to group the shapes under.
shapes	a list of all the shapes that should be grouped.
shouldNormalize	shows whether the shapes should be normalized by the container
parent	the parent command used for macro commands

Definition at line 57 of file KoShapeGroupCommand.cpp.

    : KUndo2Command(parent),
      d(new KoShapeGroupCommandPrivate(container, shapes, shouldNormalize))
{
    Q_FOREACH (KoShape* shape, d->shapes) {
        d->oldParents.append(shape->parent());
    }
 
    if (d->container->shapes().isEmpty()) {
        setText(kundo2_i18n("Group shapes"));
    } else {
        setText(kundo2_i18n("Add shapes to group"));
    }
}

References d, kundo2_i18n(), KoShape::parent(), and KUndo2Command::setText().

KoShapeGroupCommand() [2/2]

KoShapeGroupCommand::KoShapeGroupCommand	(	KoShapeContainer *	container,
		const QList< KoShape * > &	shapes,
		KUndo2Command *	parent = 0 )

Command to group a set of shapes into a predefined container. Convenience constructor since KoShapeGroup does not allow clipping.

Parameters

container	the group to group the shapes under.
parent	the parent command if the resulting command is a compound undo command.
shapes	a list of all the shapes that should be grouped.

Definition at line 52 of file KoShapeGroupCommand.cpp.

    : KoShapeGroupCommand(container, shapes, false, parent)
{
}

~KoShapeGroupCommand()

KoShapeGroupCommand::~KoShapeGroupCommand ( )

override

Definition at line 73 of file KoShapeGroupCommand.cpp.

{
}

Member Function Documentation

createCommand()

KoShapeGroupCommand * KoShapeGroupCommand::createCommand ( KoShapeContainer * container, const QList< KoShape * > & shapes, bool shouldNormalize = false )

static

Create command to group a set of shapes into a predefined container. This uses the KoShapeGroupCommand(KoShapeGroup *container, const QList<KoShape *> &shapes, KUndo2Command *parent = 0); constructor. The createCommand will make sure that the group will have the z-index and the parent of the top most shape in the group.

Parameters

container	the group to group the shapes under.
shapes	a list of all the shapes that should be grouped.
shouldNormalize	whether the shapes should be normalized

Definition at line 18 of file KoShapeGroupCommand.cpp.

{
    QList<KoShape*> orderedShapes(shapes);
    if (!orderedShapes.isEmpty()) {
        KoShape * top = orderedShapes.last();
        container->setParent(top->parent());
        container->setZIndex(top->zIndex());
    }
 
    return new KoShapeGroupCommand(container, orderedShapes, shouldNormalize, 0);
}

References KoShapeGroupCommand(), KoShape::parent(), KoShape::setParent(), KoShape::setZIndex(), and KoShape::zIndex().

redo()

void KoShapeGroupCommand::redo ( )

overridevirtual

redo the command

Reimplemented from KUndo2Command.

Definition at line 77 of file KoShapeGroupCommand.cpp.

{
    KUndo2Command::redo();
 
    if (d->shouldNormalize &&  dynamic_cast<KoShapeGroup*>(d->container)) {
        QRectF bound = d->containerBoundingRect();
        QPointF oldGroupPosition = d->container->absolutePosition(KoFlake::TopLeft);
        d->container->setAbsolutePosition(bound.topLeft(), KoFlake::TopLeft);
        d->container->setSize(bound.size());
 
        if (d->container->shapeCount() > 0) {
            // the group has changed position and so have the group child shapes
            // -> we need compensate the group position change
            QPointF positionOffset = oldGroupPosition - bound.topLeft();
            Q_FOREACH (KoShape * child, d->container->shapes())
                child->setAbsolutePosition(child->absolutePosition() + positionOffset);
        }
    }
 
    QTransform groupTransform = d->container->absoluteTransformation().inverted();
 
    QList<KoShape*> containerShapes(d->container->shapes());
    std::stable_sort(containerShapes.begin(), containerShapes.end(), KoShape::compareShapeZIndex);
 
    QList<KoShapeReorderCommand::IndexedShape> indexedShapes;
    Q_FOREACH (KoShape *shape, containerShapes) {
        indexedShapes.append(KoShapeReorderCommand::IndexedShape(shape));
    }
 
    QList<KoShapeReorderCommand::IndexedShape> prependIndexedShapes;
 
    Q_FOREACH (KoShape *shape, d->shapes) {
        // test if they inherit the same parent
 
        if (!shape->hasCommonParent(d->container) ||
            !KoShape::compareShapeZIndex(shape, d->container)) {
 
            indexedShapes.append(KoShapeReorderCommand::IndexedShape(shape));
        } else {
            prependIndexedShapes.append(KoShapeReorderCommand::IndexedShape(shape));
        }
    }
 
    indexedShapes = prependIndexedShapes + indexedShapes;
    indexedShapes = KoShapeReorderCommand::homogenizeZIndexesLazy(indexedShapes);
 
    if (!indexedShapes.isEmpty()) {
        d->shapesReorderCommand.reset(new KoShapeReorderCommand(indexedShapes));
        d->shapesReorderCommand->redo();
    }
 
    uint shapeCount = d->shapes.count();
    for (uint i = 0; i < shapeCount; ++i) {
        KoShape * shape = d->shapes[i];
 
        shape->applyAbsoluteTransformation(groupTransform);
        d->container->addShape(shape);
    }
 
 
}

References KoShape::applyAbsoluteTransformation(), KUndo2Command::child(), KoShape::compareShapeZIndex(), d, KoShape::hasCommonParent(), KoShapeReorderCommand::homogenizeZIndexesLazy(), KUndo2Command::redo(), and KoFlake::TopLeft.

undo()

void KoShapeGroupCommand::undo ( )

overridevirtual

revert the actions done in redo

Reimplemented from KUndo2Command.

Definition at line 139 of file KoShapeGroupCommand.cpp.

{
    KUndo2Command::undo();
 
    QTransform ungroupTransform = d->container->absoluteTransformation();
    for (int i = 0; i < d->shapes.count(); i++) {
        KoShape * shape = d->shapes[i];
        d->container->removeShape(shape);
        if (d->oldParents.at(i)) {
            d->oldParents.at(i)->addShape(shape);
        }
        shape->applyAbsoluteTransformation(ungroupTransform);
    }
 
    if (d->shapesReorderCommand) {
        d->shapesReorderCommand->undo();
        d->shapesReorderCommand.reset();
    }
 
    if (d->shouldNormalize && dynamic_cast<KoShapeGroup*>(d->container)) {
        QPointF oldGroupPosition = d->container->absolutePosition(KoFlake::TopLeft);
        if (d->container->shapeCount() > 0) {
            bool boundingRectInitialized = false;
            QRectF bound;
            Q_FOREACH (KoShape * shape, d->container->shapes()) {
                if (! boundingRectInitialized) {
                    bound = shape->boundingRect();
                    boundingRectInitialized = true;
                } else
                    bound = bound.united(shape->boundingRect());
            }
            // the group has changed position and so have the group child shapes
            // -> we need compensate the group position change
            QPointF positionOffset = oldGroupPosition - bound.topLeft();
            Q_FOREACH (KoShape * child, d->container->shapes())
                child->setAbsolutePosition(child->absolutePosition() + positionOffset);
 
            d->container->setAbsolutePosition(bound.topLeft(), KoFlake::TopLeft);
            d->container->setSize(bound.size());
        }
    }
}

References KoShape::applyAbsoluteTransformation(), KoShape::boundingRect(), KUndo2Command::child(), d, KoFlake::TopLeft, and KUndo2Command::undo().

Member Data Documentation

d

const QScopedPointer<KoShapeGroupCommandPrivate> KoShapeGroupCommand::d

protected

Definition at line 64 of file KoShapeGroupCommand.h.

---

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

• libs/flake/commands/KoShapeGroupCommand.h
• libs/flake/commands/KoShapeGroupCommand.cpp