KisChangeFrameAction Class Reference

#include <kis_change_frame_action.h>

Inheritance diagram for KisChangeFrameAction:

Classes
struct	Private

Public Types
enum	Shortcuts { NextFrameShortcut , PreviousFrameShortcut }

Public Member Functions
void	begin (int shortcut, QEvent *event) override
bool	isAvailable () const override
	KisChangeFrameAction ()
	~KisChangeFrameAction () override
Public Member Functions inherited from KisAbstractInputAction
virtual void	activate (int shortcut)
virtual bool	canIgnoreModifiers () const
virtual void	deactivate (int shortcut)
virtual QString	description () const
virtual void	end (QEvent *event)
virtual QString	id () const
virtual KisInputActionGroup	inputActionGroup (int shortcut) const
virtual void	inputEvent (QEvent *event)
virtual bool	isShortcutRequired (int shortcut) const
	KisAbstractInputAction (const QString &id)
virtual QString	name () const
virtual int	priority () const
virtual QHash< QString, int >	shortcutIndexes () const
virtual bool	supportsHiResInputEvents (int shortcut) const
virtual bool	trySwitchShortcut (int oldShortcut, int newShortcut)
virtual	~KisAbstractInputAction ()

Private Attributes
const QScopedPointer< Private >	m_d

Additional Inherited Members
Public Attributes inherited from KisAbstractInputAction
QString	description
QString	id
QHash< QString, int >	indexes
QPointF	lastCursorPosition
QString	name
QPointF	startCursorPosition
Static Public Attributes inherited from KisAbstractInputAction
static KisInputManager *	inputManager
Protected Member Functions inherited from KisAbstractInputAction
virtual void	cursorMoved (const QPointF &lastPos, const QPointF &pos)
virtual void	cursorMovedAbsolute (const QPointF &startPos, const QPointF &pos)
QPoint	eventPos (const QEvent *event)
QPointF	eventPosF (const QEvent *event)
KisInputManager *	inputManager () const
void	setDescription (const QString &description)
void	setName (const QString &name)
void	setShortcutIndexes (const QHash< QString, int > &indexes)

Detailed Description

Definition at line 15 of file kis_change_frame_action.h.

Member Enumeration Documentation

Shortcuts

enum KisChangeFrameAction::Shortcuts

Enumerator
NextFrameShortcut
PreviousFrameShortcut

Definition at line 18 of file kis_change_frame_action.h.

                   {
        NextFrameShortcut,
        PreviousFrameShortcut
    };

Constructor & Destructor Documentation

KisChangeFrameAction()

KisChangeFrameAction::KisChangeFrameAction

(

)

Definition at line 23 of file kis_change_frame_action.cpp.

    : KisAbstractInputAction("Switch Time"),
      m_d(new Private)
{
    setName(i18n("Switch Time"));
    setDescription(i18n("The <i>Switch Time</i> action changes the current time of the animation."));
 
    QHash< QString, int > shortcuts;
    shortcuts.insert(i18n("Next Frame"), NextFrameShortcut);
    shortcuts.insert(i18n("Previous Frame"), PreviousFrameShortcut);
    setShortcutIndexes(shortcuts);
}

References NextFrameShortcut, PreviousFrameShortcut, KisAbstractInputAction::setDescription(), KisAbstractInputAction::setName(), and KisAbstractInputAction::setShortcutIndexes().

~KisChangeFrameAction()

KisChangeFrameAction::~KisChangeFrameAction ( )

override

Definition at line 36 of file kis_change_frame_action.cpp.

{
}

Member Function Documentation

begin()

void KisChangeFrameAction::begin ( int shortcut, QEvent * event )

overridevirtual

Begin the action.

Parameters

shortcut	The index of the behaviour to trigger.
event	The mouse event that has triggered this action. Is null for keyboard-activated actions.

Reimplemented from KisAbstractInputAction.

Definition at line 70 of file kis_change_frame_action.cpp.

{
    KisAbstractInputAction::begin(shortcut, event);
 
    switch(shortcut) {
    case NextFrameShortcut: {
        KisAction *action = inputManager()->canvas()->viewManager()->actionManager()->actionByName("next_frame");
        if (action) {
            action->trigger();
        }
        break;
    }
    case PreviousFrameShortcut: {
        KisAction *action = inputManager()->canvas()->viewManager()->actionManager()->actionByName("previous_frame");
        if (action) {
            action->trigger();
        }
        break;
    }
    }
}

References KisActionManager::actionByName(), KisViewManager::actionManager(), KisAbstractInputAction::begin(), KisInputManager::canvas(), KisAbstractInputAction::inputManager, NextFrameShortcut, PreviousFrameShortcut, and KisCanvas2::viewManager().

isAvailable()

bool KisChangeFrameAction::isAvailable ( ) const

overridevirtual

Some of the actions are available in particular situations only. E.g. switch frame action is available iff an animated layer is selected. If isAvailable() returns true then the action will not be triggered by the shortcut matcher.

Reimplemented from KisAbstractInputAction.

Definition at line 40 of file kis_change_frame_action.cpp.

{
    KisInputManager *im = inputManager();
    if (!im) return false;
 
    KisCanvas2 *canvas = im->canvas();
    if (!canvas) return false;
 
    KisImageWSP image = canvas->image();
    if (!bool(image)) return false;
 
    // Only works when this image has animation
    if (!image->animationInterface()->hasAnimation()) {
        return false;
    }
 
    // Prevents when in Edit Selection
    KisNodeSP activeNode = canvas->viewManager()->activeNode();
    if (activeNode && activeNode->inherits("KisSelectionMask")) {
        return false;
    }
 
    // Prevents when a shape is selected
    if (canvas->toolProxy() && canvas->toolProxy()->hasSelection()) {
        return false;
    }
 
    return true;
}

References KisViewManager::activeNode(), KisImage::animationInterface(), Private::canvas, KisInputManager::canvas(), KisImageAnimationInterface::hasAnimation(), KoToolProxy::hasSelection(), KisCanvas2::image(), KisAbstractInputAction::inputManager, KisCanvas2::toolProxy, and KisCanvas2::viewManager().

Member Data Documentation

m_d

const QScopedPointer<Private> KisChangeFrameAction::m_d

private

Definition at line 32 of file kis_change_frame_action.h.

---

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

• libs/ui/input/kis_change_frame_action.h
• libs/ui/input/kis_change_frame_action.cpp