The SvgTextMergePropertiesRangeCommand class This sets properties on a specific range in a single text shape. More...

#include <SvgTextMergePropertiesRangeCommand.h>

Inheritance diagram for SvgTextMergePropertiesRangeCommand:

Public Member Functions
int	id () const override

bool	mergeWith (const KUndo2Command *other) override

void	redo () override

	SvgTextMergePropertiesRangeCommand (KoSvgTextShape shape, const KoSvgTextProperties props, const int pos, const int anchor, const QSet< KoSvgTextProperties::PropertyId > removeProperties=QSet< KoSvgTextProperties::PropertyId >(), KUndo2Command parent=0)

void	undo () override

	~SvgTextMergePropertiesRangeCommand () override=default

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
int	m_anchor

int	m_endIndex

int	m_pos

KoSvgTextProperties	m_props

QSet< KoSvgTextProperties::PropertyId >	m_removeProperties

KoSvgTextShape *	m_shape

int	m_startIndex

KoSvgTextShapeMementoSP	m_textData

Detailed Description

The SvgTextMergePropertiesRangeCommand class This sets properties on a specific range in a single text shape.

For setting text on multiple shapes, see KoShapeMergeTextPropertiesCommand

Definition at line 24 of file SvgTextMergePropertiesRangeCommand.h.

Constructor & Destructor Documentation

◆ SvgTextMergePropertiesRangeCommand()

SvgTextMergePropertiesRangeCommand::SvgTextMergePropertiesRangeCommand	(	KoSvgTextShape *	shape,
		const KoSvgTextProperties	props,
		const int	pos,
		const int	anchor,
		const QSet< KoSvgTextProperties::PropertyId >	removeProperties = QSet<KoSvgTextProperties::PropertyId>(),
		KUndo2Command *	parent = 0 )

Definition at line 11 of file SvgTextMergePropertiesRangeCommand.cpp.

    : KUndo2Command(parent)
    , m_shape(shape)
    , m_props(props)
    , m_removeProperties(removeProperties)
    , m_pos(pos)
    , m_anchor(anchor)
    , m_textData(m_shape->getMemento())
{
    setText(kundo2_i18n("Change Text Properties"));
 
    // Some properties may change cursor pos count, so we need the indices.
    m_startIndex = m_shape->indexForPos(qMin(pos, anchor));
    m_endIndex = m_shape->indexForPos(qMax(pos, anchor));
}

References KoSvgTextShape::indexForPos(), kundo2_i18n(), m_endIndex, m_shape, m_startIndex, and KUndo2Command::setText().

◆ ~SvgTextMergePropertiesRangeCommand()

SvgTextMergePropertiesRangeCommand::~SvgTextMergePropertiesRangeCommand ( )

overridedefault

Member Function Documentation

◆ id()

int SvgTextMergePropertiesRangeCommand::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 48 of file SvgTextMergePropertiesRangeCommand.cpp.

{
    return KisCommandUtils::SvgTextMergePropertiesRangeCommand;
}

References KisCommandUtils::SvgTextMergePropertiesRangeCommand.

◆ mergeWith()

bool SvgTextMergePropertiesRangeCommand::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()

The merging algorithm should follow the ordering of KoSvgTextShape::mergePropertiesIntoRange, that is, firstly, the properties in removeProperties list are removed, then properties in properties are applied. If the property is present in both lists, then the value from properties is used.

Reimplemented from KUndo2Command.

Definition at line 53 of file SvgTextMergePropertiesRangeCommand.cpp.

{
    const SvgTextMergePropertiesRangeCommand *command = dynamic_cast<const SvgTextMergePropertiesRangeCommand*>(other);
 
    if (!command || command->m_shape != m_shape || m_startIndex != command->m_startIndex || m_endIndex != command->m_endIndex) {
        return false;
    }
 
    Q_FOREACH(KoSvgTextProperties::PropertyId p, command->m_removeProperties) {
        m_props.removeProperty(p);
        m_removeProperties.insert(p);
    }
 
    Q_FOREACH(KoSvgTextProperties::PropertyId p, command->m_props.properties()) {
        m_props.setProperty(p, command->m_props.property(p));
        m_removeProperties.remove(p);
    }
 
    return true;
}

References m_endIndex, m_props, m_removeProperties, m_shape, m_startIndex, p, KoSvgTextProperties::properties(), KoSvgTextProperties::property(), KoSvgTextProperties::removeProperty(), and KoSvgTextProperties::setProperty().

◆ redo()

void SvgTextMergePropertiesRangeCommand::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 32 of file SvgTextMergePropertiesRangeCommand.cpp.

{
    QRectF updateRect = m_shape->boundingRect();
    m_shape->mergePropertiesIntoRange(qMin(m_pos, m_anchor), qMax(m_pos, m_anchor), m_props, m_removeProperties);
    m_shape->updateAbsolute( updateRect| m_shape->boundingRect());
 
    m_shape->notifyMarkupChanged();
}

References KoSvgTextShape::boundingRect(), m_anchor, m_pos, m_props, m_removeProperties, m_shape, KoSvgTextShape::mergePropertiesIntoRange(), KoSvgTextShape::notifyMarkupChanged(), and KoShape::updateAbsolute().

◆ undo()

void SvgTextMergePropertiesRangeCommand::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 41 of file SvgTextMergePropertiesRangeCommand.cpp.

{
    QRectF updateRect = m_shape->boundingRect();
    m_shape->setMemento(m_textData, m_pos, m_anchor);
    m_shape->updateAbsolute( updateRect| m_shape->boundingRect());
}