KisChangeGuidesCommand Class Reference

#include <kis_change_guides_command.h>

Inheritance diagram for KisChangeGuidesCommand:

Classes
struct	Private

Public Member Functions
int	id () const override
	KisChangeGuidesCommand (KisDocument *doc, const KisGuidesConfig &oldGuides, const KisGuidesConfig &newGuides)
void	redo () override
void	undo () override
	~KisChangeGuidesCommand () override
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 bool	mergeWith (const KUndo2Command *other)
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
const QScopedPointer< Private >	m_d

Detailed Description

Definition at line 18 of file kis_change_guides_command.h.

Constructor & Destructor Documentation

KisChangeGuidesCommand()

KisChangeGuidesCommand::KisChangeGuidesCommand	(	KisDocument *	doc,
		const KisGuidesConfig &	oldGuides,
		const KisGuidesConfig &	newGuides )

Definition at line 103 of file kis_change_guides_command.cpp.

    : KUndo2Command(kundo2_i18n("Edit Guides")),
      m_d(new Private(doc, this))
{
    m_d->oldGuides = oldGuides;
    m_d->newGuides = newGuides;
    // update the undo command text
    m_d->sameOrOnlyMovedOneGuideBetween(m_d->oldGuides, m_d->newGuides);
}

References m_d.

~KisChangeGuidesCommand()

KisChangeGuidesCommand::~KisChangeGuidesCommand ( )

override

Definition at line 113 of file kis_change_guides_command.cpp.

{
}

Member Function Documentation

id()

int KisChangeGuidesCommand::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 131 of file kis_change_guides_command.cpp.

{
    return 1863;
}

redo()

void KisChangeGuidesCommand::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 122 of file kis_change_guides_command.cpp.

{
    if (m_d->firstRedo) {
        m_d->firstRedo = false;
        return;
    }
    m_d->switchTo(m_d->newGuides);
}

References m_d.

undo()

void KisChangeGuidesCommand::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 117 of file kis_change_guides_command.cpp.

{
    m_d->switchTo(m_d->oldGuides);
}

References m_d.

Member Data Documentation

m_d

const QScopedPointer<Private> KisChangeGuidesCommand::m_d

private

Definition at line 31 of file kis_change_guides_command.h.

---

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

• libs/ui/canvas/kis_change_guides_command.h
• libs/ui/canvas/kis_change_guides_command.cpp