KisSwitchCurrentTimeCommand Class Reference

#include <kis_switch_current_time_command.h>

Inheritance diagram for KisSwitchCurrentTimeCommand:

Public Member Functions
int	id () const override
	KisSwitchCurrentTimeCommand (KisImageAnimationInterface *animation, int oldTime, int newTime, KUndo2Command *parent=0)
bool	mergeWith (const KUndo2Command *command) override
void	redo () override
void	undo () override
	~KisSwitchCurrentTimeCommand () 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 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
KisImageAnimationInterface *	m_animation
int	m_newTime
int	m_oldTime

Detailed Description

Definition at line 19 of file kis_switch_current_time_command.h.

Constructor & Destructor Documentation

KisSwitchCurrentTimeCommand()

KisSwitchCurrentTimeCommand::KisSwitchCurrentTimeCommand	(	KisImageAnimationInterface *	animation,
		int	oldTime,
		int	newTime,
		KUndo2Command *	parent = 0 )

Definition at line 16 of file kis_switch_current_time_command.cpp.

    : KUndo2Command(kundo2_i18n("Switch current time"), parent),
      m_animation(animation),
      m_oldTime(oldTime),
      m_newTime(newTime)
{
}

~KisSwitchCurrentTimeCommand()

KisSwitchCurrentTimeCommand::~KisSwitchCurrentTimeCommand ( )

override

Definition at line 24 of file kis_switch_current_time_command.cpp.

{
}

Member Function Documentation

id()

int KisSwitchCurrentTimeCommand::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 28 of file kis_switch_current_time_command.cpp.

{
    return KisCommandUtils::ChangeCurrentTimeId;
}

References KisCommandUtils::ChangeCurrentTimeId.

mergeWith()

bool KisSwitchCurrentTimeCommand::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 33 of file kis_switch_current_time_command.cpp.

{
    const KisSwitchCurrentTimeCommand *other =
        dynamic_cast<const KisSwitchCurrentTimeCommand*>(command);
 
    if (!other || other->id() != id()) {
        return false;
    }
 
    m_newTime = other->m_newTime;
    return true;
}

References id(), and m_newTime.

redo()

void KisSwitchCurrentTimeCommand::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 46 of file kis_switch_current_time_command.cpp.

{
    m_animation->requestTimeSwitchNonGUI(m_newTime);
}

References m_animation, m_newTime, and KisImageAnimationInterface::requestTimeSwitchNonGUI().

undo()

void KisSwitchCurrentTimeCommand::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 51 of file kis_switch_current_time_command.cpp.

{
    m_animation->requestTimeSwitchNonGUI(m_oldTime);
}

References m_animation, m_oldTime, and KisImageAnimationInterface::requestTimeSwitchNonGUI().

Member Data Documentation

m_animation

KisImageAnimationInterface* KisSwitchCurrentTimeCommand::m_animation

private

Definition at line 32 of file kis_switch_current_time_command.h.

m_newTime

int KisSwitchCurrentTimeCommand::m_newTime

private

Definition at line 34 of file kis_switch_current_time_command.h.

m_oldTime

int KisSwitchCurrentTimeCommand::m_oldTime

private

Definition at line 33 of file kis_switch_current_time_command.h.

---

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

• libs/image/commands_new/kis_switch_current_time_command.h
• libs/image/commands_new/kis_switch_current_time_command.cpp