KWayland::Client::Pointer
#include <pointer.h>

Public Types | |
enum | Axis { Vertical, Horizontal } |
enum | AxisSource { Wheel, Finger, Continuous, WheelTilt } |
enum | ButtonState { Released, Pressed } |
Signals | |
void | axisChanged (quint32 time, KWayland::Client::Pointer::Axis axis, qreal delta) |
void | axisDiscreteChanged (KWayland::Client::Pointer::Axis axis, qint32 discreteDelta) |
void | axisSourceChanged (KWayland::Client::Pointer::AxisSource source) |
void | axisStopped (quint32 time, KWayland::Client::Pointer::Axis axis) |
void | buttonStateChanged (quint32 serial, quint32 time, quint32 button, KWayland::Client::Pointer::ButtonState state) |
void | entered (quint32 serial, const QPointF &relativeToSurface) |
void | frame () |
void | left (quint32 serial) |
void | motion (const QPointF &relativeToSurface, quint32 time) |
Public Member Functions | |
Pointer (QObject *parent=nullptr) | |
void | destroy () |
Surface * | enteredSurface () |
Surface * | enteredSurface () const |
void | hideCursor () |
bool | isValid () const |
operator wl_pointer * () | |
operator wl_pointer * () const | |
void | release () |
void | setCursor (Surface *surface, const QPoint &hotspot=QPoint()) |
void | setup (wl_pointer *pointer) |
![]() | |
QObject (QObject *parent) | |
bool | blockSignals (bool block) |
const QObjectList & | children () 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< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, 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 QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () 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 | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
T | qobject_cast (const QObject *object) |
T | 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) |
QThread * | thread () const const |
Additional Inherited Members | |
![]() | |
objectName | |
![]() | |
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) |
![]() | |
typedef | QObjectList |
![]() | |
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 |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
Wrapper for the wl_pointer interface.
This class is a convenient wrapper for the wl_pointer interface.
To create an instance use Seat::createPointer.
- See also
- Seat
Member Function Documentation
◆ axisChanged
|
signal |
Scroll and other axis notifications.
- Parameters
-
time timestamp with millisecond granularity axis Vertical
orHorizontal
delta
◆ axisDiscreteChanged
|
signal |
Discrete step information for scroll and other axes.
- Since
- 5.59
◆ axisSourceChanged
|
signal |
Indicates the source of scroll and other axes.
- Since
- 5.59
◆ axisStopped
|
signal |
Stop notification for scroll and other axes.
- Since
- 5.59
◆ buttonStateChanged
|
signal |
Mouse button click and release notifications.
The location of the click is given by the last motion or enter event.
- Parameters
-
serial The serial of this button state change time timestamp with millisecond granularity, with an undefined base. button The button which got changed state Released
orPressed
◆ destroy()
void KWayland::Client::Pointer::destroy | ( | ) |
Destroys the data held by this Pointer.
This method is supposed to be used when the connection to the Wayland server goes away. If the connection is not valid anymore, it's not possible to call release anymore as that calls into the Wayland connection and the call would fail. This method cleans up the data, so that the instance can be deleted or set up to a new wl_pointer interface once there is a new connection available.
This method is automatically invoked when the Seat which created this Pointer gets destroyed.
- See also
- release
Definition at line 90 of file pointer.cpp.
◆ entered
|
signal |
Notification that this seat's pointer is focused on a certain surface.
When an seat's focus enters a surface, the pointer image is undefined and a client should respond to this event by setting an appropriate pointer image with the set_cursor request.
- Parameters
-
serial The serial for this enter relativeToSurface Coordinates relative to the upper-left corner of the Surface.
◆ enteredSurface() [1/2]
Surface* KWayland::Client::Pointer::enteredSurface | ( | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
◆ enteredSurface() [2/2]
Surface * KWayland::Client::Pointer::enteredSurface | ( | ) | const |
Definition at line 217 of file pointer.cpp.
◆ frame
|
signal |
Indicates the end of a set of events that logically belong together.
A client is expected to accumulate the data in all events within the frame before proceeding.
- Since
- 5.45
◆ hideCursor()
void KWayland::Client::Pointer::hideCursor | ( | ) |
Hides the cursor.
Same as calling setCursor with null
for surface.
- See also
- setCursor
- Since
- 5.3
Definition at line 212 of file pointer.cpp.
◆ isValid()
bool KWayland::Client::Pointer::isValid | ( | ) | const |
- Returns
true
if managing a wl_pointer.
Definition at line 227 of file pointer.cpp.
◆ left
|
signal |
Notification that this seat's pointer is no longer focused on a certain surface.
The leave notification is sent before the enter notification for the new focus.
- Parameters
-
serial The serial of this leave event
◆ motion
|
signal |
Notification of pointer location change.
- Parameters
-
relativeToSurface Coordinates relative to the upper-left corner of the entered Surface. time timestamp with millisecond granularity
◆ release()
void KWayland::Client::Pointer::release | ( | ) |
Releases the wl_pointer interface.
After the interface has been released the Pointer instance is no longer valid and can be setup with another wl_pointer interface.
This method is automatically invoked when the Seat which created this Pointer gets released.
Definition at line 85 of file pointer.cpp.
◆ setCursor()
Sets the cursor image for this Pointer.
This has only an effect if a Surface of the same client is focused.
- Parameters
-
surface The Surface pointing to the image data, if null
the cursor will be hiddenhotspot The hotspot of the cursor image
- See also
- hideCursor
- Since
- 5.3
Definition at line 202 of file pointer.cpp.
◆ setup()
void KWayland::Client::Pointer::setup | ( | wl_pointer * | pointer | ) |
Setup this Pointer to manage the pointer
.
When using Seat::createPointer there is no need to call this method.
Definition at line 95 of file pointer.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sun Feb 5 2023 03:56:52 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.