KisCustomModifiersCatcher Class Reference

The KisCustomModifiersCatcher class is a special utility class that tracks custom modifiers pressed. Its main purpose is to avoid manual tracking of KeyPress/KeyRelease/FocusIn events in the class and reuse the common code in multiple widgets. More...

#include <kis_custom_modifiers_catcher.h>

Inheritance diagram for KisCustomModifiersCatcher:

Classes
struct	Private

Public Member Functions
void	addModifier (const QString &id, Qt::Key modifier)
	addModifier registers a custom modifier
bool	eventFilter (QObject *object, QEvent *event) override
	KisCustomModifiersCatcher (QObject *parent)
bool	modifierPressed (const QString &id)
	modifierPressed returns the state of the tracked modifier
	~KisCustomModifiersCatcher () override

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

The KisCustomModifiersCatcher class is a special utility class that tracks custom modifiers pressed. Its main purpose is to avoid manual tracking of KeyPress/KeyRelease/FocusIn events in the class and reuse the common code in multiple widgets.

// in the c-tor of your widget create the catcher, it will automatically
// connect to the passed parent
KisCustomModifiersCatcher *catcher = new KisCustomModifiersCatcher(parent);
 
// Register a tracked modifier
catcher->addModifier("pan-zoom", Qt::Key_Space);
 
// in the pointer tracking event handlers just check
// if the modifier is pressed or not
bool isPressed = catcher->modifierPressed("pan-zoom");

Definition at line 33 of file kis_custom_modifiers_catcher.h.

Constructor & Destructor Documentation

KisCustomModifiersCatcher()

KisCustomModifiersCatcher::KisCustomModifiersCatcher

(

QObject *

parent

)

Create the catcher and connect to the passed widget/object to track its key events

Definition at line 34 of file kis_custom_modifiers_catcher.cpp.

    : QObject(parent),
      m_d(new Private(parent))
{
    if (m_d->trackedObject) {
        parent->installEventFilter(this);
    }
}

References m_d.

~KisCustomModifiersCatcher()

KisCustomModifiersCatcher::~KisCustomModifiersCatcher ( )

override

Definition at line 43 of file kis_custom_modifiers_catcher.cpp.

{
}

Member Function Documentation

addModifier()

void KisCustomModifiersCatcher::addModifier	(	const QString &	id,
		Qt::Key	modifier )

addModifier registers a custom modifier

Parameters

id	a unique id string associated with the modifier. Later, you will use this string to fetch the modifier state.
modifier	the key to track

Definition at line 47 of file kis_custom_modifiers_catcher.cpp.

{
    m_d->idToKeyMap.insert(id, modifier);
    m_d->trackedKeys.insert(modifier);
 
    m_d->reset();
}

References m_d.

eventFilter()

bool KisCustomModifiersCatcher::eventFilter ( QObject * object, QEvent * event )

override

Definition at line 64 of file kis_custom_modifiers_catcher.cpp.

{
    if (object != m_d->trackedObject) return false;
 
    switch (event->type()) {
    case QEvent::ShortcutOverride: {
        QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
 
        if (keyEvent->isAutoRepeat()) break;
 
        Qt::Key key = KisExtendedModifiersMapper::workaroundShiftAltMetaHell(keyEvent);
 
        if (m_d->trackedKeys.contains(key)) {
            if (m_d->pressedKeys.contains(key)) {
                m_d->reset();
            } else {
                m_d->pressedKeys.insert(key);
            }
        }
        break;
    }
    case QEvent::KeyRelease: {
        QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
 
        if (keyEvent->isAutoRepeat()) break;
 
        Qt::Key key = KisExtendedModifiersMapper::workaroundShiftAltMetaHell(keyEvent);
 
        if (m_d->trackedKeys.contains(key)) {
            if (!m_d->pressedKeys.contains(key)) {
                m_d->reset();
            } else {
                m_d->pressedKeys.remove(key);
            }
        }
 
        break;
    }
    case QEvent::FocusIn: {
        m_d->reset();
 
        { // Emulate pressing of the key that are already pressed
            KisExtendedModifiersMapper mapper;
 
            Qt::KeyboardModifiers modifiers = mapper.queryStandardModifiers();
            Q_FOREACH (Qt::Key key, mapper.queryExtendedModifiers()) {
                QKeyEvent kevent(QEvent::ShortcutOverride, key, modifiers);
                eventFilter(object, &kevent);
            }
        }
    }
    default:
        break;
    }
 
    return false;
}

References eventFilter(), m_d, KisExtendedModifiersMapper::queryExtendedModifiers(), KisExtendedModifiersMapper::queryStandardModifiers(), and KisExtendedModifiersMapper::workaroundShiftAltMetaHell().

modifierPressed()

bool KisCustomModifiersCatcher::modifierPressed

(

const QString &

id

)

modifierPressed returns the state of the tracked modifier

Definition at line 55 of file kis_custom_modifiers_catcher.cpp.

{
    if (!m_d->idToKeyMap.contains(id)) {
        qWarning() << "KisCustomModifiersCatcher::modifierPressed(): unexpected modifier id:" << id;
        return false;
    }
    return m_d->pressedKeys.contains(m_d->idToKeyMap[id]);
}

References m_d.

Member Data Documentation

m_d

const QScopedPointer<Private> KisCustomModifiersCatcher::m_d

private

Definition at line 59 of file kis_custom_modifiers_catcher.h.

---

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

• plugins/dockers/animation/kis_custom_modifiers_catcher.h
• plugins/dockers/animation/kis_custom_modifiers_catcher.cpp