QWheelEvent Class Reference
^{^{[QtGui module]}}

The QWheelEvent class contains parameters that describe a wheel event. More...

Methods

__init__ (self, QPoint pos, int delta, Qt.MouseButtons buttons, Qt.KeyboardModifiers modifiers, Qt.Orientation orientation = Qt.Vertical)
__init__ (self, QPoint pos, QPoint globalPos, int delta, Qt.MouseButtons buttons, Qt.KeyboardModifiers modifiers, Qt.Orientation orientation = Qt.Vertical)
__init__ (self, QWheelEvent)
Qt.MouseButtons buttons (self)
int delta (self)
QPoint globalPos (self)
int globalX (self)
int globalY (self)
Qt.Orientation orientation (self)
QPoint pos (self)
int x (self)
int y (self)

Detailed Description

The QWheelEvent class contains parameters that describe a wheel event.

Wheel events are sent to the widget under the mouse cursor, but if that widget does not handle the event they are sent to the focus widget. The rotation distance is provided by delta(). The functions pos() and globalPos() return the mouse cursor's location at the time of the event.

A wheel event contains a special accept flag that indicates whether the receiver wants the event. You should call ignore() if you do not handle the wheel event; this ensures that it will be sent to the parent widget.

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

The event handler QWidget.wheelEvent() receives wheel events.

Method Documentation

QWheelEvent.init (self, QPoint pos, int delta, Qt.MouseButtons buttons, Qt.KeyboardModifiers modifiers, Qt.Orientation orientation = Qt.Vertical)

Constructs a wheel event object.

The position, pos, is the location of the mouse cursor within the widget. The globalPos() is initialized to QCursor.pos() which is usually, but not always, correct. Use the other constructor if you need to specify the global position explicitly.

The buttons describe the state of the mouse buttons at the time of the event, delta contains the rotation distance, modifiers holds the keyboard modifier flags at the time of the event, and orient holds the wheel's orientation.

See also pos(), delta(), and state().

QWheelEvent.init (self, QPoint pos, QPoint globalPos, int delta, Qt.MouseButtons buttons, Qt.KeyboardModifiers modifiers, Qt.Orientation orientation = Qt.Vertical)

Constructs a wheel event object.

The pos provides the location of the mouse cursor within the widget. The position in global coordinates is specified by globalPos. delta contains the rotation distance, modifiers holds the keyboard modifier flags at the time of the event, and orient holds the wheel's orientation.

See also pos(), globalPos(), delta(), and state().

QWheelEvent.init (self, QWheelEvent)

Qt.MouseButtons QWheelEvent.buttons (self)

Returns the mouse state when the event occurred.

int QWheelEvent.delta (self)

Returns the distance that the wheel is rotated, in eighths of a degree. A positive value indicates that the wheel was rotated forwards away from the user; a negative value indicates that the wheel was rotated backwards toward the user.

Most mouse types work in steps of 15 degrees, in which case the delta value is a multiple of 120; i.e., 120 units * 1/8 = 15 degrees.

However, some mice have finer-resolution wheels and send delta values that are less than 120 units (less than 15 degrees). To support this possibility, you can either cumulatively add the delta values from events until the value of 120 is reached, then scroll the widget, or you can partially scroll the widget in response to each wheel event.

Example:

 void MyWidget.wheelEvent(QWheelEvent *event)
 {
     int numDegrees = event->delta() / 8;
     int numSteps = numDegrees / 15;

     if (event->orientation() == Qt.Horizontal) {
         scrollHorizontally(numSteps);
     } else {
         scrollVertically(numSteps);
     }
     event->accept();
 }

QPoint QWheelEvent.globalPos (self)

Returns the global position of the mouse pointer at the time of the event. This is important on asynchronous window systems such as X11; whenever you move your widgets around in response to mouse events, globalPos() can differ a lot from the current cursor position returned by QCursor.pos().

See also globalX() and globalY().