File indexing completed on 2025-09-14 03:50:00

 /*
     SPDX-FileCopyrightText: 2011 Marco Martin <notmart@gmail.com>
     SPDX-FileCopyrightText: 2013 Sebastian Kügler <sebas@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef MOUSEEVENTLISTENER_H
 #define MOUSEEVENTLISTENER_H
 
 #include <QQuickItem>
 
 /**
  * This item spies on mouse events from all child objects including child MouseAreas regardless
  * of whether the child MouseArea propagates events. It does not accept the event.
  *
  * In addition unlike MouseArea events include the mouse position in global coordinates and provides
  * the screen the mouse is in.
  */
 
 class KDeclarativeMouseEvent : public QObject
 {
     Q_OBJECT
     QML_ELEMENT
     QML_ANONYMOUS
     Q_PROPERTY(int x READ x)
     Q_PROPERTY(int y READ y)
     Q_PROPERTY(int screenX READ screenX)
     Q_PROPERTY(int screenY READ screenY)
     Q_PROPERTY(int button READ button)
     Q_PROPERTY(Qt::MouseButtons buttons READ buttons)
     Q_PROPERTY(Qt::KeyboardModifiers modifiers READ modifiers)
     Q_PROPERTY(QScreen *screen READ screen CONSTANT)
     Q_PROPERTY(bool accepted READ isAccepted WRITE setAccepted NOTIFY acceptedChanged)
     Q_PROPERTY(int source READ source)
 
 public:
     KDeclarativeMouseEvent(int x,
                            int y,
                            int screenX,
                            int screenY,
                            Qt::MouseButton button,
                            Qt::MouseButtons buttons,
                            Qt::KeyboardModifiers modifiers,
                            QScreen *screen,
                            Qt::MouseEventSource source)
         : m_x(x)
         , m_y(y)
         , m_screenX(screenX)
         , m_screenY(screenY)
         , m_button(button)
         , m_buttons(buttons)
         , m_modifiers(modifiers)
         , m_screen(screen)
         , m_source(source)
     {
     }
 
     int x() const
     {
         return m_x;
     }
     int y() const
     {
         return m_y;
     }
     int screenX() const
     {
         return m_screenX;
     }
     int screenY() const
     {
         return m_screenY;
     }
     int button() const
     {
         return m_button;
     }
     Qt::MouseButtons buttons() const
     {
         return m_buttons;
     }
     Qt::KeyboardModifiers modifiers() const
     {
         return m_modifiers;
     }
     QScreen *screen() const
     {
         return m_screen;
     }
     int source() const
     {
         return m_source;
     }
 
     bool isAccepted() const
     {
         return m_accepted;
     }
     void setAccepted(bool accepted)
     {
         if (m_accepted != accepted) {
             m_accepted = accepted;
             Q_EMIT acceptedChanged();
         }
     }
 
     // only for internal usage
     void setX(int x)
     {
         m_x = x;
     }
     void setY(int y)
     {
         m_y = y;
     }
 
 Q_SIGNALS:
     void acceptedChanged();
 
 private:
     int m_x;
     int m_y;
     int m_screenX;
     int m_screenY;
     Qt::MouseButton m_button;
     Qt::MouseButtons m_buttons;
     Qt::KeyboardModifiers m_modifiers;
     QScreen *m_screen;
     bool m_accepted = false;
     int m_source;
 };
 
 class KDeclarativeWheelEvent : public QObject
 {
     Q_OBJECT
     QML_ELEMENT
     QML_ANONYMOUS
     Q_PROPERTY(int x READ x CONSTANT)
     Q_PROPERTY(int y READ y CONSTANT)
     Q_PROPERTY(int screenX READ screenX CONSTANT)
     Q_PROPERTY(int screenY READ screenY CONSTANT)
     Q_PROPERTY(int deltaX READ deltaX CONSTANT)
     Q_PROPERTY(int deltaY READ deltaY CONSTANT)
     Q_PROPERTY(int delta READ deltaY CONSTANT) // deprecated in favor of deltaY. TODO KF6: remove
     Q_PROPERTY(Qt::MouseButtons buttons READ buttons CONSTANT)
     Q_PROPERTY(Qt::KeyboardModifiers modifiers READ modifiers CONSTANT)
     Q_PROPERTY(Qt::Orientation orientation READ orientation CONSTANT) // deprecated. TODO KF6: remove
 
 public:
     KDeclarativeWheelEvent(QPointF pos,
                            QPoint screenPos,
                            QPoint angleDelta,
                            Qt::MouseButtons buttons,
                            Qt::KeyboardModifiers modifiers,
                            Qt::Orientation orientation)
         : m_x(pos.x())
         , m_y(pos.y())
         , m_screenX(screenPos.x())
         , m_screenY(screenPos.y())
         , m_angleDelta(angleDelta)
         , m_buttons(buttons)
         , m_modifiers(modifiers)
         , m_orientation(orientation)
     {
     }
 
     int x() const
     {
         return m_x;
     }
     int y() const
     {
         return m_y;
     }
     int screenX() const
     {
         return m_screenX;
     }
     int screenY() const
     {
         return m_screenY;
     }
     int deltaX() const
     {
         return m_angleDelta.x();
     }
     int deltaY() const
     {
         return m_angleDelta.y();
     }
     Qt::MouseButtons buttons() const
     {
         return m_buttons;
     }
     Qt::KeyboardModifiers modifiers() const
     {
         return m_modifiers;
     }
     Qt::Orientation orientation()
     {
         return m_orientation;
     } // TODO KF6: remove
 
     // only for internal usage
     void setX(int x)
     {
         m_x = x;
     }
     void setY(int y)
     {
         m_y = y;
     }
 
 private:
     int m_x;
     int m_y;
     int m_screenX;
     int m_screenY;
     QPoint m_angleDelta;
     Qt::MouseButtons m_buttons;
     Qt::KeyboardModifiers m_modifiers;
     Qt::Orientation m_orientation;
 };
 
 class MouseEventListener : public QQuickItem
 {
     Q_OBJECT
     QML_ELEMENT
     /**
      * This property holds whether hover events are handled.
      * By default hover events are disabled
      */
     Q_PROPERTY(bool hoverEnabled READ hoverEnabled WRITE setHoverEnabled NOTIFY hoverEnabledChanged)
 
     /**
      * True if this MouseEventListener or any of its children contains the mouse cursor:
      * this property will change only when the mouse button is pressed if hoverEnabled is false.
      */
     Q_PROPERTY(bool containsMouse READ containsMouse NOTIFY containsMouseChanged)
 
     Q_PROPERTY(Qt::MouseButtons acceptedButtons READ acceptedButtons WRITE setAcceptedButtons NOTIFY acceptedButtonsChanged)
 
     /**
      * This property holds the cursor shape for this mouse area.
      * Note that on platforms that do not display a mouse cursor this may have no effect.
      */
     Q_PROPERTY(Qt::CursorShape cursorShape READ cursorShape WRITE setCursorShape RESET unsetCursor NOTIFY cursorShapeChanged)
 
     /**
      * True if the mouse is pressed in the item or any of its children
      */
     Q_PROPERTY(bool pressed READ isPressed NOTIFY pressedChanged)
 
 public:
     MouseEventListener(QQuickItem *parent = nullptr);
     ~MouseEventListener() override;
 
     bool containsMouse() const;
     void setHoverEnabled(bool enable);
     bool hoverEnabled() const;
     bool isPressed() const;
 
     Qt::MouseButtons acceptedButtons() const;
     void setAcceptedButtons(Qt::MouseButtons buttons);
 
     Qt::CursorShape cursorShape() const;
     void setCursorShape(Qt::CursorShape shape);
 
 protected:
     void hoverEnterEvent(QHoverEvent *event) override;
     void hoverLeaveEvent(QHoverEvent *event) override;
     void hoverMoveEvent(QHoverEvent *event) override;
     void mousePressEvent(QMouseEvent *event) override;
     void mouseMoveEvent(QMouseEvent *event) override;
     void mouseReleaseEvent(QMouseEvent *event) override;
     void wheelEvent(QWheelEvent *event) override;
     bool childMouseEventFilter(QQuickItem *item, QEvent *event) override;
     void mouseUngrabEvent() override;
     void touchUngrabEvent() override;
 
 Q_SIGNALS:
     void pressed(KDeclarativeMouseEvent *mouse);
     void positionChanged(KDeclarativeMouseEvent *mouse);
     void released(KDeclarativeMouseEvent *mouse);
     void clicked(KDeclarativeMouseEvent *mouse);
     void pressAndHold(KDeclarativeMouseEvent *mouse);
     void wheelMoved(KDeclarativeWheelEvent *wheel);
     void containsMouseChanged(bool containsMouseChanged);
     void hoverEnabledChanged(bool hoverEnabled);
     void acceptedButtonsChanged();
     void cursorShapeChanged();
     void pressedChanged();
     void canceled();
 
 private Q_SLOTS:
     void handlePressAndHold();
     void handleUngrab();
 
 private:
     static QScreen *screenForGlobalPos(const QPointF &globalPos);
 
     bool m_pressed;
     KDeclarativeMouseEvent *m_pressAndHoldEvent;
     QPointF m_buttonDownPos;
     // Important: used only for comparison. If you will ever need to access this pointer, make it a QWeakPointer
     QEvent *m_lastEvent;
     QTimer *m_pressAndHoldTimer;
     bool m_containsMouse = false;
     bool m_childContainsMouse = false;
     Qt::MouseButtons m_acceptedButtons;
 };
 
 #endif