KWayland::Client::Pointer

KWayland::Client::Pointer Class Reference

#include <pointer.h>

Inheritance diagram for KWayland::Client::Pointer:

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 ()
 
SurfaceenteredSurface () const
 
SurfaceenteredSurface ()
 
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)
 
- 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 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
 
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 (QObject *object)
 
qobject_cast (const 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

- Properties inherited from QObject
 objectName
 
- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &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

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

Definition at line 32 of file pointer.h.

Member Function Documentation

void KWayland::Client::Pointer::axisChanged ( quint32  time,
KWayland::Client::Pointer::Axis  axis,
qreal  delta 
)
signal

Scroll and other axis notifications.

Parameters
timetimestamp with millisecond granularity
axisVertical or Horizontal
delta
void KWayland::Client::Pointer::axisDiscreteChanged ( KWayland::Client::Pointer::Axis  axis,
qint32  discreteDelta 
)
signal

Discrete step information for scroll and other axes.

Since
5.59
void KWayland::Client::Pointer::axisSourceChanged ( KWayland::Client::Pointer::AxisSource  source)
signal

Indicates the source of scroll and other axes.

Since
5.59
void KWayland::Client::Pointer::axisStopped ( quint32  time,
KWayland::Client::Pointer::Axis  axis 
)
signal

Stop notification for scroll and other axes.

Since
5.59
void KWayland::Client::Pointer::buttonStateChanged ( quint32  serial,
quint32  time,
quint32  button,
KWayland::Client::Pointer::ButtonState  state 
)
signal

Mouse button click and release notifications.

The location of the click is given by the last motion or enter event.

Parameters
serialThe serial of this button state change
timetimestamp with millisecond granularity, with an undefined base.
buttonThe button which got changed
stateReleased or Pressed
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 101 of file pointer.cpp.

void KWayland::Client::Pointer::entered ( quint32  serial,
const QPointF relativeToSurface 
)
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
serialThe serial for this enter
relativeToSurfaceCoordinates relative to the upper-left corner of the Surface.
Surface * KWayland::Client::Pointer::enteredSurface ( ) const
Returns
The Surface the Pointer is on, may be null.

Definition at line 234 of file pointer.cpp.

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.

Definition at line 229 of file pointer.cpp.

void KWayland::Client::Pointer::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
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 224 of file pointer.cpp.

bool KWayland::Client::Pointer::isValid ( ) const
Returns
true if managing a wl_pointer.

Definition at line 239 of file pointer.cpp.

void KWayland::Client::Pointer::left ( quint32  serial)
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
serialThe serial of this leave event
void KWayland::Client::Pointer::motion ( const QPointF relativeToSurface,
quint32  time 
)
signal

Notification of pointer location change.

Parameters
relativeToSurfaceCoordinates relative to the upper-left corner of the entered Surface.
timetimestamp with millisecond granularity
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 96 of file pointer.cpp.

void KWayland::Client::Pointer::setCursor ( Surface surface,
const QPoint hotspot = QPoint() 
)

Sets the cursor image for this Pointer.

This has only an effect if a Surface of the same client is focused.

Parameters
surfaceThe Surface pointing to the image data, if null the cursor will be hidden
hotspotThe hotspot of the cursor image
See also
hideCursor
Since
5.3

Definition at line 214 of file pointer.cpp.

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 106 of file pointer.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed May 27 2020 23:04:41 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.