Qt Toolkit - QMouseEvent Class

# QMouseEvent Class Reference

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

`#include <qevent.h>`

Inherits QEvent.

List of all member functions.

## Public Members

- QMouseEvent ( int type, const QPoint & pos, int button, int state )
- QMouseEvent ( int type, const QPoint & pos, const QPoint & globalPos, int button, int state )
- const QPoint& pos () const
- const QPoint& globalPos () const
- int x () const
- int y () const
- int globalX () const
- int globalY () const
- int button () const
- int state () const

## Detailed Description

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 only occur when some mouse button is pressed down, unless mouse tracking has been enabled.

Qt makes an automatic mouse grab when a mouse button is pressed inside a widget, and the widget will continue to receive mouse events until the last mouse button is released.

The QWidget::setEnable() function can be used to enable or disable mouse and keyboard events for a widget.

The QCursor widget has static functions for reading and setting the position of the mouse cursor.

The event handlers QWidget::mousePressEvent(), QWidget::mouseReleaseEvent(), QWidget::mouseDoubleClickEvent() and QWidget::mouseMoveEvent() receive mouse events.

See also: QWidget::setMouseTracking() and QWidget::grabMouse().

Examples: qtimage/qtimage.cpp table/table.cpp life/life.cpp dclock/dclock.cpp connect/connect.cpp trivial/trivial.cpp tooltip/tooltip.cpp hello/hello.cpp movies/main.cpp qmag/qmag.cpp showimg/showimg.cpp biff/biff.cpp widgets/widgets.cpp

## Member Function Documentation

### QMouseEvent::QMouseEvent ( int type, const QPoint & pos, int button, int state )

Constructs a mouse event object.

The type parameter must be `Event_MouseButtonPress, Event_MouseButtonRelease, Event_MouseButtonDblClick` or `Event_MouseMove.`

### int QMouseEvent::button () const

Returns the button that caused the event.

Possible return values are `LeftButton, RightButton, MidButton` and `NoButton.`

Note that the returned value is always `NoButton` (0) for mouse move events.

See also: state().

Examples: dclock/dclock.cpp movies/main.cpp widgets/widgets.cpp

### const QPoint & QMouseEvent::globalPos () const

Returns the global position of the mouse pointer at the time of the event

See also: globalX() and globalY().

### int QMouseEvent::globalX () const

Returns the global X position of the mouse pointer at the time of the event

See also: globalY() and globalPos().

### int QMouseEvent::globalY () const

Returns the global Y position of the mouse pointer at the time of the event

See also: globalX() and globalPos().

### const QPoint & QMouseEvent::pos () const

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

See also: x() and y().

Examples: qtimage/qtimage.cpp connect/connect.cpp tooltip/tooltip.cpp hello/hello.cpp qmag/qmag.cpp

### int QMouseEvent::state () const

Returns the button state (a combination of mouse buttons and keyboard modifiers), i.e. what buttons and keys were being held depressed immediately before the event was generated.

Note that this means that for `Event_MouseButtonPress` and `Event_MouseButtonDblClick,` the flag for the button() itself will not be set in the state; while for `Event_MouseButtonRelease,` it will.

The returned value is `LeftButton, RightButton, MidButton, ShiftButton, ControlButton` and `AltButton` OR'ed together.

See also: button().

Examples: movies/main.cpp widgets/widgets.cpp

### int QMouseEvent::x () const

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

See also: y() and pos().

### int QMouseEvent::y () const

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

See also: x() and pos().

Search the documentation, FAQ, qt-interest archive and more (uses www.troll.no):

This file is part of the Qt toolkit, copyright © 1995-99 Troll Tech, all rights reserved.

It was generated from the following files:

- qevent.h: 1998/10/05
- qdnd_x11.cpp: 1998/12/17
- qevent.cpp: 1999/01/13