KisLongPressEventFilter Class Reference

#include <KisLongPressEventFilter.h>

Inheritance diagram for KisLongPressEventFilter:

Public Member Functions
bool	eventFilter (QObject *watched, QEvent *event) override
	KisLongPressEventFilter (QObject *parent=nullptr)

Static Public Attributes
static constexpr char	ENABLED_PROPERTY [] = "KRITA_LONG_PRESS"

Private Member Functions
void	cancel ()
void	handleMouseMove (const QMouseEvent *me)
void	handleMousePress (QWidget *target, const QMouseEvent *me)
bool	isWithinDistance (const QPoint &globalPos) const
void	triggerLongPress ()

Static Private Member Functions
static bool	isContextMenuTarget (QWidget *target)
static bool	isLongPressableWidget (QWidget *target)

Private Attributes
long long	m_distanceSquared = 0LL
QPoint	m_pressGlobalPos
QPoint	m_pressLocalPos
QPointer< QWidget >	m_target
QTimer *	m_timer

Static Private Attributes
static constexpr int	MINIMUM_DELAY = 100
static constexpr int	MINIMUM_DISTANCE = 0

Detailed Description

Definition at line 12 of file KisLongPressEventFilter.h.

Constructor & Destructor Documentation

KisLongPressEventFilter()

KisLongPressEventFilter::KisLongPressEventFilter ( QObject * parent = nullptr )

explicit

Definition at line 20 of file KisLongPressEventFilter.cpp.

    : QObject(parent)
{
    m_timer = new QTimer(this);
    m_timer->setTimerType(Qt::CoarseTimer);
    m_timer->setSingleShot(true);
    connect(m_timer, &QTimer::timeout, this, &KisLongPressEventFilter::triggerLongPress);
}

References connect(), m_timer, and triggerLongPress().

Member Function Documentation

cancel()

void KisLongPressEventFilter::cancel ( )

private

Definition at line 86 of file KisLongPressEventFilter.cpp.

{
    m_timer->stop();
    m_target.clear();
}

References m_target, and m_timer.

eventFilter()

bool KisLongPressEventFilter::eventFilter ( QObject * watched, QEvent * event )

override

Definition at line 29 of file KisLongPressEventFilter.cpp.

{
    switch (event->type()) {
    case QEvent::MouseButtonPress:
    case QEvent::MouseButtonDblClick:
        handleMousePress(qobject_cast<QWidget *>(watched), static_cast<QMouseEvent *>(event));
        break;
    case QEvent::MouseMove:
        handleMouseMove(static_cast<QMouseEvent *>(event));
        break;
    case QEvent::MouseButtonRelease:
        cancel();
        break;
    default:
        break;
    }
    return QObject::eventFilter(watched, event);
}

References cancel(), handleMouseMove(), and handleMousePress().

handleMouseMove()

void KisLongPressEventFilter::handleMouseMove ( const QMouseEvent * me )

private

Definition at line 74 of file KisLongPressEventFilter.cpp.

{
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
    QPoint globalPos = me->globalPos();
#else
    QPoint globalPos = me->globalPosition().toPoint();
#endif
    if (m_timer->isActive() && !isWithinDistance(globalPos)) {
        cancel();
    }
}

References cancel(), isWithinDistance(), and m_timer.

handleMousePress()

void KisLongPressEventFilter::handleMousePress ( QWidget * target, const QMouseEvent * me )

private

Definition at line 48 of file KisLongPressEventFilter.cpp.

{
    if (isContextMenuTarget(target)) {
        const QStyleHints *sh = qApp->styleHints();
        long long distance = qMax(MINIMUM_DISTANCE, sh->startDragDistance());
        m_distanceSquared = distance * 2LL;
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
        m_pressLocalPos = me->pos();
        m_pressGlobalPos = me->globalPos();
#else
        m_pressLocalPos = me->position().toPoint();
        m_pressGlobalPos = me->globalPosition().toPoint();
#endif
        m_target = target;
#ifdef Q_OS_ANDROID
        int longPressInterval =
            QAndroidJniObject::callStaticMethod<jint>("org/krita/android/MainActivity", "getLongPressTimeout", "()I");
#else
        int longPressInterval = sh->mousePressAndHoldInterval();
#endif
        m_timer->start(qMax(MINIMUM_DELAY, longPressInterval));
    } else {
        cancel();
    }
}

References cancel(), distance(), isContextMenuTarget(), m_distanceSquared, m_pressGlobalPos, m_pressLocalPos, m_target, m_timer, MINIMUM_DELAY, MINIMUM_DISTANCE, and target().

isContextMenuTarget()

bool KisLongPressEventFilter::isContextMenuTarget ( QWidget * target )

staticprivate

Definition at line 107 of file KisLongPressEventFilter.cpp.

