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

#include <KoShapeBackgroundCommand.h>

Inheritance diagram for KoShapeBackgroundCommand:

Public Member Functions
void	addNewFill (QSharedPointer< KoShapeBackground > newFill)

void	addOldFill (QSharedPointer< KoShapeBackground > oldFill)

int	id () const override

	KoShapeBackgroundCommand (const QList< KoShape * > &shapes, const QList< QSharedPointer< KoShapeBackground > > &fills, KUndo2Command *parent=0)

	KoShapeBackgroundCommand (const QList< KoShape * > &shapes, QSharedPointer< KoShapeBackground > fill, KUndo2Command *parent=0)

	KoShapeBackgroundCommand (KoShape shape, QSharedPointer< KoShapeBackground > fill, 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

	~KoShapeBackgroundCommand () 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< QSharedPointer< KoShapeBackground > >	newFills

QList< QSharedPointer< KoShapeBackground > >	oldFills

QList< KoShape * >	shapes
	the shapes to set background 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 background.

Definition at line 17 of file KoShapeBackgroundCommand.cpp.

Constructor & Destructor Documentation

◆ ~Private()

KoShapeBackgroundCommand::~Private ( )

inline

Definition at line 22 of file KoShapeBackgroundCommand.cpp.

               {
        oldFills.clear();
        newFills.clear();
    }

◆ KoShapeBackgroundCommand() [1/3]

KoShapeBackgroundCommand::KoShapeBackgroundCommand	(	const QList< KoShape * > &	shapes,
		QSharedPointer< KoShapeBackground >	fill,
		KUndo2Command *	parent = 0 )

Command to set a new shape background.

Parameters

shapes	a set of all the shapes that should get the new background.
fill	the new shape background
parent	the parent command used for macro commands

Definition at line 42 of file KoShapeBackgroundCommand.cpp.

        : KUndo2Command(parent)
        , d(new Private())
{
    d->shapes = shapes;
    Q_FOREACH (KoShape *shape, d->shapes) {
        d->addOldFill(shape->background());
        d->addNewFill(fill);
    }
 
    setText(kundo2_i18n("Set background"));
}

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

◆ KoShapeBackgroundCommand() [2/3]

KoShapeBackgroundCommand::KoShapeBackgroundCommand	(	KoShape *	shape,
		QSharedPointer< KoShapeBackground >	fill,
		KUndo2Command *	parent = 0 )

Command to set a new shape background.

Parameters

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

Definition at line 56 of file KoShapeBackgroundCommand.cpp.

        : KUndo2Command(parent)
        , d(new Private())
{
    d->shapes.append(shape);
    d->addOldFill(shape->background());
    d->addNewFill(fill);
 
    setText(kundo2_i18n("Set background"));
}

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

◆ KoShapeBackgroundCommand() [3/3]

KoShapeBackgroundCommand::KoShapeBackgroundCommand	(	const QList< KoShape * > &	shapes,
		const QList< QSharedPointer< KoShapeBackground > > &	fills,
		KUndo2Command *	parent = 0 )

Command to set new shape backgrounds.

Parameters

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

Definition at line 67 of file KoShapeBackgroundCommand.cpp.

        : KUndo2Command(parent)
        , d(new Private())
{
    d->shapes = shapes;
    Q_FOREACH (KoShape *shape, d->shapes) {
        d->addOldFill(shape->background());
    }
    foreach (QSharedPointer<KoShapeBackground>  fill, fills) {
        d->addNewFill(fill);
    }
 
    setText(kundo2_i18n("Set background"));
}

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

◆ ~KoShapeBackgroundCommand()

KoShapeBackgroundCommand::~KoShapeBackgroundCommand ( )

override

Definition at line 123 of file KoShapeBackgroundCommand.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ addNewFill()

void KoShapeBackgroundCommand::addNewFill ( QSharedPointer< KoShapeBackground > newFill )

inline

Definition at line 32 of file KoShapeBackgroundCommand.cpp.

    {
        newFills.append(newFill);
    }

◆ addOldFill()

void KoShapeBackgroundCommand::addOldFill ( QSharedPointer< KoShapeBackground > oldFill )

inline

Definition at line 27 of file KoShapeBackgroundCommand.cpp.

    {
        oldFills.append(oldFill);
    }

◆ id()

int KoShapeBackgroundCommand::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 104 of file KoShapeBackgroundCommand.cpp.

{
    return KisCommandUtils::ChangeShapeBackgroundId;
}

References KisCommandUtils::ChangeShapeBackgroundId.

◆ mergeWith()

bool KoShapeBackgroundCommand::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 109 of file KoShapeBackgroundCommand.cpp.

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

References d.

◆ Private()

KoShapeBackgroundCommand::Private ( )

inline

Definition at line 20 of file KoShapeBackgroundCommand.cpp.

20 {

21 }

◆ redo()

void KoShapeBackgroundCommand::redo ( )

overridevirtual

redo the command

Reimplemented from KUndo2Command.

Definition at line 82 of file KoShapeBackgroundCommand.cpp.

{
    KUndo2Command::redo();
    QList<QSharedPointer<KoShapeBackground> >::iterator brushIt = d->newFills.begin();
    Q_FOREACH (KoShape *shape, d->shapes) {
        shape->setBackground(*brushIt);
        shape->update();
        ++brushIt;
    }
}

References d, KUndo2Command::redo(), KoShape::setBackground(), and KoShape::update().

◆ undo()

void KoShapeBackgroundCommand::undo ( )

overridevirtual

revert the actions done in redo

Reimplemented from KUndo2Command.

Definition at line 93 of file KoShapeBackgroundCommand.cpp.

{
    KUndo2Command::undo();
    QList<QSharedPointer<KoShapeBackground> >::iterator brushIt = d->oldFills.begin();
    Q_FOREACH (KoShape *shape, d->shapes) {
        shape->setBackground(*brushIt);
        shape->update();
        ++brushIt;
    }
}

References d, KoShape::setBackground(), KUndo2Command::undo(), and KoShape::update().

Member Data Documentation

◆ d

Private* const KoShapeBackgroundCommand::d

private

Definition at line 59 of file KoShapeBackgroundCommand.h.

◆ newFills

QList<QSharedPointer<KoShapeBackground> > KoShapeBackgroundCommand::newFills

Definition at line 39 of file KoShapeBackgroundCommand.cpp.

◆ oldFills

QList<QSharedPointer<KoShapeBackground> > KoShapeBackgroundCommand::oldFills

Definition at line 38 of file KoShapeBackgroundCommand.cpp.

◆ shapes

QList<KoShape*> KoShapeBackgroundCommand::shapes

the shapes to set background for

Definition at line 37 of file KoShapeBackgroundCommand.cpp.

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

libs/flake/commands/KoShapeBackgroundCommand.cpp
libs/flake/commands/KoShapeBackgroundCommand.h

Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~Private()

◆ KoShapeBackgroundCommand() [1/3]

◆ KoShapeBackgroundCommand() [2/3]

◆ KoShapeBackgroundCommand() [3/3]

◆ ~KoShapeBackgroundCommand()

Member Function Documentation

◆ addNewFill()

◆ addOldFill()

◆ id()

◆ mergeWith()

◆ Private()

◆ redo()

◆ undo()

Member Data Documentation

◆ d

◆ newFills

◆ oldFills

◆ shapes