KWayland::Client::PointerConstraints Class Reference

#include <pointerconstraints.h>

Inheritance diagram for KWayland::Client::PointerConstraints:

Public Types
enum	LifeTime { LifeTime::OneShot, LifeTime::Persistent }

Signals
void	removed ()

Public Member Functions
	PointerConstraints (QObject *parent=nullptr)
ConfinedPointer *	confinePointer (Surface *surface, Pointer *pointer, Region *region, LifeTime lifetime, QObject *parent=nullptr)
void	destroy ()
EventQueue *	eventQueue ()
bool	isValid () const
LockedPointer *	lockPointer (Surface *surface, Pointer *pointer, Region *region, LifeTime lifetime, QObject *parent=nullptr)
	operator zwp_pointer_constraints_v1 * ()
	operator zwp_pointer_constraints_v1 * () const
void	release ()
void	setEventQueue (EventQueue *queue)
void	setup (zwp_pointer_constraints_v1 *pointerconstraints)
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_pointer_constraints_v1 interface.

This class provides a convenient wrapper for the zwp_pointer_constraints_v1 interface.

To use this class one needs to interact with the Registry. There are two possible ways to create the PointerConstraints interface:

PointerConstraints *c = registry->createPointerConstraints(name, version);

This creates the PointerConstraints and sets it up directly. As an alternative this can also be done in a more low level way:

PointerConstraints *c = new PointerConstraints;
c->setup(registry->bindPointerConstraints(name, version));

The PointerConstraints can be used as a drop-in replacement for any zwp_pointer_constraints_v1 pointer as it provides matching cast operators.

See also

Registry

Since

5.29

Definition at line 69 of file pointerconstraints.h.

Member Enumeration Documentation

enum KWayland::Client::PointerConstraints::LifeTime

strong

These values represent different lifetime semantics.

They are passed as arguments to the factory requests to specify how the constraint lifetimes should be managed.

See also

lockPointer

confinePointer

Enumerator
OneShot	A OneShot pointer constraint will never reactivate once it has been deactivated.
Persistent	A persistent pointer constraint may again reactivate once it has been deactivated.

Definition at line 132 of file pointerconstraints.h.

Constructor & Destructor Documentation

KWayland::Client::PointerConstraints::PointerConstraints ( QObject *  parent = nullptr )

explicit

Creates a new PointerConstraints.

Note: after constructing the PointerConstraints it is not yet valid and one needs to call setup. In order to get a ready to use PointerConstraints prefer using Registry::createPointerConstraints.

Definition at line 45 of file pointerconstraints.cpp.

Member Function Documentation

ConfinedPointer * KWayland::Client::PointerConstraints::confinePointer	(	Surface *	surface,
		Pointer *	pointer,
		Region *	region,
		LifeTime	lifetime,
		QObject *	parent = nullptr
	)

This factory method creates a ConfinedPointer.

A ConfinedPointer lets the client request to confine the pointer cursor to a given region. Creating a ConfinedPointer does not take effect immediately; in the future, when the compositor deems implementation-specific constraints are satisfied, the pointer confinement will be activated and the compositor sends a confined event, which is reported through the ConfinedPointer::confined signal.

The intersection of the region passed and the input region of the surface is used to determine where the pointer must be in order for the confinement to activate. It is up to the compositor whether to warp the pointer or require some kind of user interaction for the confinement to activate. If the region is null the surface input region is used.

Parameters

surface	The Surface which should be constrained in pointer motion
pointer	The Pointer object for which this LockedPointer should be created
region	Region where to confine the pointer, if null the input region of the Surface is used
lifetime	Whether the ConfinedPointer becomes invalid on unconfined
parent	The parent object for the ConfinedPointer

Returns

The factored ConfinedPointer

Definition at line 129 of file pointerconstraints.cpp.

void KWayland::Client::PointerConstraints::destroy

(

)

Destroys the data held by this PointerConstraints.

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

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

connect(connection, &ConnectionThread::connectionDied, pointerconstraints, &PointerConstraints::destroy);

See also

release

Definition at line 73 of file pointerconstraints.cpp.

EventQueue * KWayland::Client::PointerConstraints::eventQueue

(

)

Returns

The event queue to use for creating objects with this PointerConstraints.

Definition at line 96 of file pointerconstraints.cpp.

bool KWayland::Client::PointerConstraints::isValid

(

)

const

Returns

true if managing a zwp_pointer_constraints_v1.

Definition at line 86 of file pointerconstraints.cpp.

LockedPointer * KWayland::Client::PointerConstraints::lockPointer	(	Surface *	surface,
		Pointer *	pointer,
		Region *	region,
		LifeTime	lifetime,
		QObject *	parent = nullptr
	)

This factory method creates a LockedPointer.

A LockedPointer lets the client request to disable movements of the virtual pointer (i.e. the cursor), effectively locking the pointer to a position.

Creating a LockedPointer does not lock the pointer immediately; in the future, when the compositor deems implementation-specific constraints are satisfied, the pointer lock will be activated and the compositor sends a locked event, reported by LockedPointer::locked.

The protocol provides no guarantee that the constraints are ever satisfied, and does not require the compositor to send an error if the constraints cannot ever be satisfied. It is thus possible to request a lock that will never activate.

There may not be another pointer constraint of any kind requested or active on the surface for any of the Pointer objects of the Seat of the passed pointer when requesting a lock. If there is, an error will be raised.

The intersection of the region passed with this request and the input region of the surface is used to determine where the pointer must be in order for the lock to activate. It is up to the compositor whether to warp the pointer or require some kind of user interaction for the lock to activate. If the region is null the surface input region is used.

A Surface may receive pointer focus without the lock being activated.

Note that while a pointer is locked, the Pointer objects of the corresponding seat will not emit any Pointer::motion signals, but relative motion events will still be emitted via RelativePointer::relativeMotion. Pointer axis and button events are unaffected.

Parameters

surface	The Surface which should be constrained in pointer motion
pointer	The Pointer object for which this LockedPointer should be created
region	Region where to lock the pointer, if null the input region of the Surface is used
lifetime	Whether the LockedPointer becomes invalid on unlocked
parent	The parent object for the LockedPointer

Returns

The factored LockedPointer

Definition at line 101 of file pointerconstraints.cpp.

void KWayland::Client::PointerConstraints::release

(

)

Releases the zwp_pointer_constraints_v1 interface.

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

Definition at line 68 of file pointerconstraints.cpp.

void KWayland::Client::PointerConstraints::removed ( )

signal

The corresponding global for this interface on the Registry got removed.

This signal gets only emitted if the PointerConstraints got created by Registry::createPointerConstraints

void KWayland::Client::PointerConstraints::setEventQueue

(

EventQueue *

queue

)

Sets the queue to use for creating objects with this PointerConstraints.

Definition at line 91 of file pointerconstraints.cpp.

void KWayland::Client::PointerConstraints::setup

(

zwp_pointer_constraints_v1 *

pointerconstraints

)

Setup this PointerConstraints to manage the pointerconstraints.

When using Registry::createPointerConstraints there is no need to call this method.

Definition at line 63 of file pointerconstraints.cpp.

---

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

• pointerconstraints.h
• pointerconstraints.cpp