KWayland::Server::ConfinedPointerInterface Class Reference

#include <pointerconstraints_interface.h>

Inheritance diagram for KWayland::Server::ConfinedPointerInterface:

Public Types
enum	LifeTime { OneShot, Persistent }

Signals
void	confinedChanged ()
void	regionChanged ()
Signals inherited from KWayland::Server::Resource
void	aboutToBeUnbound ()
void	unbound ()

Public Member Functions
PointerConstraintsInterfaceVersion	interfaceVersion () const
bool	isConfined () const
LifeTime	lifeTime () const
QRegion	region () const
void	setConfined (bool confined)
Public Member Functions inherited from KWayland::Server::Resource
ClientConnection *	client ()
void	create (ClientConnection *client, quint32 version, quint32 id)
Global *	global ()
quint32	id () const
wl_resource *	parentResource () const
wl_resource *	resource ()
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

Protected Member Functions
	ConfinedPointerInterface (Private *p, QObject *parent=nullptr)
Protected Member Functions inherited from KWayland::Server::Resource
	Resource (Private *d, QObject *parent=nullptr)
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)

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 Attributes inherited from KWayland::Server::Resource
QScopedPointer< Private >	d

Detailed Description

The ConfinedPointerInterface gets installed on a SurfaceInterface.

The confinement indicates that the SurfaceInterface wants to confine the pointer to a region of the SurfaceInterface.

It is up to the compositor whether the confinement gets activated. To activate it needs to use ConfinedPointerInterface::setConfined. The compositor needs to ensure that the SurfaceInterface has pointer focus and that the pointer is inside the ConfinedPointerInterface::region when it activates the confinement.

From client side the confinement gets deactivated by destroying the ConfinedPointerInterface. From compositor side the confinement can be deactivated by setting ConfinedPointerInterface::setConfined to false.

Since

5.29

Definition at line 217 of file pointerconstraints_interface.h.

Member Function Documentation

void KWayland::Server::ConfinedPointerInterface::confinedChanged ( )

signal

Emitted whenever the isConfined state changes.

See also

isConfined

setConfined

PointerConstraintsInterfaceVersion KWayland::Server::ConfinedPointerInterface::interfaceVersion

(

)

const

Returns

The interface version used by this ConfinedPointerInterface

Definition at line 173 of file pointerconstraints_interface.cpp.

bool KWayland::Server::ConfinedPointerInterface::isConfined

(

)

const

Whether the Compositor set this pointer confinement to be active.

See also

setConfined

confinedChanged

Definition at line 191 of file pointerconstraints_interface.cpp.

QRegion KWayland::Server::ConfinedPointerInterface::region

(

)

const

The intersection of this region and the input region of the SurfaceInterface 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 empty the SurfaceInterface input region is used.

See also

regionChanged

SurfaceInterface::input

Definition at line 185 of file pointerconstraints_interface.cpp.

void KWayland::Server::ConfinedPointerInterface::regionChanged ( )

signal

Emitted whenever the region changes.

This happens when the parent SurfaceInterface gets committed

See also

region

void KWayland::Server::ConfinedPointerInterface::setConfined

(

bool

confined

)

Activates or deactivates the confinement.

A pointer confinement can only be activated if the SurfaceInterface this ConfinedPointerInterface was created for has pointer focus and the pointer is inside the region.

Parameters

confined

Whether the confinement should be active

See also

isConfined

confinedChanged

Definition at line 197 of file pointerconstraints_interface.cpp.

---

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

• pointerconstraints_interface.h
• pointerconstraints_interface.cpp