 |
Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
|
Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
\inmodule QtGui More...
#include <qevent.h>
Inheritance diagram for QMouseEvent: Collaboration diagram for QMouseEvent:Public Member Functions | |
| QMouseEvent (Type type, const QPointF &localPos, const QPointF &globalPos, Qt::MouseButton button, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, const QPointingDevice *device=QPointingDevice::primaryPointingDevice()) | |
| Constructs a mouse event object originating from device. | |
| QMouseEvent (Type type, const QPointF &localPos, const QPointF &scenePos, const QPointF &globalPos, Qt::MouseButton button, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, const QPointingDevice *device=QPointingDevice::primaryPointingDevice()) | |
| QMouseEvent (Type type, const QPointF &localPos, const QPointF &scenePos, const QPointF &globalPos, Qt::MouseButton button, Qt::MouseButtons buttons, Qt::KeyboardModifiers modifiers, Qt::MouseEventSource source, const QPointingDevice *device=QPointingDevice::primaryPointingDevice()) | |
| QPoint | pos () const |
| Qt::MouseEventSource | source () const |
| Qt::MouseEventFlags | flags () const |
| Public Member Functions inherited from QSinglePointEvent | |
| Qt::MouseButton | button () const |
| Returns the button that caused the event. | |
| Qt::MouseButtons | buttons () const |
| Returns the button state when the event was generated. | |
| QPointF | position () const |
| Returns the position of the point in this event, relative to the widget or item that received the event. | |
| QPointF | scenePosition () const |
| Returns the position of the point in this event, relative to the window or scene. | |
| QPointF | globalPosition () const |
| Returns the position of the point in this event on the screen or virtual desktop. | |
| bool | isBeginEvent () const override |
Returns true if this event represents a \l {button()}{button} being pressed. | |
| bool | isUpdateEvent () const override |
Returns true if this event does not include a change in \l {buttons()}{button state}. | |
| bool | isEndEvent () const override |
Returns true if this event represents a \l {button()}{button} being released. | |
| QObject * | exclusivePointGrabber () const |
| void | setExclusivePointGrabber (QObject *exclusiveGrabber) |
| Public Member Functions inherited from QPointerEvent | |
| QPointerEvent (Type type, const QPointingDevice *dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier, const QList< QEventPoint > &points={}) | |
| const QPointingDevice * | pointingDevice () const |
| Returns the source device from which this event originates. | |
| QPointingDevice::PointerType | pointerType () const |
| Returns the type of point that generated the event. | |
| void | setTimestamp (quint64 timestamp) override |
| qsizetype | pointCount () const |
| Returns the number of points in this pointer event. | |
| QEventPoint & | point (qsizetype i) |
| Returns a QEventPoint reference for the point at index i. | |
| const QList< QEventPoint > & | points () const |
| Returns a list of points in this pointer event. | |
| QEventPoint * | pointById (int id) |
Returns the point whose \l {QEventPoint::id()}{id} matches the given id, or nullptr if no such point is found. | |
| bool | allPointsGrabbed () const |
Returns true if every point in points() has either an exclusiveGrabber() or one or more passiveGrabbers(). | |
| bool | allPointsAccepted () const |
Returns true if isPointAccepted() is true for every point in points(); otherwise false. | |
| virtual void | setAccepted (bool accepted) override |
| \reimp | |
| QObject * | exclusiveGrabber (const QEventPoint &point) const |
| Returns the object which has been set to receive all future update events and the release event containing the given point. | |
| void | setExclusiveGrabber (const QEventPoint &point, QObject *exclusiveGrabber) |
| Informs the delivery logic that the given exclusiveGrabber is to receive all future update events and the release event containing the given point, and that delivery to other items can be skipped. | |
| QList< QPointer< QObject > > | passiveGrabbers (const QEventPoint &point) const |
| Returns the list of objects that have been requested to receive all future update events and the release event containing the given point. | |
| void | clearPassiveGrabbers (const QEventPoint &point) |
| Removes all passive grabbers from the given point. | |
| bool | addPassiveGrabber (const QEventPoint &point, QObject *grabber) |
| Informs the delivery logic that the given grabber is to receive all future update events and the release event containing the given point, regardless where else those events may be delivered. | |
| bool | removePassiveGrabber (const QEventPoint &point, QObject *grabber) |
| Removes the passive grabber from the given point if it was previously added. | |
| Public Member Functions inherited from QInputEvent | |
| QInputEvent (Type type, const QInputDevice *m_dev, Qt::KeyboardModifiers modifiers=Qt::NoModifier) | |
| const QInputDevice * | device () const |
| QInputDevice::DeviceType | deviceType () const |
| Returns the type of device that generated the event. | |
| Qt::KeyboardModifiers | modifiers () const |
| Returns the keyboard modifier flags that existed immediately before the event occurred. | |
| void | setModifiers (Qt::KeyboardModifiers modifiers) |
| quint64 | timestamp () const |
| Returns the window system's timestamp for this event. | |
| Public Member Functions inherited from QEvent | |
| QEvent (Type type) | |
| Constructs an event object of type type. | |
| virtual | ~QEvent () |
| Destroys the event. | |
| Type | type () const |
| Returns the event type. | |
| bool | spontaneous () const |
Returns true if the event originated outside the application (a system event); otherwise returns false. | |
| bool | isAccepted () const |
| void | accept () |
| Sets the accept flag of the event object, the equivalent of calling setAccepted(true). | |
| void | ignore () |
| Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false). | |
| bool | isInputEvent () const noexcept |
| bool | isPointerEvent () const noexcept |
| bool | isSinglePointEvent () const noexcept |
| virtual QEvent * | clone () const |
| Creates and returns an identical copy of this event. | |
\inmodule QtGui
The QMouseEvent class contains parameters that describe a mouse event.
Mouse events occur when a mouse button is pressed or released inside a widget, or when the mouse cursor is moved.
Mouse move events will occur only when a mouse button is pressed down, unless mouse tracking has been enabled with QWidget::setMouseTracking().
Qt automatically grabs the mouse when a mouse button is pressed inside a widget; the widget will continue to receive mouse events until the last mouse button is released.
A mouse event contains a special accept flag that indicates whether the receiver wants the event. You should call ignore() if the mouse event is not handled by your widget. A mouse event is propagated up the parent widget chain until a widget accepts it with accept(), or an event filter consumes it.
The state of the keyboard modifier keys can be found by calling the \l{QInputEvent::modifiers()}{modifiers()} function, inherited from QInputEvent.
The position() function gives the cursor position relative to the widget or item that receives the mouse event. If you move the widget as a result of the mouse event, use the global position returned by globalPosition() to avoid a shaking motion.
The QWidget::setEnabled() function can be used to enable or disable mouse and keyboard events for a widget.
Reimplement the QWidget event handlers, QWidget::mousePressEvent(), QWidget::mouseReleaseEvent(), QWidget::mouseDoubleClickEvent(), and QWidget::mouseMoveEvent() to receive mouse events in your own widgets.
| QMouseEvent::QMouseEvent | ( | Type | type, |
| const QPointF & | localPos, | ||
| const QPointF & | globalPos, | ||
| Qt::MouseButton | button, | ||
| Qt::MouseButtons | buttons, | ||
| Qt::KeyboardModifiers | modifiers, | ||
| const QPointingDevice * | device = QPointingDevice::primaryPointingDevice() ) |
Constructs a mouse event object originating from device.
The type parameter must be 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 cursor's position in screen coordinates is specified by globalPos. The window position is set to the same value as localPos. The button that caused the event is given as a value from the \l Qt::MouseButton enum. If the event type is \l MouseMove, the appropriate button for this event is Qt::NoButton. buttons is the state of all buttons at the time of the event, modifiers the state of all keyboard modifiers.
Definition at line 726 of file qevent.cpp.
| QMouseEvent::QMouseEvent | ( | Type | type, |
| const QPointF & | localPos, | ||
| const QPointF & | scenePos, | ||
| const QPointF & | globalPos, | ||
| Qt::MouseButton | button, | ||
| Qt::MouseButtons | buttons, | ||
| Qt::KeyboardModifiers | modifiers, | ||
| const QPointingDevice * | device = QPointingDevice::primaryPointingDevice() ) |
| QMouseEvent::QMouseEvent | ( | Type | type, |
| const QPointF & | localPos, | ||
| const QPointF & | scenePos, | ||
| const QPointF & | globalPos, | ||
| Qt::MouseButton | button, | ||
| Qt::MouseButtons | buttons, | ||
| Qt::KeyboardModifiers | modifiers, | ||
| Qt::MouseEventSource | source, | ||
| const QPointingDevice * | device = QPointingDevice::primaryPointingDevice() ) |
| Qt::MouseEventFlags QMouseEvent::flags | ( | ) | const |
Returns the mouse event flags.
The mouse event flags provide additional information about a mouse event.
Definition at line 816 of file qevent.cpp.
References QSinglePointEvent::m_doubleClick, Qt::MouseEventCreatedDoubleClick, and Qt::NoMouseEventFlag.
|
inline |
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.
Definition at line 219 of file qevent.h.
References position().
Referenced by QHeaderView::mouseMoveEvent().
Here is the call graph for this function: Here is the caller graph for this function:| Qt::MouseEventSource QMouseEvent::source | ( | ) | const |
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.
{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. Definition at line 801 of file qevent.cpp.
Referenced by QQuickWidget::mouseDoubleClickEvent(), QMenuPrivate::mouseEventTaken(), QMenuBar::mouseMoveEvent(), QQuickWidget::mouseMoveEvent(), QPlainTextEdit::mouseMoveEvent(), QTextEdit::mouseMoveEvent(), QQuickWidget::mousePressEvent(), QQuickWidget::mouseReleaseEvent(), QPlainTextEdit::mouseReleaseEvent(), QTextEdit::mouseReleaseEvent(), PressDelayHandler::pressed(), and PressDelayHandler::sendMouseEvent().
Here is the caller graph for this function:
1.10.0