{
    while (target && target->isVisible() && isLongPressableWidget(target)) {
        switch (target->contextMenuPolicy()) {
        case Qt::NoContextMenu:
            target = target->parentWidget();
            break;
        case Qt::PreventContextMenu:
            return false;
        default:
            return true;
        }
    }
    return false;
}

References isLongPressableWidget(), and target().

isLongPressableWidget()

bool KisLongPressEventFilter::isLongPressableWidget ( QWidget * target )

staticprivate

Definition at line 123 of file KisLongPressEventFilter.cpp.

{
    QVariant prop = target->property(ENABLED_PROPERTY);
    if (prop.isValid()) {
        return prop.toBool();
    }
 
    // Several widget types don't have desirable long-press behavior. If they're
    // our own widgets, we should just fix that in the widget, but we can"t
    // really sensibly do that to Qt's widgets. Luckily however, those widgets
    // really shouldn't have context menus in the first place, so we can just
    // disregard them as long-press targets and be done with it.
 
    // Buttons get depressed when you click and hold on them and won't pop back
    // up if a context menu is opened during that. They may also have a menu
    // attached to them that the user operates like a context menu.
    if (qobject_cast<QAbstractButton *>(target)) {
        return false;
    }
 
    // Slightly non-obvious, but this thing has many child classes, like text
    // areas or the canvas, none of which have sensible context menus.
    if (qobject_cast<QAbstractScrollArea *>(target)) {
        return false;
    }
 
    // Sliders (including scrollbars) may get dragged slowly.
    if (qobject_cast<QAbstractSlider *>(target)) {
        return false;
    }
 
    // Spinners may get held down to keep a number spinning.
    if (qobject_cast<QAbstractSpinBox *>(target)) {
        return false;
    }
 
    // Combo boxes get held down to pick an item.
    if (qobject_cast<QComboBox *>(target)) {
        return false;
    }
 
    // Text editing will have its own long-press handling.
    if (qobject_cast<QLineEdit *>(target)) {
        return false;
    }
 
    // Menus don't have context menus.
    if (qobject_cast<QMenu *>(target)) {
        return false;
    }
 
    // Menu bars don't have context menus either.
    if (qobject_cast<QMenuBar *>(target)) {
        return false;
    }
 
    return true;
}

References ENABLED_PROPERTY, and target().

isWithinDistance()

bool KisLongPressEventFilter::isWithinDistance ( const QPoint & globalPos ) const

private

Definition at line 92 of file KisLongPressEventFilter.cpp.

{
    long long x = globalPos.x() - m_pressGlobalPos.x();
    long long y = globalPos.y() - m_pressGlobalPos.y();
    return (x * x) + (y * y) <= m_distanceSquared;
}

References m_distanceSquared, and m_pressGlobalPos.

triggerLongPress()

void KisLongPressEventFilter::triggerLongPress ( )

private

Definition at line 99 of file KisLongPressEventFilter.cpp.

{
    QWidget *target = m_target.data();
    if (isContextMenuTarget(target)) {
        qApp->postEvent(target, new QContextMenuEvent(QContextMenuEvent::Mouse, m_pressLocalPos, m_pressGlobalPos));
    }
}

References isContextMenuTarget(), m_pressGlobalPos, m_pressLocalPos, m_target, and target().

Member Data Documentation

ENABLED_PROPERTY

constexpr char KisLongPressEventFilter::ENABLED_PROPERTY[] = "KRITA_LONG_PRESS"

staticconstexpr

Definition at line 16 of file KisLongPressEventFilter.h.

m_distanceSquared

long long KisLongPressEventFilter::m_distanceSquared = 0LL

private

Definition at line 38 of file KisLongPressEventFilter.h.

m_pressGlobalPos

QPoint KisLongPressEventFilter::m_pressGlobalPos

private

Definition at line 40 of file KisLongPressEventFilter.h.

m_pressLocalPos

QPoint KisLongPressEventFilter::m_pressLocalPos

private

Definition at line 39 of file KisLongPressEventFilter.h.

m_target

QPointer<QWidget> KisLongPressEventFilter::m_target

private

Definition at line 41 of file KisLongPressEventFilter.h.

m_timer

QTimer* KisLongPressEventFilter::m_timer

private

Definition at line 37 of file KisLongPressEventFilter.h.

MINIMUM_DELAY

constexpr int KisLongPressEventFilter::MINIMUM_DELAY = 100

staticconstexprprivate

Definition at line 23 of file KisLongPressEventFilter.h.

MINIMUM_DISTANCE

constexpr int KisLongPressEventFilter::MINIMUM_DISTANCE = 0

staticconstexprprivate

Definition at line 24 of file KisLongPressEventFilter.h.

---

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

• libs/ui/KisLongPressEventFilter.h
• libs/ui/KisLongPressEventFilter.cpp