KWayland::Client::LockedPointer Class Reference

#include <pointerconstraints.h>

Inheritance diagram for KWayland::Client::LockedPointer:

Signals
void	locked ()
void	unlocked ()

Public Member Functions
void	destroy ()
bool	isValid () const
	operator zwp_locked_pointer_v1 * ()
	operator zwp_locked_pointer_v1 * () const
void	release ()
void	setCursorPositionHint (const QPointF &surfaceLocal)
void	setRegion (Region *region)
void	setup (zwp_locked_pointer_v1 *lockedpointer)
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_locked_pointer_v1 interface.

The LockedPointer represents a locked pointer state.

While the lock of this object is active, the Pointer objects of the associated seat will not emit any Pointer::motion events.

This object will send the signal locked when the lock is activated. Whenever the lock is activated, it is guaranteed that the locked surface will already have received pointer focus and that the pointer will be within the region passed to the request creating this object.

To unlock the pointer, delete the object.

If the compositor decides to unlock the pointer the unlocked signal is emitted.

When unlocking, the compositor may warp the cursor position to the set cursor position hint. If it does, it will not result in any relative motion events emitted via RelativePointer::relativeMotion.

If the Surface the lock was requested on is destroyed and the lock is not yet activated, the LockedPointer object is now defunct and must be deleted.

See also

PointerConstraints::lockedPointer

Since

5.29

Definition at line 261 of file pointerconstraints.h.

Member Function Documentation

void KWayland::Client::LockedPointer::destroy

(

)

Destroys the data held by this LockedPointer.

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

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

connect(connection, &ConnectionThread::connectionDied, lockedpointer, &LockedPointer::destroy);

See also

release

Definition at line 229 of file pointerconstraints.cpp.

bool KWayland::Client::LockedPointer::isValid

(

)

const

Returns

true if managing a zwp_locked_pointer_v1.

Definition at line 242 of file pointerconstraints.cpp.

void KWayland::Client::LockedPointer::locked ( )

signal

Notification that the pointer lock of the seat's pointer is activated.

See also

unlocked

void KWayland::Client::LockedPointer::release

(

)

Releases the zwp_locked_pointer_v1 interface.

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

Definition at line 224 of file pointerconstraints.cpp.

void KWayland::Client::LockedPointer::setCursorPositionHint

(

const QPointF &

surfaceLocal

)

Set the cursor position hint relative to the top left corner of the Surface.

If the client is drawing its own cursor, it should update the position hint to the position of its own cursor. A compositor may use this information to warp the pointer upon unlock in order to avoid pointer jumps.

The cursor position hint is double buffered. The new hint will only take effect when the associated surface gets it pending state applied. See Surface::commit for details.

Parameters

surfaceLocal

The new position hint in surface local coordinates

See also

Surface::commit

Definition at line 247 of file pointerconstraints.cpp.

void KWayland::Client::LockedPointer::setRegion

(

Region *

region

)

Set a new region used to lock the pointer.

The new lock region is double-buffered. The new lock region will only take effect when the associated Surface gets its pending state applied. See Surface::commit for details.

Parameters

region

The new lock region.

See also

Surface::commit

PointerConstraints::lockPointer

Definition at line 253 of file pointerconstraints.cpp.

void KWayland::Client::LockedPointer::setup

(

zwp_locked_pointer_v1 *

lockedpointer

)

Setup this LockedPointer to manage the lockedpointer.

When using PointerConstraints::createLockedPointer there is no need to call this method.

Definition at line 219 of file pointerconstraints.cpp.

void KWayland::Client::LockedPointer::unlocked ( )

signal

Notification that the pointer lock of the seat's pointer is no longer active.

If this is a oneshot pointer lock (see wp_pointer_constraints.lifetime) this object is now defunct and should be destroyed. If this is a persistent pointer lock (see wp_pointer_constraints.lifetime) this pointer lock may again reactivate in the future.

See also

locked

---

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

• pointerconstraints.h
• pointerconstraints.cpp