Obsolete Members for QMouseEvent

The following members of class QMouseEvent are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.

Public Functions

(deprecated (6.4)) QMouseEvent(QEvent::Type type, const QPointF &localPos, Qt::MouseButton button, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, const QPointingDevice *device = QPointingDevice::primaryPointingDevice())
(deprecated (6.0)) QPoint globalPos() const
(deprecated (6.0)) int globalX() const
(deprecated (6.0)) int globalY() const
(deprecated (6.0)) QPointF localPos() const
(deprecated (6.0)) QPoint pos() const
(deprecated (6.0)) QPointF screenPos() const
(deprecated (6.0)) Qt::MouseEventSource source() const
(deprecated (6.0)) QPointF windowPos() const
(deprecated (6.0)) int x() const
(deprecated (6.0)) int y() const

Member Function Documentation

QMouseEvent::QMouseEvent(QEvent::Type type, const QPointF &localPos, Qt::MouseButton button, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, const QPointingDevice *device = QPointingDevice::primaryPointingDevice())

This function is deprecated since 6.4. We strongly advise against using it in new code.

Use another constructor instead (global position is required).

Constructs a mouse event object originating from device.

The type parameter must be one of QEvent::MouseButtonPress, QEvent::MouseButtonRelease, QEvent::MouseButtonDblClick, or QEvent::MouseMove.

The localPos is the mouse cursor's position relative to the receiving widget or item. The window position is set to the same value as localPos. The button that caused the event is given as a value from the Qt::MouseButton enum. If the event type is MouseMove, the appropriate button for this event is Qt::NoButton. The mouse and keyboard states at the time of the event are specified by buttons and modifiers.

The globalPosition() is initialized to QCursor::pos(), which may not be appropriate. Use the other constructor to specify the global position explicitly.

QPoint QMouseEvent::globalPos() const

This function is deprecated since 6.0. We strongly advise against using it in new code.

Use globalPosition().toPoint() instead.

Returns the global position of the mouse cursor at the time of the event. This is important on asynchronous window systems like X11. Whenever you move your widgets around in response to mouse events, globalPos() may differ a lot from the current pointer position QCursor::pos(), and from QWidget::mapToGlobal(pos()).

See also globalX() and globalY().

int QMouseEvent::globalX() const

This function is deprecated since 6.0. We strongly advise against using it in new code.

Use globalPosition().x() instead.

Returns the global x position of the mouse cursor at the time of the event.

See also globalY() and globalPos().

int QMouseEvent::globalY() const

This function is deprecated since 6.0. We strongly advise against using it in new code.

Use globalPosition().y() instead.

Returns the global y position of the mouse cursor at the time of the event.

See also globalX() and globalPos().

[since 5.0] QPointF QMouseEvent::localPos() const

This function is deprecated since 6.0. We strongly advise against using it in new code.

Use position() instead.

Returns the position of the mouse cursor as a QPointF, relative to the widget or item that received the event.

If you move the widget as a result of the mouse event, use the screen position returned by screenPos() to avoid a shaking motion.

This function was introduced in Qt 5.0.

See also x(), y(), windowPos(), and screenPos().

QPoint QMouseEvent::pos() const

This function is deprecated since 6.0. We strongly advise against using it in new code.

Use position() instead.

Returns the position of the mouse cursor, relative to the widget that received the event.

If you move the widget as a result of the mouse event, use the global position returned by globalPos() to avoid a shaking motion.

See also x(), y(), and globalPos().

[since 5.0] QPointF QMouseEvent::screenPos() const

This function is deprecated since 6.0. We strongly advise against using it in new code.

Use globalPosition() instead.

Returns the position of the mouse cursor as a QPointF, relative to the screen that received the event.

This function was introduced in Qt 5.0.

See also x(), y(), pos(), localPos(), and windowPos().

[since 5.3] Qt::MouseEventSource QMouseEvent::source() const

This function is deprecated since 6.0. We strongly advise against using it in new code.

Use pointingDevice() instead.

Returns information about the mouse event source.

The mouse event source can be used to distinguish between genuine and artificial mouse events. The latter are events that are synthesized from touch events by the operating system or Qt itself. This enum tells you from where it was synthesized; but often it's more useful to know from which device it was synthesized, so try to use pointingDevice() instead.

Note: Many platforms provide no such information. On such platforms Qt::MouseEventNotSynthesized is returned always.

Note: In Qt 5-based code, source() was often used to attempt to distinguish mouse events from an actual mouse vs. those that were synthesized because some legacy QQuickItem or QWidget subclass did not react to a QTouchEvent. However, you could not tell whether it was synthesized from a QTouchEvent or a QTabletEvent, and other information was lost. pointingDevice() tells you the specific device that it came from, so you might check pointingDevice()->type() or pointingDevice()->capabilities() to decide how to react to this event. But it's even better to react to the original event rather than handling only mouse events.

This function was introduced in Qt 5.3.

See also Qt::MouseEventSource and QGraphicsSceneMouseEvent::source().

[since 5.0] QPointF QMouseEvent::windowPos() const

This function is deprecated since 6.0. We strongly advise against using it in new code.

Use scenePosition() instead.

Returns the position of the mouse cursor as a QPointF, relative to the window that received the event.

If you move the widget as a result of the mouse event, use the global position returned by globalPos() to avoid a shaking motion.

This function was introduced in Qt 5.0.

See also x(), y(), pos(), localPos(), and screenPos().

int QMouseEvent::x() const

This function is deprecated since 6.0. We strongly advise against using it in new code.

Use position().x() instead.

Returns the x position of the mouse cursor, relative to the widget that received the event.

See also y() and pos().

int QMouseEvent::y() const

This function is deprecated since 6.0. We strongly advise against using it in new code.

Use position().y() instead.

Returns the y position of the mouse cursor, relative to the widget that received the event.

See also x() and pos().

© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.