qskinny/src/controls/QskEvent.h

/******************************************************************************
 * QSkinny - Copyright (C) The authors
 *           SPDX-License-Identifier: BSD-3-Clause
 *****************************************************************************/

#ifndef QSK_EVENT_H
#define QSK_EVENT_H

#include "QskAspect.h"

#include <qcoreevent.h>
#include <qrect.h>
#include <qkeysequence.h>
#include <memory>

class QskGesture;
class QskPopup;
class QQuickWindow;
class QQuickItem;

class QMouseEvent;
class QWheelEvent;
class QHoverEvent;
class QKeyEvent;

#define QSK_EVENT_DISABLE_COPY( Class ) \
        Class( const Class& ) = default; \
        Class( Class && ) = delete; \
        Class& operator=( const Class & ) = default; \
        Class& operator=( Class && ) = delete;

class QSK_EXPORT QskEvent : public QEvent
{
  public:
    enum Type
    {
        NoEvent = 53800,

        GeometryChange,
        WindowChange,

        /*
            Popups indicate their existence to the owning window
            to allow for priority based stacking rules
         */
        PopupAdded,
        PopupRemoved,

        Gesture,
        GestureFilter,

        Animator,

        MaxEvent = NoEvent + 50
    };

    QskEvent( QskEvent::Type type );

#if QT_VERSION < QT_VERSION_CHECK( 6, 0, 0 )
    virtual QskEvent* clone() const;
#endif

  protected:
    QSK_EVENT_DISABLE_COPY( QskEvent )
};

class QSK_EXPORT QskGeometryChangeEvent : public QskEvent
{
  public:
    QskGeometryChangeEvent( const QRectF& rect, const QRectF& oldRect );

    inline const QRectF& rect() const { return m_rect; }
    inline const QRectF& oldRect() const { return m_oldRect; }

    bool isResized() const;
    bool isMoved() const;

    QskGeometryChangeEvent* clone() const override;

  protected:
    QSK_EVENT_DISABLE_COPY( QskGeometryChangeEvent )

  private:
    QRectF m_rect;
    QRectF m_oldRect;
};

class QSK_EXPORT QskWindowChangeEvent : public QskEvent
{
  public:
    QskWindowChangeEvent( QQuickWindow* oldWindow, QQuickWindow* window );

    inline QQuickWindow* window() const { return m_window; }
    inline QQuickWindow* oldWindow() const { return m_oldWindow; }

    QskWindowChangeEvent* clone() const override;

  protected:
    QSK_EVENT_DISABLE_COPY( QskWindowChangeEvent )

  private:
    QQuickWindow* m_oldWindow;
    QQuickWindow* m_window;
};

class QSK_EXPORT QskPopupEvent : public QskEvent
{
  public:
    QskPopupEvent( Type, QskPopup* );

    inline QskPopup* popup() const { return m_popup; }

    QskPopupEvent* clone() const override;

  protected:
    QSK_EVENT_DISABLE_COPY( QskPopupEvent )

  private:
    QskPopup* m_popup;
};

class QSK_EXPORT QskGestureFilterEvent : public QskEvent
{
  public:
    QskGestureFilterEvent( const QQuickItem*, const QEvent* );

    inline const QQuickItem* item() const { return m_item; }
    inline const QEvent* event() const { return m_event; }

    inline void setMaybeGesture( bool on ) { m_maybeGesture = on; }
    inline bool maybeGesture() const { return m_maybeGesture; }

    QskGestureFilterEvent* clone() const override;

  protected:
    QSK_EVENT_DISABLE_COPY( QskGestureFilterEvent )

  private:
    const QQuickItem* m_item;
    const QEvent* m_event;

    bool m_maybeGesture;
};

class QSK_EXPORT QskGestureEvent : public QskEvent
{
  public:
    QskGestureEvent( std::shared_ptr< const QskGesture > );

    inline std::shared_ptr< const QskGesture > gesture() const { return m_gesture; }

    QskGestureEvent* clone() const override;

  protected:
    QSK_EVENT_DISABLE_COPY( QskGestureEvent )

  private:
    std::shared_ptr< const QskGesture > m_gesture;
};

class QSK_EXPORT QskAnimatorEvent : public QskEvent
{
  public:
    enum State
    {
        Started,
        Terminated
    };

    QskAnimatorEvent( QskAspect aspect, int index, State state );

    inline QskAspect aspect() const { return m_aspect; }
    inline int index() const { return m_index; }
    inline State state() const { return m_state; }

    QskAnimatorEvent* clone() const override;

  protected:
    QSK_EVENT_DISABLE_COPY( QskAnimatorEvent )

  private:
    QskAspect m_aspect;
    int m_index;
    State m_state;
};

QSK_EXPORT int qskFocusChainIncrement( const QEvent* );

// some helper to work around Qt version incompatibilities
QSK_EXPORT QPointF qskMouseScenePosition( const QMouseEvent* );
QSK_EXPORT QPointF qskMousePosition( const QMouseEvent* );
QSK_EXPORT QPointF qskHoverPosition( const QHoverEvent* );

#ifndef QT_NO_WHEELEVENT

QSK_EXPORT QPointF qskWheelPosition( const QWheelEvent* );
QSK_EXPORT qreal qskWheelSteps( const QWheelEvent* );
QSK_EXPORT qreal qskWheelIncrement( const QWheelEvent* );

#endif

QSK_EXPORT bool qskIsStandardKeyInput( const QKeyEvent*, QKeySequence::StandardKey );
QSK_EXPORT bool qskIsButtonPressKey( const QKeyEvent* );

QSK_EXPORT bool qskIsTouchOrMouseEvent( QEvent::Type );

#endif