Finish deprecating obsolete members of QWheelEvent

In Qt 5.0, delta() and orientation() were already marked obsolete,
but Widgets and tests have kept on depending on them all this time.
We now start using alternative API so they can really be deprecated.
All constructors except the newest one are also deprecated.
The plan is for all events from pointing devices to have
QPointF position() and globalPosition(), so we deprecate
the other position accessors.

[ChangeLog][QtGui] Obsolete constructors and accessors in QWheelEvent
now have proper deprecation macros.  What is left is intended to be
compatible with planned changes in Qt 6.

Change-Id: I26250dc90922b60a6ed20d7f65f38019da3e139e
Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>

1 files changed, 38 insertions, 180 deletions

diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp
index e1d685b1b0..2ec90433d6 100644
--- a/src/gui/kernel/qevent.cpp
+++ b/src/gui/kernel/qevent.cpp
@@ -754,31 +754,15 @@ QHoverEvent::~QHoverEvent()
     \fn Qt::Orientation QWheelEvent::orientation() const
     \obsolete
 
-    Returns the wheel's orientation.
-
     Use angleDelta() instead.
 */
 
+#if QT_CONFIG(wheelevent)
+#if QT_DEPRECATED_SINCE(5, 14)
 /*!
     \obsolete
-    Constructs a wheel event object.
-
-    Use the constructor taking \e angleDelta and \e pixelDelta QPoints instead.
-
-    The position, \a pos, is the location of the mouse cursor within
-    the widget. The globalPos() is initialized to QCursor::pos()
-    which is usually, but not always, correct.
-    Use the other constructor if you need to specify the global
-    position explicitly.
-
-    The \a buttons describe the state of the mouse buttons at the time
-    of the event, \a delta contains the rotation distance,
-    \a modifiers holds the keyboard modifier flags at the time of the
-    event, and \a orient holds the wheel's orientation.
-
-    \sa pos(), pixelDelta(), angleDelta()
+    This constructor has been deprecated.
 */
-#if QT_CONFIG(wheelevent)
 QWheelEvent::QWheelEvent(const QPointF &pos, int delta,
                          Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers,
                          Qt::Orientation orient)
@@ -793,26 +777,8 @@ QWheelEvent::QWheelEvent(const QPointF &pos, int delta,
 }
 
 /*!
-  \internal
-*/
-QWheelEvent::~QWheelEvent()
-{
-}
-
-/*!
     \obsolete
-    Constructs a wheel event object.
-
-    Use the constructor taking \e angleDelta and \e pixelDelta QPoints instead.
-
-    The \a pos provides the location of the mouse cursor
-    within the widget. The position in global coordinates is specified
-    by \a globalPos. \a delta contains the rotation distance, \a modifiers
-    holds the keyboard modifier flags at the time of the event, and
-    \a orient holds the wheel's orientation.
-
-
-    \sa pos(), pixelDelta(), angleDelta()
+    This constructor has been deprecated.
 */
 QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, int delta,
                          Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers,
@@ -827,27 +793,8 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos, int delta
 }
 
 /*!
-    Constructs a wheel event object.
-
-    The \a pos provides the location of the mouse cursor
-    within the window. The position in global coordinates is specified
-    by \a globalPos.
-
-    \a pixelDelta contains the scrolling distance in pixels on screen, while
-    \a angleDelta contains the wheel rotation distance. \a pixelDelta is
-    optional and can be null.
-
-    The mouse and keyboard states at the time of the event are specified by
-    \a buttons and \a modifiers.
-
-    For backwards compatibility, the event can also hold monodirectional wheel
-    event data: \a qt4Delta specifies the rotation, and \a qt4Orientation the
-    direction.
-
-    The phase() is initialized to Qt::ScrollUpdate. Use the other constructor
-    to specify the phase explicitly.
-
-    \sa posF(), globalPosF(), angleDelta(), pixelDelta()
+    \obsolete
+    This constructor has been deprecated.
 */
 
 QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
