KirigamiWheelEvent

Search for usage in LXR

KirigamiWheelEvent Class Reference

#include <wheelhandler.h>

Inheritance diagram for KirigamiWheelEvent:

Properties

bool accepted
 
QPointF angleDelta
 
int buttons
 
bool inverted
 
int modifiers
 
QPointF pixelDelta
 
qreal x
 
qreal y
 
- Properties inherited from QObject
 objectName
 

Public Member Functions

 KirigamiWheelEvent (QObject *parent=nullptr)
 
QPointF angleDelta () const
 
int buttons () const
 
void initializeFromEvent (QWheelEvent *event)
 
bool inverted () const
 
bool isAccepted ()
 
int modifiers () const
 
QPointF pixelDelta () const
 
void setAccepted (bool accepted)
 
qreal x () const
 
qreal y () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

Describes the mouse wheel event.

Definition at line 21 of file wheelhandler.h.

Property Documentation

◆ accepted

bool KirigamiWheelEvent::accepted
readwrite

accepted: bool

If set, the event shouldn't be managed anymore, for instance it can be used to block the handler to manage the scroll of a view on some scenarios

// This handler handles automatically the scroll of
// flickableItem, unless Ctrl is pressed, in this case the
// app has custom code to handle Ctrl+wheel zooming
Kirigami.WheelHandler {
target: flickableItem
blockTargetWheel: true
scrollFlickableTarget: true
onWheel: {
if (wheel.modifiers & Qt.ControlModifier) {
wheel.accepted = true;
// Handle scaling of the view
}
}
}

Definition at line 106 of file wheelhandler.h.

◆ angleDelta

QPointF KirigamiWheelEvent::angleDelta
read

angleDelta: point

The distance the wheel is rotated in degrees. The x and y coordinates indicate the horizontal and vertical wheels respectively. A positive value indicates it was rotated up/right, negative, bottom/left This value is more likely to be set in traditional mice.

Definition at line 47 of file wheelhandler.h.

◆ buttons

int KirigamiWheelEvent::buttons
read

buttons: int

it contains an OR combination of the buttons that were pressed during the wheel, they can be: Qt.LeftButton, Qt.MiddleButton, Qt.RightButton

Definition at line 62 of file wheelhandler.h.

◆ inverted

bool KirigamiWheelEvent::inverted
read

inverted: bool

Whether the delta values are inverted On some platformsthe returned delta are inverted, so positive values would mean bottom/left

Definition at line 81 of file wheelhandler.h.

◆ modifiers

int KirigamiWheelEvent::modifiers
read

modifiers: int

Keyboard mobifiers that were pressed during the wheel event, such as: Qt.NoModifier (default, no modifiers) Qt.ControlModifier Qt.ShiftModifier ...

Definition at line 73 of file wheelhandler.h.

◆ pixelDelta

QPointF KirigamiWheelEvent::pixelDelta
read

pixelDelta: point

provides the delta in screen pixels available on high resolution trackpads

Definition at line 54 of file wheelhandler.h.

◆ x

qreal KirigamiWheelEvent::x
read

x: real

X coordinate of the mouse pointer

Definition at line 30 of file wheelhandler.h.

◆ y

qreal KirigamiWheelEvent::y
read

y: real

Y coordinate of the mouse pointer

Definition at line 37 of file wheelhandler.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 6 2023 04:13:18 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.