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

#include <KoPathShapeMarkerCommand.h>

Inheritance diagram for KoPathShapeMarkerCommand:

Public Member Functions
int	id () const override

	KoPathShapeMarkerCommand (const QList< KoPathShape * > &shapes, KoMarker marker, KoFlake::MarkerPosition position, KUndo2Command parent=0)

bool	mergeWith (const KUndo2Command *command) override

void	redo () override

void	undo () override

	~KoPathShapeMarkerCommand () override

Public Member Functions inherited from Private
	Private (KisCanvas2 *c)

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
QExplicitlySharedDataPointer< KoMarker >	marker
	the new marker to set

QList< bool >	oldAutoFillMarkers

QList< QExplicitlySharedDataPointer< KoMarker > >	oldMarkers
	the old markers, one for each shape

KoFlake::MarkerPosition	position

QList< KoPathShape * >	shapes
	the shapes to set marker for

Public Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

The undo / redo command for setting the shape marker.

Definition at line 17 of file KoPathShapeMarkerCommand.cpp.

Constructor & Destructor Documentation

◆ KoPathShapeMarkerCommand()

KoPathShapeMarkerCommand::KoPathShapeMarkerCommand	(	const QList< KoPathShape * > &	shapes,
		KoMarker *	marker,
		KoFlake::MarkerPosition	position,
		KUndo2Command *	parent = 0 )

Command to set a new shape marker.

Parameters

shapes	a set of all the shapes that should get the new marker.
marker	the new marker, the same for all given shapes
position	the position - start or end - of the marker on the shape
parent	the parent command used for macro commands

Definition at line 26 of file KoPathShapeMarkerCommand.cpp.

    : KUndo2Command(kundo2_i18n("Set marker"), parent),
      m_d(new Private)
{
    m_d->shapes = shapes;
    m_d->marker = marker;
    m_d->position = position;
 
    // save old markers
    Q_FOREACH (KoPathShape *shape, m_d->shapes) {
        m_d->oldMarkers.append(QExplicitlySharedDataPointer<KoMarker>(shape->marker(position)));
        m_d->oldAutoFillMarkers.append(shape->autoFillMarkers());
    }
}

References KoPathShape::autoFillMarkers(), m_d, marker, KoPathShape::marker(), position, shapes, and KoShapeContainer::shapes().

◆ ~KoPathShapeMarkerCommand()

KoPathShapeMarkerCommand::~KoPathShapeMarkerCommand ( )

override

Definition at line 41 of file KoPathShapeMarkerCommand.cpp.

42{

43}

Member Function Documentation

◆ id()

int KoPathShapeMarkerCommand::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 74 of file KoPathShapeMarkerCommand.cpp.

{
    return KisCommandUtils::ChangeShapeMarkersId;
}

References KisCommandUtils::ChangeShapeMarkersId.

◆ mergeWith()

bool KoPathShapeMarkerCommand::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 79 of file KoPathShapeMarkerCommand.cpp.

{
    const KoPathShapeMarkerCommand *other = dynamic_cast<const KoPathShapeMarkerCommand*>(command);
 
    if (!other ||
        other->m_d->shapes != m_d->shapes ||
        other->m_d->position != m_d->position) {
 
        return false;
    }
 
    m_d->marker = other->m_d->marker;
    return true;
}

References m_d, and marker.

◆ redo()

void KoPathShapeMarkerCommand::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 45 of file KoPathShapeMarkerCommand.cpp.

{
    KUndo2Command::redo();
    Q_FOREACH (KoPathShape *shape, m_d->shapes) {
        const QRectF oldDirtyRect = shape->boundingRect();
        shape->setMarker(m_d->marker.data(), m_d->position);
 
        // we have no GUI for selection auto-filling yet! So just enable it!
        shape->setAutoFillMarkers(true);
 
        shape->updateAbsolute(oldDirtyRect | shape->boundingRect());
    }
}

References KoPathShape::boundingRect(), m_d, KUndo2Command::redo(), KoPathShape::setAutoFillMarkers(), KoPathShape::setMarker(), KoShapeContainer::shapes(), and KoShape::updateAbsolute().

◆ undo()

void KoPathShapeMarkerCommand::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 59 of file KoPathShapeMarkerCommand.cpp.

{
    KUndo2Command::undo();
    auto markerIt = m_d->oldMarkers.begin();
    auto autoFillIt = m_d->oldAutoFillMarkers.begin();
    Q_FOREACH (KoPathShape *shape, m_d->shapes) {
        const QRectF oldDirtyRect = shape->boundingRect();
        shape->setMarker((*markerIt).data(), m_d->position);
        shape->setAutoFillMarkers(*autoFillIt);
        shape->updateAbsolute(oldDirtyRect | shape->boundingRect());
        ++markerIt;
        ++autoFillIt;
    }
}