KWayland::Client::ConfinedPointer Class Reference

#include <pointerconstraints.h>

Inheritance diagram for KWayland::Client::ConfinedPointer:

Signals
void	confined ()
void	unconfined ()

Public Member Functions
void	destroy ()
bool	isValid () const
	operator zwp_confined_pointer_v1 * ()
	operator zwp_confined_pointer_v1 * () const
void	release ()
void	setRegion (Region *region)
void	setup (zwp_confined_pointer_v1 *confinedpointer)
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 zwp_confined_pointer_v1 protocol The confine pointer interface represents a confined pointer state.

This object will send the signal 'confined' when the confinement is activated. Whenever the confinement is activated, it is guaranteed that the surface the pointer is confined to will already have received pointer focus and that the pointer will be within the region passed to the request creating this object. It is up to the compositor to decide whether this requires some user interaction and if the pointer will warp to within the passed region if outside.

To unconfine the pointer, delete the object.

If the compositor decides to unconfine the pointer the unconfined signal is emitted. The ConfinedPointer object is at this point defunct and should be deleted.

See also

PointerConstraints::confinePointer

Since

5.29

Definition at line 379 of file pointerconstraints.h.

Member Function Documentation

void KWayland::Client::ConfinedPointer::confined ( )

signal

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

See also

unconfined

void KWayland::Client::ConfinedPointer::destroy

(

)

Destroys the data held by this ConfinedPointer.

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

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

See also

release

Definition at line 335 of file pointerconstraints.cpp.

bool KWayland::Client::ConfinedPointer::isValid

(

)

const

Returns

true if managing a zwp_confined_pointer_v1.

Definition at line 348 of file pointerconstraints.cpp.

void KWayland::Client::ConfinedPointer::release

(

)

Releases the zwp_confined_pointer_v1 interface.

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

Definition at line 330 of file pointerconstraints.cpp.

void KWayland::Client::ConfinedPointer::setRegion

(

Region *

region

)

Set a new region used to confine the pointer.

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

If the confinement is active when the new confinement region is applied and the pointer ends up outside of newly applied region, the pointer may warped to a position within the new confinement region. If warped, a Pointer::motion signal will be emitted, but no RelativePointer::relativeMotion signal.

The compositor may also, instead of using the new region, unconfine the pointer.

Parameters

region

The new confine region.

See also

Surface::commit

PointerConstraints::confinePointer

Definition at line 353 of file pointerconstraints.cpp.

void KWayland::Client::ConfinedPointer::setup

(

zwp_confined_pointer_v1 *

confinedpointer

)

Setup this ConfinedPointer to manage the confinedpointer.

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

Definition at line 325 of file pointerconstraints.cpp.

void KWayland::Client::ConfinedPointer::unconfined ( )

signal

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

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

See also

confined

---

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

• pointerconstraints.h
• pointerconstraints.cpp