The undo / redo command for setting the shape stroke. More...

#include <KoShapeStrokeCommand.h>

Inheritance diagram for KoShapeStrokeCommand:

Public Member Functions
void	addNewStroke (KoShapeStrokeModelSP newStroke)

void	addOldStroke (KoShapeStrokeModelSP oldStroke)

int	id () const override

	KoShapeStrokeCommand (const QList< KoShape * > &shapes, const QList< KoShapeStrokeModelSP > &strokes, KUndo2Command *parent=0)

	KoShapeStrokeCommand (const QList< KoShape * > &shapes, KoShapeStrokeModelSP stroke, KUndo2Command *parent=0)

	KoShapeStrokeCommand (KoShape shape, KoShapeStrokeModelSP stroke, KUndo2Command parent=0)

bool	mergeWith (const KUndo2Command *command) override

	Private ()

void	redo () override
	redo the command

void	undo () override
	revert the actions done in redo

	~KoShapeStrokeCommand () override

	~Private ()

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
QList< KoShapeStrokeModelSP >	newStrokes
	the new strokes to set

QList< KoShapeStrokeModelSP >	oldStrokes
	the old strokes, one for each shape

QList< KoShape * >	shapes
	the shapes to set stroke for

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 setting the shape stroke.

Definition at line 19 of file KoShapeStrokeCommand.cpp.

Constructor & Destructor Documentation

◆ ~Private()

KoShapeStrokeCommand::~Private ( )

inline

Definition at line 23 of file KoShapeStrokeCommand.cpp.

24 {

25 }

◆ KoShapeStrokeCommand() [1/3]

KoShapeStrokeCommand::KoShapeStrokeCommand	(	const QList< KoShape * > &	shapes,
		KoShapeStrokeModelSP	stroke,
		KUndo2Command *	parent = 0 )

Command to set a new shape stroke.

Parameters

shapes	a set of all the shapes that should get the new stroke.
stroke	the new stroke, the same for all given shapes
parent	the parent command used for macro commands

Definition at line 42 of file KoShapeStrokeCommand.cpp.

    : KUndo2Command(parent)
    , d(new Private())
{
    d->shapes = shapes;
 
    // save old strokes
    Q_FOREACH (KoShape *shape, d->shapes) {
        d->addOldStroke(shape->stroke());
        d->addNewStroke(stroke);
    }
 
    setText(kundo2_i18n("Set stroke"));
}

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

◆ KoShapeStrokeCommand() [2/3]

KoShapeStrokeCommand::KoShapeStrokeCommand	(	const QList< KoShape * > &	shapes,
		const QList< KoShapeStrokeModelSP > &	strokes,
		KUndo2Command *	parent = 0 )

Command to set new shape strokes.

Parameters

shapes	a set of all the shapes that should get a new stroke.
strokes	the new strokes, one for each shape
parent	the parent command used for macro commands

Definition at line 57 of file KoShapeStrokeCommand.cpp.

        : KUndo2Command(parent)
        , d(new Private())
{
    Q_ASSERT(shapes.count() == strokes.count());
 
    d->shapes = shapes;
 
    // save old strokes
    Q_FOREACH (KoShape *shape, shapes)
        d->addOldStroke(shape->stroke());
    foreach (KoShapeStrokeModelSP stroke, strokes)
        d->addNewStroke(stroke);
 
    setText(kundo2_i18n("Set stroke"));
}

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

◆ KoShapeStrokeCommand() [3/3]

KoShapeStrokeCommand::KoShapeStrokeCommand	(	KoShape *	shape,
		KoShapeStrokeModelSP	stroke,
		KUndo2Command *	parent = 0 )

Command to set a new shape stroke.

Parameters

shape	a single shape that should get the new stroke.
stroke	the new stroke
parent	the parent command used for macro commands

Definition at line 76 of file KoShapeStrokeCommand.cpp.

        : KUndo2Command(parent)
        , d(new Private())
{
    d->shapes.append(shape);
    d->addNewStroke(stroke);
    d->addOldStroke(shape->stroke());
 
    setText(kundo2_i18n("Set stroke"));
}

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

◆ ~KoShapeStrokeCommand()