@@ -858,26 +805,8 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
 {}
 
 /*!
-    Constructs a wheel event object.
-
-    The \a pos provides the location of the mouse cursor
-    within the window. The position in global coordinates is specified
-    by \a globalPos.
-
-    \a pixelDelta contains the scrolling distance in pixels on screen, while
-    \a angleDelta contains the wheel rotation distance. \a pixelDelta is
-    optional and can be null.
-
-    The mouse and keyboard states at the time of the event are specified by
-    \a buttons and \a modifiers.
-
-    For backwards compatibility, the event can also hold monodirectional wheel
-    event data: \a qt4Delta specifies the rotation, and \a qt4Orientation the
-    direction.
-
-    The scrolling phase of the event is specified by \a phase.
-
-    \sa posF(), globalPosF(), angleDelta(), pixelDelta(), phase()
+    \obsolete
+    This constructor has been deprecated.
 */
 
 QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
@@ -888,31 +817,8 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
 {}
 
 /*!
-    Constructs a wheel event object.
-
-    The \a pos provides the location of the mouse cursor within the window. The
-    position in global coordinates is specified by \a globalPos.
-
-    \a pixelDelta contains the scrolling distance in pixels on screen, while
-    \a angleDelta contains the wheel rotation distance. \a pixelDelta is
-    optional and can be null.
-
-    The mouse and keyboard states at the time of the event are specified by
-    \a buttons and \a modifiers.
-
-    For backwards compatibility, the event can also hold monodirectional wheel
-    event data: \a qt4Delta specifies the rotation, and \a qt4Orientation the
-    direction.
-
-    The scrolling phase of the event is specified by \a phase.
-
-    If the wheel event comes from a physical mouse wheel, \a source is set to
-    Qt::MouseEventNotSynthesized. If it comes from a gesture detected by the
-    operating system, or from a non-mouse hardware device, such that \a pixelDelta is
-    directly related to finger movement, \a source is set to Qt::MouseEventSynthesizedBySystem.
-    If it comes from Qt, source would be set to Qt::MouseEventSynthesizedByQt.
-
-    \sa posF(), globalPosF(), angleDelta(), pixelDelta(), phase()
+    \obsolete
+    This constructor has been deprecated.
 */
 
 QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
@@ -923,37 +829,8 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
 {}
 
 /*!
-    Constructs a wheel event object.
-
-    The \a pos provides the location of the mouse cursor
-    within the window. The position in global coordinates is specified
-    by \a globalPos.
-
-    \a pixelDelta contains the scrolling distance in pixels on screen, while
-    \a angleDelta contains the wheel rotation distance. \a pixelDelta is
-    optional and can be null.
-
-    The mouse and keyboard states at the time of the event are specified by
-    \a buttons and \a modifiers.
-
-    For backwards compatibility, the event can also hold monodirectional wheel
-    event data: \a qt4Delta specifies the rotation, and \a qt4Orientation the
-    direction.
-
-    The scrolling phase of the event is specified by \a phase.
-
-    If the wheel event comes from a physical mouse wheel, \a source is set to
-    Qt::MouseEventNotSynthesized. If it comes from a gesture detected by the
-    operating system, or from a non-mouse hardware device, such that \a
-    pixelDelta is directly related to finger movement, \a source is set to
-    Qt::MouseEventSynthesizedBySystem. If it comes from Qt, source would be set
-    to Qt::MouseEventSynthesizedByQt.
-
-    If the system is configured to invert the delta values delivered with the
-    event (such as natural scrolling of the touchpad on OS X), \a inverted
-    should be \c true. Otherwise, \a inverted is \c false
-
-    \sa posF(), globalPosF(), angleDelta(), pixelDelta(), phase()
+    \obsolete
+    This constructor has been deprecated.
 */
 QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
             QPoint pixelDelta, QPoint angleDelta, int qt4Delta, Qt::Orientation qt4Orientation,
@@ -962,6 +839,7 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
       angleD(angleDelta), qt4D(qt4Delta), qt4O(qt4Orientation), mouseState(buttons), src(source),
       invertedScrolling(inverted), ph(phase)
 {}
