The undo / redo command for configuring an ellipse shape. More...

#include <EllipseShapeConfigCommand.h>

Inheritance diagram for EllipseShapeConfigCommand:

Public Member Functions
	EllipseShapeConfigCommand (EllipseShape ellipse, EllipseShape::EllipseType type, qreal startAngle, qreal startEndAngle, KUndo2Command parent=0)

int	id () const override

bool	mergeWith (const KUndo2Command *command) override

void	redo () override
	redo the command

void	undo () override
	revert the actions done in redo

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 ()

Private Attributes
EllipseShape *	m_ellipse

qreal	m_newEndAngle

qreal	m_newStartAngle

EllipseShape::EllipseType	m_newType

qreal	m_oldEndAngle

qreal	m_oldStartAngle

EllipseShape::EllipseType	m_oldType

Detailed Description

The undo / redo command for configuring an ellipse shape.

Definition at line 14 of file EllipseShapeConfigCommand.h.

Constructor & Destructor Documentation

◆ EllipseShapeConfigCommand()

EllipseShapeConfigCommand::EllipseShapeConfigCommand	(	EllipseShape *	ellipse,
		EllipseShape::EllipseType	type,
		qreal	startAngle,
		qreal	startEndAngle,
		KUndo2Command *	parent = 0 )

Configures an ellipse shape

Parameters

ellipse	the ellipse shape to configure
type	the ellipse type
startAngle	the start angle
endAngle	the end angle
parent	the optional parent command

Definition at line 11 of file EllipseShapeConfigCommand.cpp.

    : KUndo2Command(parent)
    , m_ellipse(ellipse)
    , m_newType(type)
    , m_newStartAngle(startAngle)
    , m_newEndAngle(endAngle)
{
    Q_ASSERT(m_ellipse);
 
    setText(kundo2_i18n("Change ellipse"));
 
    m_oldType = m_ellipse->type();
    m_oldStartAngle = m_ellipse->startAngle();
    m_oldEndAngle = m_ellipse->endAngle();
}

References EllipseShape::endAngle(), kundo2_i18n(), m_ellipse, m_oldEndAngle, m_oldStartAngle, m_oldType, KUndo2Command::setText(), EllipseShape::startAngle(), and EllipseShape::type().

Member Function Documentation

◆ id()

int EllipseShapeConfigCommand::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 65 of file EllipseShapeConfigCommand.cpp.

{
    return KisCommandUtils::ChangeEllipseShapeId;
}

References KisCommandUtils::ChangeEllipseShapeId.

◆ mergeWith()

bool EllipseShapeConfigCommand::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 69 of file EllipseShapeConfigCommand.cpp.

{
    const EllipseShapeConfigCommand *other = dynamic_cast<const EllipseShapeConfigCommand*>(command);
 
    if (!other || other->m_ellipse != m_ellipse) {
        return false;
    }
 
    m_newType = other->m_newType;
    m_newStartAngle = other->m_newStartAngle;
    m_newEndAngle = other->m_newEndAngle;
 
    return true;
}

References m_ellipse, m_newEndAngle, m_newStartAngle, and m_newType.

◆ redo()

void EllipseShapeConfigCommand::redo ( )

overridevirtual

redo the command

Reimplemented from KUndo2Command.

Definition at line 27 of file EllipseShapeConfigCommand.cpp.

{
    KUndo2Command::redo();
 
    m_ellipse->update();
 
    if (m_oldType != m_newType) {
        m_ellipse->setType(m_newType);
    }
    if (m_oldStartAngle != m_newStartAngle) {
        m_ellipse->setStartAngle(m_newStartAngle);
    }
    if (m_oldEndAngle != m_newEndAngle) {
        m_ellipse->setEndAngle(m_newEndAngle);
    }
 
    m_ellipse->update();
}

References m_ellipse, m_newEndAngle, m_newStartAngle, m_newType, m_oldEndAngle, m_oldStartAngle, m_oldType, KUndo2Command::redo(), EllipseShape::setEndAngle(), EllipseShape::setStartAngle(), EllipseShape::setType(), and KoShapeContainer::update().

◆ undo()

void EllipseShapeConfigCommand::undo ( )

overridevirtual

revert the actions done in redo

Reimplemented from KUndo2Command.

Definition at line 46 of file EllipseShapeConfigCommand.cpp.

{
    KUndo2Command::undo();
 
    m_ellipse->update();
 
    if (m_oldType != m_newType) {
        m_ellipse->setType(m_oldType);
    }
    if (m_oldStartAngle != m_newStartAngle) {
        m_ellipse->setStartAngle(m_oldStartAngle);
    }
    if (m_oldEndAngle != m_newEndAngle) {
        m_ellipse->setEndAngle(m_oldEndAngle);
    }
 
    m_ellipse->update();
}