KWayland::Server::ConfinedPointerInterface
#include <pointerconstraints_interface.h>

Public Types | |
enum | LifeTime { OneShot, Persistent } |
Signals | |
void | confinedChanged () |
void | regionChanged () |
![]() | |
void | aboutToBeUnbound () |
void | unbound () |
Public Member Functions | |
PointerConstraintsInterfaceVersion | interfaceVersion () const |
bool | isConfined () const |
LifeTime | lifeTime () const |
QRegion | region () const |
void | setConfined (bool confined) |
![]() | |
ClientConnection * | client () |
void | create (ClientConnection *client, quint32 version, quint32 id) |
Global * | global () |
quint32 | id () const |
wl_resource * | parentResource () const |
wl_resource * | resource () |
![]() | |
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 ®Exp, 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 ®Exp) |
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 |
Protected Member Functions | |
ConfinedPointerInterface (Private *p, QObject *parent=nullptr) | |
![]() | |
Resource (Private *d, QObject *parent=nullptr) | |
![]() | |
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) |
Additional Inherited Members | |
![]() | |
objectName | |
![]() | |
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) |
![]() | |
typedef | QObjectList |
![]() | |
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 201 of file pointerconstraints_interface.h.
Member Function Documentation
◆ confinedChanged
|
signal |
Emitted whenever the isConfined state changes.
- See also
- isConfined
- setConfined
◆ interfaceVersion()
PointerConstraintsInterfaceVersion KWayland::Server::ConfinedPointerInterface::interfaceVersion | ( | ) | const |
- Returns
- The interface version used by this ConfinedPointerInterface
Definition at line 176 of file pointerconstraints_interface.cpp.
◆ isConfined()
bool KWayland::Server::ConfinedPointerInterface::isConfined | ( | ) | const |
Whether the Compositor set this pointer confinement to be active.
- See also
- setConfined
- confinedChanged
Definition at line 194 of file pointerconstraints_interface.cpp.
◆ region()
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 188 of file pointerconstraints_interface.cpp.
◆ regionChanged
|
signal |
Emitted whenever the region changes.
This happens when the parent SurfaceInterface gets committed
- See also
- region
◆ setConfined()
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 200 of file pointerconstraints_interface.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 6 2023 03:55:52 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.