KWayland::Client::PointerSwipeGesture

#include <pointergestures.h>

Inheritance diagram for KWayland::Client::PointerSwipeGesture:

Signals
void	cancelled (quint32 serial, quint32 time)

void	ended (quint32 serial, quint32 time)

void	started (quint32 serial, quint32 time)

void	updated (const QSizeF &delta, quint32 time)

Public Member Functions
void	destroy ()

quint32	fingerCount () const

bool	isValid () const

	operator zwp_pointer_gesture_swipe_v1 * ()

	operator zwp_pointer_gesture_swipe_v1 * () const

void	release ()

void	setup (zwp_pointer_gesture_swipe_v1 *pointerswipegesture)

QPointer< Surface >	surface () const

Public Member Functions inherited from QObject
	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 &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 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 &regExp)

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
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 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

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

This class is a wrapper for the zwp_pointer_gesture_swipe_v1 protocol.

A PointerSwipeGesture object notifies a client about a multi-finger swipe gesture detected on an indirect input device such as a touchpad. The gesture is usually initiated by multiple fingers moving in the same direction but once initiated the direction may change. The precise conditions of when such a gesture is detected are implementation-dependent.

A gesture consists of three stages: begin, update (optional) and end. There cannot be multiple simultaneous pinch or swipe gestures on the same pointer/seat, how compositors prevent these situations is implementation-dependent.

A gesture may be cancelled by the compositor or the hardware. Clients should not consider performing permanent or irreversible actions until the end of a gesture has been received.

See also: PointerGestures; PointerPinchGesture

Since: 5.29

Definition at line 161 of file pointergestures.h.

Member Function Documentation

◆ cancelled

void KWayland::Client::PointerSwipeGesture::cancelled	(	quint32	serial,
		quint32	time
	)

signal

A gesture got cancelled by the Wayland compositor.

Parameters

serial	Unique serial for this cancel gesture event.
time	Timestamp in milliseconds granularity

See also: started; updated; ended

◆ destroy()

void KWayland::Client::PointerSwipeGesture::destroy ( )

Destroys the data held by this PointerSwipeGesture.

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

It is suggested to connect this method to ConnectionThread::connectionDied:

connect(connection, &ConnectionThread::connectionDied, pointerswipegesture, &PointerSwipeGesture::destroy);

See also: release

Definition at line 219 of file pointergestures.cpp.

◆ ended

void KWayland::Client::PointerSwipeGesture::ended	(	quint32	serial,
		quint32	time
	)

signal

A gesture ended.

Parameters

serial	Unique serial for this end gesture event.
time	Timestamp in milliseconds granularity

See also: started; updated; cancelled

◆ fingerCount()

quint32 KWayland::Client::PointerSwipeGesture::fingerCount ( ) const

The number of fingers taking part in this gesture.

If no gesture is in progress 0 is returned.

Definition at line 191 of file pointergestures.cpp.

◆ isValid()

bool KWayland::Client::PointerSwipeGesture::isValid ( ) const

Returns: true if managing a zwp_pointer_gesture_swipe_v1.

Definition at line 234 of file pointergestures.cpp.

◆ release()

void KWayland::Client::PointerSwipeGesture::release ( )

Releases the zwp_pointer_gesture_swipe_v1 interface.

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

Definition at line 214 of file pointergestures.cpp.

◆ setup()

void KWayland::Client::PointerSwipeGesture::setup ( zwp_pointer_gesture_swipe_v1 * pointerswipegesture )

Setup this PointerSwipeGesture to manage the pointerswipegesture.

When using PointerGestures::createPointerSwipeGesture there is no need to call this method.

Definition at line 209 of file pointergestures.cpp.

◆ started

void KWayland::Client::PointerSwipeGesture::started	(	quint32	serial,
		quint32	time
	)

signal

A gesture got started.

Parameters

serial	Unique serial for this start gesture event.
time	Timestamp in milliseconds granularity

See also: updated; ended; cancelled

◆ surface()

QPointer< Surface > KWayland::Client::PointerSwipeGesture::surface ( ) const

The Surface on which this gesture is performed.

If no gesture is in progress the returned pointer is null.

Definition at line 196 of file pointergestures.cpp.

◆ updated

void KWayland::Client::PointerSwipeGesture::updated	(	const QSizeF &	delta,
		quint32	time
	)

signal

A gesture got updated.

Parameters

delta	relative coordinates of the logical center of the gesture compared to the previous event
time	Timestamp in milliseconds granularity

See also: started; ended; cancelled

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

QObject::connect

QMetaObject::Connection connect(const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)

KWayland::Client::ConnectionThread::connectionDied

void connectionDied()

Emitted if the Wayland server connection dies.

KWayland::Client::PointerSwipeGesture::destroy

void destroy()

Destroys the data held by this PointerSwipeGesture.

Definition: pointergestures.cpp:219

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KWayland

KWayland::Client::PointerSwipeGesture

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ cancelled

◆ destroy()

◆ ended

◆ fingerCount()

◆ isValid()

◆ release()

◆ setup()

◆ started

◆ surface()

◆ updated