EditAssistantsCommand Class Reference

#include <EditAssistantsCommand.h>

Inheritance diagram for EditAssistantsCommand:

Public Types
enum	Type { ADD = -1 , REMOVE = 1 , EDIT = 0 }

Public Member Functions
	EditAssistantsCommand (QPointer< KisCanvas2 > canvas, AssistantSPList origAssistants, AssistantSPList newAssistants, KUndo2Command *parent=0)
	EditAssistantsCommand (QPointer< KisCanvas2 > canvas, AssistantSPList origAssistants, AssistantSPList newAssistants, Type type, int index, KUndo2Command *parent=0)
void	redo () override
void	undo () 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 int	id () 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 Types
using	AssistantSPList = QList<KisPaintingAssistantSP>

Private Member Functions
void	replaceWith (AssistantSPList assistants, Type type=EDIT)

Private Attributes
QPointer< KisCanvas2 >	m_canvas
bool	m_firstRedo
int	m_index
AssistantSPList	m_newAssistants
AssistantSPList	m_origAssistants
Type	m_type

Detailed Description

Definition at line 14 of file EditAssistantsCommand.h.

Member Typedef Documentation

AssistantSPList

using EditAssistantsCommand::AssistantSPList = QList<KisPaintingAssistantSP>

private

Definition at line 16 of file EditAssistantsCommand.h.

Member Enumeration Documentation

Type

enum EditAssistantsCommand::Type

Enumerator
ADD
REMOVE
EDIT

Definition at line 18 of file EditAssistantsCommand.h.

              {
        ADD = -1,
        REMOVE = 1,
        EDIT = 0
    };

Constructor & Destructor Documentation

EditAssistantsCommand() [1/2]

EditAssistantsCommand::EditAssistantsCommand	(	QPointer< KisCanvas2 >	canvas,
		AssistantSPList	origAssistants,
		AssistantSPList	newAssistants,
		KUndo2Command *	parent = 0 )

Definition at line 17 of file EditAssistantsCommand.cpp.

    : KUndo2Command(kundo2_i18n("Edit Assistants"), parent)
    , m_canvas(canvas)
    , m_origAssistants(origAssistants)
    , m_newAssistants(newAssistants)
    , m_index(-1)
    , m_firstRedo(true)
    , m_type(EDIT)
{
}

EditAssistantsCommand() [2/2]

EditAssistantsCommand::EditAssistantsCommand	(	QPointer< KisCanvas2 >	canvas,
		AssistantSPList	origAssistants,
		AssistantSPList	newAssistants,
		Type	type,
		int	index,
		KUndo2Command *	parent = 0 )

Definition at line 28 of file EditAssistantsCommand.cpp.

    : KUndo2Command((type == ADD ? kundo2_i18n("Add Assistant") : kundo2_i18n("Remove Assistant")), parent)
    , m_canvas(canvas)
    , m_origAssistants(origAssistants)
    , m_newAssistants(newAssistants)
    , m_index(index)
    , m_firstRedo(true)
    , m_type(type)
{
    Q_UNUSED(m_index);
    KIS_ASSERT_RECOVER_RETURN(type != EDIT);
}

References EDIT, KIS_ASSERT_RECOVER_RETURN, and m_index.

Member Function Documentation

redo()

void EditAssistantsCommand::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 61 of file EditAssistantsCommand.cpp.

{
    // this is a post-execution command
    if (m_firstRedo) {
        m_firstRedo = false;
        return;
    }
    replaceWith(m_newAssistants, m_type);
}

References m_firstRedo, m_newAssistants, m_type, and replaceWith().

replaceWith()

void EditAssistantsCommand::replaceWith ( AssistantSPList assistants, Type type = EDIT )

private

Definition at line 41 of file EditAssistantsCommand.cpp.

{
    AssistantSPList oldAssistants = m_canvas->paintingAssistantsDecoration()->assistants();
 
    if (type == ADD) {
        KIS_ASSERT_RECOVER_RETURN(newAssistants.size() > oldAssistants.size());
    } else if (type == REMOVE) {
        KIS_ASSERT_RECOVER_RETURN(newAssistants.size() < oldAssistants.size());
    }
 
    m_canvas->paintingAssistantsDecoration()->setAssistants(newAssistants);
 
    m_canvas->updateCanvas();
}

References ADD, KIS_ASSERT_RECOVER_RETURN, m_canvas, and REMOVE.

undo()

void EditAssistantsCommand::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 56 of file EditAssistantsCommand.cpp.

{
    replaceWith(m_origAssistants, Type(-m_type));
}

References m_origAssistants, m_type, and replaceWith().

Member Data Documentation

m_canvas

QPointer<KisCanvas2> EditAssistantsCommand::m_canvas

private

Definition at line 31 of file EditAssistantsCommand.h.

m_firstRedo

bool EditAssistantsCommand::m_firstRedo

private

Definition at line 34 of file EditAssistantsCommand.h.

m_index

int EditAssistantsCommand::m_index

private

Definition at line 33 of file EditAssistantsCommand.h.

m_newAssistants

AssistantSPList EditAssistantsCommand::m_newAssistants

private

Definition at line 32 of file EditAssistantsCommand.h.

m_origAssistants

AssistantSPList EditAssistantsCommand::m_origAssistants

private

Definition at line 32 of file EditAssistantsCommand.h.

m_type

Type EditAssistantsCommand::m_type

private

Definition at line 35 of file EditAssistantsCommand.h.

---

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

• plugins/assistants/Assistants/EditAssistantsCommand.h
• plugins/assistants/Assistants/EditAssistantsCommand.cpp