KoShapeStrokeCommand::~KoShapeStrokeCommand ( )

override

Definition at line 87 of file KoShapeStrokeCommand.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ addNewStroke()

void KoShapeStrokeCommand::addNewStroke ( KoShapeStrokeModelSP newStroke )

inline

Definition at line 32 of file KoShapeStrokeCommand.cpp.

    {
        newStrokes.append(newStroke);
    }

◆ addOldStroke()

void KoShapeStrokeCommand::addOldStroke ( KoShapeStrokeModelSP oldStroke )

inline

Definition at line 27 of file KoShapeStrokeCommand.cpp.

    {
        oldStrokes.append(oldStroke);
    }

◆ id()

int KoShapeStrokeCommand::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 116 of file KoShapeStrokeCommand.cpp.

{
    return KisCommandUtils::ChangeShapeStrokeId;
}

References KisCommandUtils::ChangeShapeStrokeId.

◆ mergeWith()

bool KoShapeStrokeCommand::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 121 of file KoShapeStrokeCommand.cpp.

{
    const KoShapeStrokeCommand *other = dynamic_cast<const KoShapeStrokeCommand*>(command);
 
    if (!other ||
        other->d->shapes != d->shapes) {
 
        return false;
    }
 
    d->newStrokes = other->d->newStrokes;
    return true;
}

References d.

◆ Private()

KoShapeStrokeCommand::Private ( )

inline

Definition at line 22 of file KoShapeStrokeCommand.cpp.

22{}

◆ redo()

void KoShapeStrokeCommand::redo ( )

overridevirtual

redo the command

Reimplemented from KUndo2Command.

Definition at line 92 of file KoShapeStrokeCommand.cpp.

{
    KUndo2Command::redo();
    QList<KoShapeStrokeModelSP>::iterator strokeIt = d->newStrokes.begin();
    Q_FOREACH (KoShape *shape, d->shapes) {
        const QRectF oldDirtyRect = shape->boundingRect();
        shape->setStroke(*strokeIt);
        shape->updateAbsolute(oldDirtyRect | shape->boundingRect());
        ++strokeIt;
    }
}

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

◆ undo()

void KoShapeStrokeCommand::undo ( )

overridevirtual

revert the actions done in redo

Reimplemented from KUndo2Command.

Definition at line 104 of file KoShapeStrokeCommand.cpp.

{
    KUndo2Command::undo();
    QList<KoShapeStrokeModelSP>::iterator strokeIt = d->oldStrokes.begin();
    Q_FOREACH (KoShape *shape, d->shapes) {
        const QRectF oldDirtyRect = shape->boundingRect();
        shape->setStroke(*strokeIt);
        shape->updateAbsolute(oldDirtyRect | shape->boundingRect());
        ++strokeIt;
    }
}

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

Member Data Documentation

◆ d

Private* const KoShapeStrokeCommand::d

private

Definition at line 61 of file KoShapeStrokeCommand.h.

◆ newStrokes

QList<KoShapeStrokeModelSP> KoShapeStrokeCommand::newStrokes

the new strokes to set

Definition at line 39 of file KoShapeStrokeCommand.cpp.

◆ oldStrokes

QList<KoShapeStrokeModelSP> KoShapeStrokeCommand::oldStrokes

the old strokes, one for each shape

Definition at line 38 of file KoShapeStrokeCommand.cpp.

◆ shapes

QList<KoShape*> KoShapeStrokeCommand::shapes

the shapes to set stroke for

Definition at line 37 of file KoShapeStrokeCommand.cpp.

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

libs/flake/commands/KoShapeStrokeCommand.cpp
libs/flake/commands/KoShapeStrokeCommand.h

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~Private()

◆ KoShapeStrokeCommand() [1/3]

◆ KoShapeStrokeCommand() [2/3]

◆ KoShapeStrokeCommand() [3/3]

◆ ~KoShapeStrokeCommand()

Member Function Documentation

◆ addNewStroke()

◆ addOldStroke()

◆ id()

◆ mergeWith()

◆ Private()

◆ redo()

◆ undo()

Member Data Documentation

◆ d

◆ newStrokes

◆ oldStrokes

◆ shapes