Home · All Classes · Modules

QMouseEvent Class Reference
^{[QtGui module]}

The QMouseEvent class contains parameters that describe a mouse event. More...

Inherits QInputEvent.

Methods

• __init__ (self, QEvent.Type type, QPoint pos, Qt.MouseButton button, Qt.MouseButtons buttons, Qt.KeyboardModifiers modifiers)
• __init__ (self, QEvent.Type type, QPoint pos, QPoint globalPos, Qt.MouseButton button, Qt.MouseButtons buttons, Qt.KeyboardModifiers modifiers)
• __init__ (self, QMouseEvent)
• Qt.MouseButton button (self)
• Qt.MouseButtons buttons (self)
• QPoint globalPos (self)
• int globalX (self)
• int globalY (self)
• bool hasExtendedInfo (self)
• QPoint pos (self)
• QPointF posF (self)
• int x (self)
• int y (self)

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.

Note: If a mouse event is propagated to a widget for which Qt.WA_NoMousePropagation has been set, that mouse event will not be propagated further up the parent widget chain.

The state of the keyboard modifier keys can be found by calling the modifiers() function, inherited from QInputEvent.

The functions pos(), x(), and y() give the cursor position relative to the widget that receives the mouse 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.

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.

Method Documentation

QMouseEvent.__init__ (self, QEvent.Type type, QPoint pos, Qt.MouseButton button, Qt.MouseButtons buttons, Qt.KeyboardModifiers modifiers)

Constructs a mouse event object.

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

The position is the mouse cursor's position relative to the receiving widget. 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 globalPos() is initialized to QCursor.pos(), which may not be appropriate. Use the other constructor to specify the global position explicitly.

QMouseEvent.__init__ (self, QEvent.Type type, QPoint pos, QPoint globalPos, Qt.MouseButton button, Qt.MouseButtons buttons, Qt.KeyboardModifiers modifiers)

Constructs a mouse event object.

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

The pos is the mouse cursor's position relative to the receiving widget. The cursor's position in global coordinates is specified by globalPos. 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. buttons is the state of all buttons at the time of the event, modifiers the state of all keyboard modifiers.

QMouseEvent.__init__ (self, QMouseEvent)

Qt.MouseButton QMouseEvent.button (self)

Returns the button that caused the event.

Note that the returned value is always Qt.NoButton for mouse move events.

See also buttons() and Qt.MouseButton.

Qt.MouseButtons QMouseEvent.buttons (self)

Returns the button state when the event was generated. The button state is a combination of Qt.LeftButton, Qt.RightButton, Qt.MidButton using the OR operator. For mouse move events, this is all buttons that are pressed down. For mouse press and double click events this includes the button that caused the event. For mouse release events this excludes the button that caused the event.

See also button() and Qt.MouseButton.

QPoint QMouseEvent.globalPos (self)

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 (self)

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

See also globalY() and globalPos().

int QMouseEvent.globalY (self)

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

See also globalX() and globalPos().

bool QMouseEvent.hasExtendedInfo (self)

QPoint QMouseEvent.pos (self)

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().

QPointF QMouseEvent.posF (self)

Returns the position of the mouse cursor as a QPointF, 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.

This function was introduced in Qt 4.4.

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

int QMouseEvent.x (self)

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

See also y() and pos().

int QMouseEvent.y (self)

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

See also x() and pos().