+#endif // QT_DEPRECATED_SINCE(5, 14)
 
 /*!
     Constructs a wheel event object.
@@ -990,7 +868,7 @@ QWheelEvent::QWheelEvent(const QPointF &pos, const QPointF& globalPos,
     event (such as natural scrolling of the touchpad on macOS), \a inverted
     should be \c true. Otherwise, \a inverted is \c false
 
-    \sa posF(), globalPosF(), angleDelta(), pixelDelta(), phase()
+    \sa position(), globalPosition(), angleDelta(), pixelDelta(), phase(), inverted(), source()
 */
 QWheelEvent::QWheelEvent(QPointF pos, QPointF globalPos, QPoint pixelDelta, QPoint angleDelta,
             Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Qt::ScrollPhase phase,
@@ -1002,6 +880,12 @@ QWheelEvent::QWheelEvent(QPointF pos, QPointF globalPos, QPoint pixelDelta, QPoi
     qt4D = (qt4O == Qt::Horizontal ? angleDelta.x() : angleDelta.y());
 }
 
+/*!
+  \internal
+*/
+QWheelEvent::~QWheelEvent()
+{
+}
 #endif // QT_CONFIG(wheelevent)
 
 /*!
@@ -1061,87 +945,59 @@ QWheelEvent::QWheelEvent(QPointF pos, QPointF globalPos, QPoint pixelDelta, QPoi
 
 /*!
     \fn QPoint QWheelEvent::pos() const
+    \obsolete
 
-    Returns the position of the mouse cursor relative to the widget
-    that received the event.
-
-    If you move your widgets around in response to mouse events,
-    use globalPos() instead of this function.
-
-    \sa x(), y(), globalPos()
+    This function has been deprecated, use position() instead.
 */
 
 /*!
     \fn int QWheelEvent::x() const
+    \obsolete
 
-    Returns the x position of the mouse cursor, relative to the
-    widget that received the event.
-
-    \sa y(), pos()
+    This function has been deprecated, use position() instead.
 */
 
 /*!
     \fn int QWheelEvent::y() const
+    \obsolete
 
-    Returns the y position of the mouse cursor, relative to the
-    widget that received the event.
-
-    \sa x(), pos()
+    This function has been deprecated, use position() instead.
 */
 
 
 /*!
     \fn QPoint QWheelEvent::globalPos() const
+    \obsolete
 
-    Returns the global position of the mouse pointer \e{at the time
-    of the event}. This is important on asynchronous window systems
-    such as X11; whenever you move your widgets around in response to
-    mouse events, globalPos() can differ a lot from the current
-    cursor position returned by QCursor::pos().
-
-    \sa globalX(), globalY()
+    This function has been deprecated, use globalPosition() instead.
 */
 
 /*!
     \fn int QWheelEvent::globalX() const
+    \obsolete
 
-    Returns the global x position of the mouse cursor at the time of
-    the event.
-
-    \sa globalY(), globalPos()
+    This function has been deprecated, use globalPosition() instead.
 */
 
 /*!
     \fn int QWheelEvent::globalY() const
+    \obsolete
 
-    Returns the global y position of the mouse cursor at the time of
-    the event.
-
-    \sa globalX(), globalPos()
+    This function has been deprecated, use globalPosition() instead.
 */
 
 /*!
     \fn const QPointF &QWheelEvent::posF() const
+    \obsolete
 
-    Returns the position of the mouse cursor relative to the widget
-    that received the event.
-
-    If you move your widgets around in response to mouse events,
-    use globalPosF() instead of this function.
-
-    \sa globalPosF()
+    This function has been deprecated, use position() instead.
 */
 
 /*!
     \fn const QPointF &QWheelEvent::globalPosF() const
+    \obsolete
 
-    Returns the global position of the mouse pointer \e{at the time
-    of the event}. This is important on asynchronous window systems
-    such as X11; whenever you move your widgets around in response to
-    mouse events, globalPosF() can differ a lot from the current
-    cursor position returned by QCursor::pos().
-
-    \sa posF()
+    This function has been deprecated, use globalPosition() instead.
 */
 
 /*!
@@ -4074,8 +3930,10 @@ QDebug operator<<(QDebug dbg, const QEvent *e)
         dbg << "QWheelEvent(" << we->phase();
         if (!we->pixelDelta().isNull() || !we->angleDelta().isNull())
             dbg << ", pixelDelta=" << we->pixelDelta() << ", angleDelta=" << we->angleDelta();
+#if QT_DEPRECATED_SINCE(5, 14)
         else if (int qt4Delta = we->delta())
             dbg << ", delta=" << qt4Delta << ", orientation=" << we->orientation();
+#endif
         dbg << ')';
     }
         break;