QWheelEvent(3qt)

📦 version 3.3.8b, in fedora 43, fedora 44

✨ QWheelEvent ✨

okay bestie, gather round, because today we're talking about QWheelEvent — a whole class from the Qt 3qt manual, no less 💅

🌸 NAME 🌸

QWheelEvent — literally just the parameters that describe a wheel event. that's it. that's the whole vibe 🎀

🦋 SYNOPSIS 🦋

#include <qevent.h>

Inherits QEvent. yes queen, it's a whole event 💖

👑 Public Members

QWheelEvent ( const QPoint & pos, int delta, int state, Orientation
    orient = Vertical )
QWheelEvent ( const QPoint & pos, const QPoint & globalPos, int delta,
    int state, Orientation orient = Vertical )
int delta () const
const QPoint & pos () const
const QPoint & globalPos () const
int x () const
int y () const
int globalX () const
int globalY () const
ButtonState state () const
Orientation orientation () const
bool isAccepted () const
void accept ()
void ignore ()

💖 DESCRIPTION 💖

The QWheelEvent class contains parameters that describe a wheel event. scroll girlies rise up 🖱️✨

Wheel events are sent to the widget under the mouse, and 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 pointer location at the time of the event. iconic behaviour honestly.

A wheel event contains a special accept flag that indicates whether the receiver wants the event. you should call QWheelEvent::accept() if you handle the wheel event; otherwise it will be sent to the parent widget. so like, speak up if you want it, bestie 🫶

The QWidget::setEnable() function can be used to enable or disable mouse and keyboard events for a widget. turning things on and off? we love a toggle.

The event handler QWidget::wheelEvent() receives wheel events. that's the one who's actually catching these.

See also QMouseEvent, QWidget::grabMouse(), and Event Classes. the friend group fr fr 🌈

🎀 MEMBER FUNCTION DOCUMENTATION 🎀

QWheelEvent::QWheelEvent ( const QPoint & pos, int delta, int state, Orientation orient = Vertical )

Constructs a wheel event object. brand new, fresh out the box ✨

The globalPos() is initialized to QCursor::pos(), i.e. pos, which is usually (but not always) right. use the other constructor if you need to specify the global position explicitly. delta contains the rotation distance, state 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::QWheelEvent ( const QPoint & pos, const QPoint & globalPos, int delta, int state, Orientation orient = Vertical )

Constructs a wheel event object. the position when the event occurred is given in pos and globalPos. delta contains the rotation distance, state 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().

void QWheelEvent::accept ()

Sets the accept flag of the wheel event object. claiming it. it's yours now 👑

Setting the accept parameter indicates that the receiver of the event wants the wheel event. unwanted wheel events are sent to the parent widget. the reject pile, if you will 💀

The accept flag is set by default. so it's already accepted unless you say otherwise, lowkey generous of it.

See also ignore().

int QWheelEvent::delta () const

Returns the distance that the wheel is rotated expressed in multiples or divisions of the wheel delta, which is currently defined to be 120. 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. so up = positive, down = negative, got it bestie 🍓

The wheel delta constant was defined to be 120 by wheel mouse vendors to allow building finer-resolution wheels in the future, including perhaps a freely rotating wheel with no notches. the expectation is that such a device would send more messages per rotation but with a smaller value in each message. future-proofing? we love to see it 💅

const QPoint & QWheelEvent::globalPos () const

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 pointer position QCursor::pos(). so like, don't assume they match, they are NOT the same girl 😭

See also globalX() and globalY().

int QWheelEvent::globalX () const

Returns the global x-position of the mouse pointer at the time of the event.

See also globalY() and globalPos().

int QWheelEvent::globalY () const

Returns the global y-position of the mouse pointer at the time of the event.

See also globalX() and globalPos().

void QWheelEvent::ignore ()

Clears the accept flag parameter of the wheel event object. not me rejecting the event 🙈

Clearing the accept parameter indicates that the event receiver does not want the wheel event. unwanted wheel events are sent to the parent widget. the accept flag is set by default.

See also accept().

bool QWheelEvent::isAccepted () const

Returns TRUE if the receiver of the event handles the wheel event; otherwise returns FALSE. simple as that, vibe check passed or failed ✨

Orientation QWheelEvent::orientation () const

Returns the wheel's orientation. which way is the wheel wheeling, basically.

const QPoint & QWheelEvent::pos () const

Returns the position of the mouse pointer, 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. okay so read the room and pick the right one, bestie 🫶

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

ButtonState QWheelEvent::state () const

Returns the keyboard modifier flags of the event.

The returned value is ShiftButton, ControlButton, and AltButton OR'ed together. all the modifiers, holding hands 🌸

int QWheelEvent::x () const

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

See also y() and pos().

int QWheelEvent::y () const

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

See also x() and pos().

🌟 SEE ALSO 🌟

go read the docs, they're giving main character energy 📚💜

Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the license file included in the distribution for a complete license statement.

🧚 AUTHOR 🧚

Generated automatically from the source code. no human typed this by hand and honestly? slay, the robots ate 🤖✨

💀 BUGS 💀

If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you. fr fr, the good reports are the ones that actually help 🫶

The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech. so like, the man page is a lil treat, not the canon text 👑

If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qwheelevent.3qt) and the Qt version (3.3.8). don't be vague about it bestie, give them the receipts 📝

and that's the whole page!! this one came from Trolltech AS, dated 2 February 2007, for Qt version 3.3.8, and the man page header said QWheelEvent(3qt) — periodt 💅🎀🦋

📦 where this page comes from