Add QtCompat for deprecated QMouseEvent methods

Qt6.0 deprecated many MouseEvent methods. PyQt6 does not expose these deprecated
methods. This adds compatibility wrappers for this.

Author: MHendricks

README.md

@@ -67,7 +67,6 @@ Qt.py enables you to write software that runs on any of the 4 supported bindings
 - [Projects using Qt.py](#projects-using-qtpy)
 - [Projects similar to Qt.py](#projects-similar-to-qtpy)
 - [Developer guide](#developer-guide)
-- [Qt 6 transition guide](#qt-6-transition-guide)
 
 <br>
 <br>
@@ -643,6 +642,15 @@ To make a new release onto PyPI, you'll need to have the correct permissions and
 | `QApplication.exec_()` | `QtCompat.QApplication.exec_()` | `exec` is no longer a reserved keyword in python 3 so Qt6 is removing the underscore from `exec_`. Qt.py is using exec_ to preserve compatibility with python 2. The same applies for `QCoreApplication`.
 | `QAction().setShortcut(Qt.SHIFT\|Qt.Key_Backspace)` | `QAction().setShortcut(QKeySequence(Qt.Modifier.SHIFT\|Qt.Key.Key_Backspace))` | PyQt6 doesn't accept `QKeyCombination` objects for shortcuts. To work around this cast them to `QKeySequence` objects.
 | int(QMainWindow().windowState()) | QtCompat.enumValue(QMainWindow().windowState()) | Consistent interface to convert an enum to an `int`
+| `QMouseEvent.globalPos()` | `QtCompat.QMouseEvent().globalPosition(event).toPoint()` | Deprecated in Qt6.0 and removed from PyQt6, currently still in PySide6. Changes from `QPoint` to `QPointF`.
+| `QMouseEvent.globalX()` | `QtCompat.QMouseEvent().globalPosition(event).x()` | See `globalPos()`
+| `QMouseEvent.globalY()` | `QtCompat.QMouseEvent().globalPosition(event).y()` | See `globalPos()`
+| `QMouseEvent.localPos()` | `QtCompat.QMouseEvent().position(event)` | See `globalPos()`
+| `QMouseEvent.pos()` | `QtCompat.QMouseEvent().position(event)` | Changes from `QPoint` to `QPointF`. See `globalPos()`
+| `QMouseEvent.screenPos()` | `QtCompat.QMouseEvent().globalPosition(event)` | See `globalPos()`
+| `QMouseEvent.windowPos()` | `QtCompat.QMouseEvent().scenePosition(event)` | See `globalPos()`
+| `QMouseEvent.x()` | `QtCompat.QMouseEvent().position(event).x()` | See `globalPos()`
+| `QMouseEvent.y()` | `QtCompat.QMouseEvent().position(event).y()` | See `globalPos()`
 | | Submit your known issues here! |
 
 ##### Removed Members (Qt.py\==2.\*)

src/Qt.py

@@ -1577,6 +1577,11 @@ def wrapper(self, descrip):
             "fromString": "QtGui.QFont.fromString",
             "setWeight": "QtGui.QFont.setWeight",
         },
+        "QMouseEvent": {
+            "globalPosition": "QtGui.QMouseEvent.globalPosition",
+            "position": "QtGui.QMouseEvent.position",
+            "scenePosition": "QtGui.QMouseEvent.scenePosition",
+        },
         "Qt": {
             "MidButton": "QtCore.Qt.MiddleButton",
         },
@@ -1608,6 +1613,11 @@ def wrapper(self, descrip):
             "fromString": "QtGui.QFont.fromString",
             "setWeight": "QtGui.QFont.setWeight",
         },
+        "QMouseEvent": {
+            "globalPosition": "QtGui.QMouseEvent.globalPosition",
+            "position": "QtGui.QMouseEvent.position",
+            "scenePosition": "QtGui.QMouseEvent.scenePosition",
+        },
         "Qt": {
             "MidButton": "QtCore.Qt.MouseButton.MiddleButton",
             "WindowMinMaxButtonsHint": "QtCore.Qt.WindowType.WindowMinMaxButtonsHint",
@@ -1640,6 +1650,11 @@ def wrapper(self, descrip):
             "fromString": "QtGui.QFont.fromString",
             "setWeight": "QtGui.QFont.setWeight",
         },
+        "QMouseEvent": {
+            "globalPosition": "QtGui.QMouseEvent.screenPos",
+            "position": "QtGui.QMouseEvent.localPos",
+            "scenePosition": "QtGui.QMouseEvent.windowPos",
+        },
         "Qt": {
             "MidButton": "QtCore.Qt.MiddleButton",
         },
@@ -1671,6 +1686,11 @@ def wrapper(self, descrip):
             "fromString": "QtGui.QFont.fromString",
             "setWeight": "QtGui.QFont.setWeight",
         },
+        "QMouseEvent": {
+            "globalPosition": "QtGui.QMouseEvent.screenPos",
+            "position": "QtGui.QMouseEvent.localPos",
+            "scenePosition": "QtGui.QMouseEvent.windowPos",
+        },
         "Qt": {
             "MidButton": "QtCore.Qt.MiddleButton",
         },

tests.py

@@ -1148,15 +1148,13 @@ def test_binding_states():
 def test_qtcompat_base_class():
     """Tests to ensure the QtCompat namespace object works as expected"""
     import sys
-    import Qt
-    from Qt import QtWidgets
-    from Qt import QtCompat
+    from Qt import QtCompat, QtCore, QtGui, QtWidgets
 
     if not QtWidgets.QApplication.instance():
         app = QtWidgets.QApplication(sys.argv)
     else:
         app = QtWidgets.QApplication.instance()  # noqa: F841
-    header = QtWidgets.QHeaderView(get_enum(Qt.QtCore.Qt, "Orientation", "Horizontal"))
+    header = QtWidgets.QHeaderView(get_enum(QtCore.Qt, "Orientation", "Horizontal"))
 
     # Spot check compatibility functions
     QtCompat.QHeaderView.setSectionsMovable(header, False)
@@ -1169,6 +1167,21 @@ def test_qtcompat_base_class():
     pixmap = QtCompat.QWidget.grab(button)
     assert not pixmap.isNull()
 
+    # Check QMouseEvent compatibility wrappers
+    # NOTE: PyQt6 requires passing QPointF. Also it doesn't have Qt.MouseButtons
+    mouse_event = QtGui.QMouseEvent(
+        QtCore.QEvent.Type.MouseButtonPress,
+        QtCore.QPointF(1, 1),
+        QtCore.QPointF(2, 2),
+        QtCore.QPointF(3, 3),
+        QtCore.Qt.MouseButton.LeftButton,
+        QtCore.Qt.MouseButton.LeftButton | QtCore.Qt.MouseButton.RightButton,
+        QtCore.Qt.KeyboardModifier.NoModifier,
+    )
+    assert QtCompat.QMouseEvent.globalPosition(mouse_event) == QtCore.QPointF(3, 3)
+    assert QtCompat.QMouseEvent.position(mouse_event) == QtCore.QPointF(1, 1)
+    assert QtCompat.QMouseEvent.scenePosition(mouse_event) == QtCore.QPointF(2, 2)
+
 
 def test_cli():
     """Qt.py is available from the command-line"""