KWayland::Client::RelativePointer Class Reference

#include <relativepointer.h>

Inheritance diagram for KWayland::Client::RelativePointer:

Signals
void	relativeMotion (const QSizeF &delta, const QSizeF &deltaNonAccelerated, quint64 timestamp)

Public Member Functions
void	destroy ()
bool	isValid () const
	operator zwp_relative_pointer_v1 * ()
	operator zwp_relative_pointer_v1 * () const
void	release ()
void	setup (zwp_relative_pointer_v1 *relativepointerunstablev1)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const
bool	disconnect (const QObject *receiver, const char *method) const
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
bool	inherits (const char *className) const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const
bool	isWindowType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
QString	objectName () const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const
QVariant	property (const char *name) const
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval, Qt::TimerType timerType)
QThread *	thread () 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)
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
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Wrapper for the zwp_relative_pointer_v1 interface.

The RelativePointer is an extension to the Pointer used for emitting relative pointer events. It shares the same focus as Pointer of the same Seat and will only emit events when it has focus.

Since

5.28

Definition at line 150 of file relativepointer.h.

Member Function Documentation

void KWayland::Client::RelativePointer::destroy

(

)

Destroys the data held by this RelativePointerUnstableV1.

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 zwp_relative_pointer_v1 interface once there is a new connection available.

This method is automatically invoked when the Registry which created this RelativePointer gets destroyed.

See also

release

Definition at line 175 of file relativepointer.cpp.

bool KWayland::Client::RelativePointer::isValid

(

)

const

Returns

true if managing a zwp_relative_pointer_v1.

Definition at line 188 of file relativepointer.cpp.

void KWayland::Client::RelativePointer::relativeMotion ( const QSizeF &  delta, const QSizeF &  deltaNonAccelerated, quint64  timestamp  )

signal

A relative motion event.

A relative motion is in the same dimension as regular motion events, except they do not represent an absolute position. For example, moving a pointer from (x, y) to (x', y') would have the equivalent relative motion (x' - x, y' - y). If a pointer motion caused the absolute pointer position to be clipped by for example the edge of the monitor, the relative motion is unaffected by the clipping and will represent the unclipped motion.

This signal also contains non-accelerated motion deltas (deltaNonAccelerated). The non-accelerated delta is, when applicable, the regular pointer motion delta as it was before having applied motion acceleration and other transformations such as normalization.

Note that the non-accelerated delta does not represent 'raw' events as they were read from some device. Pointer motion acceleration is device- and configuration-specific and non-accelerated deltas and accelerated deltas may have the same value on some devices.

Relative motions are not coupled to Pointer motion events, and can be sent in combination with such events, but also independently. There may also be scenarios where Pointer motion is sent, but there is no relative motion. The order of an absolute and relative motion event originating from the same physical motion is not guaranteed.

Parameters

delta	Motion vector
deltaNonAccelerated	non-accelerated motion vector
microseconds	timestamp with microseconds granularity

void KWayland::Client::RelativePointer::release

(

)

Releases the zwp_relative_pointer_v1 interface.

After the interface has been released the RelativePointerUnstableV1 instance is no longer valid and can be setup with another zwp_relative_pointer_v1 interface.

Definition at line 170 of file relativepointer.cpp.

void KWayland::Client::RelativePointer::setup

(

zwp_relative_pointer_v1 *

relativepointerunstablev1

)

Setup this RelativePointerUnstableV1 to manage the relativepointerunstablev1.

When using RelativePointerManagerUnstableV1::createRelativePointerUnstableV1 there is no need to call this method.

Definition at line 165 of file relativepointer.cpp.

---

The documentation for this class was generated from the following files:

• relativepointer.h
• relativepointer.cpp