KWayland::Client::PointerConstraints
#include <pointerconstraints.h>

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) |
![]() | |
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 |
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 |
![]() | |
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) |
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:
This creates the PointerConstraints and sets it up directly. As an alternative this can also be done in a more low level way:
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 54 of file pointerconstraints.h.
Member Enumeration Documentation
◆ 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 117 of file pointerconstraints.h.
Constructor & Destructor Documentation
◆ PointerConstraints()
|
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 30 of file pointerconstraints.cpp.
Member Function Documentation
◆ confinePointer()
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 usedlifetime Whether the ConfinedPointer becomes invalid on unconfined parent The parent object for the ConfinedPointer
- Returns
- The factored ConfinedPointer
Definition at line 116 of file pointerconstraints.cpp.
◆ destroy()
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:
- See also
- release
Definition at line 58 of file pointerconstraints.cpp.
◆ eventQueue()
EventQueue * KWayland::Client::PointerConstraints::eventQueue | ( | ) |
- Returns
- The event queue to use for creating objects with this PointerConstraints.
Definition at line 83 of file pointerconstraints.cpp.
◆ isValid()
bool KWayland::Client::PointerConstraints::isValid | ( | ) | const |
- Returns
true
if managing a zwp_pointer_constraints_v1.
Definition at line 73 of file pointerconstraints.cpp.
◆ lockPointer()
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 usedlifetime Whether the LockedPointer becomes invalid on unlocked parent The parent object for the LockedPointer
- Returns
- The factored LockedPointer
Definition at line 88 of file pointerconstraints.cpp.
◆ release()
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 53 of file pointerconstraints.cpp.
◆ 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
◆ setEventQueue()
void KWayland::Client::PointerConstraints::setEventQueue | ( | EventQueue * | queue | ) |
Sets the queue
to use for creating objects with this PointerConstraints.
Definition at line 78 of file pointerconstraints.cpp.
◆ setup()
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 48 of file pointerconstraints.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sun Feb 5 2023 03:56:52 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.