Qt Jambi Home

com.trolltech.qt.gui
Class QWheelEvent

java.lang.Object
  extended by com.trolltech.qt.QSignalEmitter
      extended by com.trolltech.qt.QtJambiObject
          extended by com.trolltech.qt.core.QEvent
              extended by com.trolltech.qt.gui.QInputEvent
                  extended by 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, 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<A>, QSignalEmitter.Signal2<A,B>, QSignalEmitter.Signal3<A,B,C>, QSignalEmitter.Signal4<A,B,C,D>, QSignalEmitter.Signal5<A,B,C,D,E>, QSignalEmitter.Signal6<A,B,C,D,E,F>, QSignalEmitter.Signal7<A,B,C,D,E,F,G>, QSignalEmitter.Signal8<A,B,C,D,E,F,G,H>, QSignalEmitter.Signal9<A,B,C,D,E,F,G,H,I>
 
Constructor Summary
QWheelEvent(QPoint pos, int delta, Qt.MouseButtons buttons, Qt.KeyboardModifiers modifiers)
          Equivalent to QWheelEvent(pos, delta, buttons, modifiers, Qt::Vertical).
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)
          Equivalent to QWheelEvent(pos, globalPos, delta, buttons, modifiers, Qt::Vertical).
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.
static QWheelEvent fromNativePointer(QNativePointer nativePointer)
          This function returns the QWheelEvent instance pointed to by nativePointer
 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.
 Qt.Orientation orientation()
          Returns the wheel's orientation.
 QPoint pos()
          Returns the position of the mouse cursor relative to the widget that received the event.
protected  void setMouseState(Qt.MouseButton... mouseState)
          Sets the mouse button state of this QWheelEvent to mouseState.
 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, setModState
 
Methods inherited from class com.trolltech.qt.core.QEvent
accept, ignore, isAccepted, setAccepted, setT, spontaneous, t, type
 
Methods inherited from class com.trolltech.qt.QtJambiObject
dispose, disposed, finalize, reassignNativeResources, tr, tr, tr
 
Methods inherited from class com.trolltech.qt.QSignalEmitter
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Constructor Detail

QWheelEvent

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

Equivalent to QWheelEvent(pos, delta, buttons, modifiers, Qt::Vertical).


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, state

QWheelEvent

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

Equivalent to QWheelEvent(pos, globalPos, delta, buttons, modifiers, Qt::Vertical).


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, 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:

    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();
    }


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, globalY

globalX

public final int globalX()

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

See Also:
globalY, globalPos

globalY

public final int globalY()

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

See Also:
globalX, 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, 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, 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, pos

setMouseState

protected final void setMouseState(Qt.MouseButton... mouseState)
Sets the mouse button state of this QWheelEvent to mouseState.


fromNativePointer

public static QWheelEvent fromNativePointer(QNativePointer nativePointer)
This function returns the QWheelEvent instance pointed to by nativePointer

Parameters:
nativePointer - the QNativePointer of which object should be returned.

Qt Jambi Home