SvgTextRemoveCommand Class Reference

#include <SvgTextRemoveCommand.h>

Inheritance diagram for SvgTextRemoveCommand:

Public Member Functions
int	id () const override
bool	mergeWith (const KUndo2Command *other) override
void	redo () override
	redo the command
	SvgTextRemoveCommand (KoSvgTextShape *shape, int endIndex, int pos, int anchor, int length, bool allowCleanUp=true, KUndo2Command *parent=0)
	SvgTextRemoveCommand Remove text from shape.
void	undo () override
	revert the actions done in redo
	~SvgTextRemoveCommand () 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
bool	m_allowCleanUp
int	m_anchor
int	m_index
int	m_length
int	m_originalPos
KoSvgTextShape *	m_shape
KoSvgTextShapeMementoSP	m_textData

Detailed Description

Definition at line 16 of file SvgTextRemoveCommand.h.

Constructor & Destructor Documentation

SvgTextRemoveCommand()

SvgTextRemoveCommand::SvgTextRemoveCommand	(	KoSvgTextShape *	shape,
		int	endIndex,
		int	pos,
		int	anchor,
		int	length,
		bool	allowCleanUp = true,
		KUndo2Command *	parent = 0 )

SvgTextRemoveCommand Remove text from shape.

Parameters

shape	– shape to remove text from
endIndex	– end from which to remove.
pos	– pos, only used to reset cursor pos upon undo.
anchor	– anchor, only used to reset cursor pos upon undo.
length	– length to remove from end index
allowCleanUp	– whether to allow cleaning up the text shape data. Should be set false when inserting text directly after.
parent	– parent undo command.

Definition at line 13 of file SvgTextRemoveCommand.cpp.

    : KUndo2Command(parent)
    , m_shape(shape)
    , m_index(endIndex)
    , m_originalPos(pos)
    , m_anchor(anchor)
    , m_length(length)
    , m_allowCleanUp(allowCleanUp)
{
    Q_ASSERT(shape);
    setText(kundo2_i18n("Remove Text"));
}

References kundo2_i18n(), and KUndo2Command::setText().

~SvgTextRemoveCommand()

SvgTextRemoveCommand::~SvgTextRemoveCommand ( )

overridedefault

Member Function Documentation

id()

int SvgTextRemoveCommand::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 57 of file SvgTextRemoveCommand.cpp.

{
    return KisCommandUtils::SvgRemoveTextCommand;
}

References KisCommandUtils::SvgRemoveTextCommand.

mergeWith()

bool SvgTextRemoveCommand::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 62 of file SvgTextRemoveCommand.cpp.

{
    const SvgTextRemoveCommand *command = dynamic_cast<const SvgTextRemoveCommand*>(other);
 
 
    if (!command || command->m_shape != m_shape) {
        return false;
    }
    int oldIndex = m_index;
    int otherOldIndex = command->m_index;
 
    if (oldIndex - m_length == otherOldIndex) {
        m_length += command->m_length;
        return true;
    } else if (otherOldIndex - command->m_length == oldIndex - m_length) {
        return true;
    } else {
        return false;
    }
    return true;
}

References m_index, m_length, and m_shape.

redo()

void SvgTextRemoveCommand::redo ( )

overridevirtual

redo the command

Reimplemented from KUndo2Command.

Definition at line 31 of file SvgTextRemoveCommand.cpp.

{
    QRectF updateRect = m_shape->boundingRect();
 
    m_textData = m_shape->getMemento();
 
    int idx = m_index - m_length;
    m_shape->removeText(idx, m_length);
    m_index = idx + m_length;
 
    if (m_allowCleanUp) {
        m_shape->cleanUp();
    }
    m_shape->updateAbsolute( updateRect| m_shape->boundingRect());
 
    int pos = qMax(0, m_shape->posForIndex(idx, false, false));
    m_shape->notifyCursorPosChanged(pos, pos);
}

References KoSvgTextShape::boundingRect(), KoSvgTextShape::cleanUp(), KoSvgTextShape::getMemento(), m_allowCleanUp, m_index, m_length, m_shape, m_textData, KoSvgTextShape::notifyCursorPosChanged(), KoSvgTextShape::posForIndex(), KoSvgTextShape::removeText(), and KoShape::updateAbsolute().

undo()

void SvgTextRemoveCommand::undo ( )

overridevirtual

revert the actions done in redo

Reimplemented from KUndo2Command.

Definition at line 50 of file SvgTextRemoveCommand.cpp.

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

References KoSvgTextShape::boundingRect(), m_anchor, m_originalPos, m_shape, m_textData, KoSvgTextShape::setMemento(), and KoShape::updateAbsolute().

Member Data Documentation

m_allowCleanUp

bool SvgTextRemoveCommand::m_allowCleanUp

private

Definition at line 53 of file SvgTextRemoveCommand.h.

m_anchor

int SvgTextRemoveCommand::m_anchor

private

Definition at line 51 of file SvgTextRemoveCommand.h.

m_index

int SvgTextRemoveCommand::m_index

private

Definition at line 49 of file SvgTextRemoveCommand.h.

m_length

int SvgTextRemoveCommand::m_length

private

Definition at line 52 of file SvgTextRemoveCommand.h.

m_originalPos

int SvgTextRemoveCommand::m_originalPos

private

Definition at line 50 of file SvgTextRemoveCommand.h.

m_shape

KoSvgTextShape* SvgTextRemoveCommand::m_shape

private

Definition at line 48 of file SvgTextRemoveCommand.h.

m_textData

KoSvgTextShapeMementoSP SvgTextRemoveCommand::m_textData

private

Definition at line 54 of file SvgTextRemoveCommand.h.

---

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

• plugins/tools/svgtexttool/SvgTextRemoveCommand.h
• plugins/tools/svgtexttool/SvgTextRemoveCommand.cpp