Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.trolltech.qt.gui
Class QWheelEvent

    java.lang.Object
      com.trolltech.qt.internal.QSignalEmitterInternal
          com.trolltech.qt.QSignalEmitter
              com.trolltech.qt.QtJambiObject
                  com.trolltech.qt.core.QEvent
                      com.trolltech.qt.gui.QInputEvent
                          com.trolltech.qt.gui.QWheelEvent

All Implemented Interfaces:
  QtJambiInterface

    public class QWheelEvent

extends QInputEvent

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.

See also:
  `QMouseEvent`, and `QWidget::grabMouse()`.

Nested Class Summary

Nested classes/interfaces inherited from class com.trolltech.qt.core.QEvent
`QEvent.Type`

Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
`QSignalEmitter.AbstractSignal, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9`

Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
`com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal`

Field Summary

Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
`currentSender`

Constructor Summary
`QWheelEvent(QPoint pos, int delta, Qt.MouseButtons buttons, Qt.KeyboardModifiers modifiers)` Constructs a wheel event object.
`QWheelEvent(QPoint pos, int delta, Qt.MouseButtons buttons, Qt.KeyboardModifiers modifiers, Qt.Orientation orient)` Constructs a wheel event object.
`QWheelEvent(QPoint pos, QPoint globalPos, int delta, Qt.MouseButtons buttons, Qt.KeyboardModifiers modifiers)` Constructs a wheel event object.
`QWheelEvent(QPoint pos, QPoint globalPos, int delta, Qt.MouseButtons buttons, Qt.KeyboardModifiers modifiers, Qt.Orientation orient)` Constructs a wheel event object.

Method Summary
`Qt.MouseButtons` | `buttons()` Returns the mouse state when the event occurred.
`int` | `delta()` Returns the distance that the wheel is rotated, in eighths of a degree.
`protected QPoint` | `g()`
`QPoint` | `globalPos()` Returns the global position of the mouse pointer at the time of the event.
`int` | `globalX()` Returns the global x position of the mouse cursor at the time of the event.
`int` | `globalY()` Returns the global y position of the mouse cursor at the time of the event.
`protected Qt.MouseButtons` | `mouseState()`
`protected Qt.Orientation` | `o()`
`Qt.Orientation` | `orientation()` Returns the wheel's orientation.
`protected QPoint` | `p()`
`QPoint` | `pos()` Returns the position of the mouse cursor relative to the widget that received the event.
`protected void` | `setG(QPoint g)`
`protected void` | `setMouseState(Qt.MouseButtons mouseState)`
`protected void` | `setO(Qt.Orientation o)`
`protected void` | `setP(QPoint p)`
`java.lang.String` | `toString()` Returns a string representation of the `this QWheelEvent`.
`int` | `x()` Returns the x position of the mouse cursor, relative to the widget that received the event.
`int` | `y()` Returns the y position of the mouse cursor, relative to the widget that received the event.

Methods inherited from class com.trolltech.qt.gui.QInputEvent
`modifiers, modState, setModState`

Methods inherited from class com.trolltech.qt.core.QEvent
`accept, ignore, isAccepted, registerEventType, registerEventType, setAccepted, setT, spontaneous, t, type`

Methods inherited from class com.trolltech.qt.QtJambiObject
`dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr`

Methods inherited from class com.trolltech.qt.QSignalEmitter
`blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread`

Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
`__qt_signalInitialization`

Methods inherited from class java.lang.Object
`clone, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface com.trolltech.qt.QtJambiInterface
`disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership`

Constructor Detail

### QWheelEvent

    public QWheelEvent(QPoint pos,
                       QPoint globalPos,
                       int delta,
                       Qt.MouseButtons buttons,
                       Qt.KeyboardModifiers modifiers)

  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

    public QWheelEvent(QPoint pos,
                       QPoint globalPos,
                       int delta,
                       Qt.MouseButtons buttons,
                       Qt.KeyboardModifiers modifiers,
                       Qt.Orientation orient)

  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

    public QWheelEvent(QPoint pos,
                       int delta,
                       Qt.MouseButtons buttons,
                       Qt.KeyboardModifiers modifiers)

  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

    public QWheelEvent(QPoint pos,
                       int delta,
                       Qt.MouseButtons buttons,
                       Qt.KeyboardModifiers modifiers,
                       Qt.Orientation orient)

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

Method Detail

### buttons

    public final Qt.MouseButtons buttons()

  Returns the mouse state when the event occurred.

### delta

    public final int delta()

  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 * 1/8 = 15.

  Example:

              public void wheelEvent(QWheelEvent event)
              {
                  int numDegrees = event.delta() / 8;
                  int numSteps = numDegrees / 15;

                  if (event.orientation().equals(Qt.Orientation.Horizontal)) {
                      scrollHorizontally(numSteps);
                  } else {
                      scrollVertically(numSteps);
                  }
                  event.accept();
              }

### globalPos

    public final QPoint globalPos()

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

### globalX

    public final int globalX()

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

See also:
  `globalY()`, and `globalPos()`.

### globalY

    public final int globalY()

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

See also:
  `globalX()`, and `globalPos()`.

### orientation

    public final Qt.Orientation orientation()

  Returns the wheel's orientation.

### pos

    public final QPoint pos()

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

  If you move your widgets around in response to mouse events, use `globalPos()` instead of this function.

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

### x

    public final int x()

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

See also:
  `y()`, and `pos()`.

### y

    public final int y()

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

See also:
  `x()`, and `pos()`.

### setG

    protected final void setG(QPoint g)

### g

    protected final QPoint g()

### setMouseState

    protected final void setMouseState(Qt.MouseButtons mouseState)

### mouseState

    protected final Qt.MouseButtons mouseState()

### setO

    protected final void setO(Qt.Orientation o)

### o

    protected final Qt.Orientation o()

### setP

    protected final void setP(QPoint p)

### p

    protected final QPoint p()

### toString

    public java.lang.String toString()

  Returns a string representation of the `this QWheelEvent`.

  Overrides:
    `toString` in class `QInputEvent`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD