KWayland::Client::IdleInhibitManager
#include <idleinhibit.h>

Signals | |
void | removed () |
Public Member Functions | |
IdleInhibitManager (QObject *parent=nullptr) | |
IdleInhibitor * | createInhibitor (Surface *surface, QObject *parent=nullptr) |
void | destroy () |
EventQueue * | eventQueue () |
bool | isValid () const |
operator zwp_idle_inhibit_manager_v1 * () | |
operator zwp_idle_inhibit_manager_v1 * () const | |
void | release () |
void | setEventQueue (EventQueue *queue) |
void | setup (zwp_idle_inhibit_manager_v1 *idleinhibitmanager) |
![]() | |
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_idle_inhibit_manager_v1 interface.
This class provides a convenient wrapper for the zwp_idle_inhibit_manager_v1 interface.
To use this class one needs to interact with the Registry. There are two possible ways to create the IdleInhibitManager interface:
This creates the IdleInhibitManager and sets it up directly. As an alternative this can also be done in a more low level way:
The IdleInhibitManager can be used as a drop-in replacement for any zwp_idle_inhibit_manager_v1 pointer as it provides matching cast operators.
- See also
- Registry
- Since
- 5.41
Definition at line 48 of file idleinhibit.h.
Constructor & Destructor Documentation
◆ IdleInhibitManager()
|
explicit |
Creates a new IdleInhibitManager.
Note: after constructing the IdleInhibitManager it is not yet valid and one needs to call setup. In order to get a ready to use IdleInhibitManager prefer using Registry::createIdleInhibitManager.
Definition at line 28 of file idleinhibit.cpp.
Member Function Documentation
◆ createInhibitor()
IdleInhibitor * KWayland::Client::IdleInhibitManager::createInhibitor | ( | Surface * | surface, |
QObject * | parent = nullptr |
||
) |
Creates an IdleInhibitor for the given surface
.
While the IdleInhibitor exists the surface
is marked to inhibit idle.
- Parameters
-
surface The Surface which should have idle inhibited parent The parent object for the IdleInhibitor
- Returns
- The created IdleInhibitor
Definition at line 86 of file idleinhibit.cpp.
◆ destroy()
void KWayland::Client::IdleInhibitManager::destroy | ( | ) |
Destroys the data held by this IdleInhibitManager.
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_idle_inhibit_manager_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 56 of file idleinhibit.cpp.
◆ eventQueue()
EventQueue * KWayland::Client::IdleInhibitManager::eventQueue | ( | ) |
- Returns
- The event queue to use for creating objects with this IdleInhibitManager.
Definition at line 81 of file idleinhibit.cpp.
◆ isValid()
bool KWayland::Client::IdleInhibitManager::isValid | ( | ) | const |
- Returns
true
if managing a zwp_idle_inhibit_manager_v1.
Definition at line 71 of file idleinhibit.cpp.
◆ release()
void KWayland::Client::IdleInhibitManager::release | ( | ) |
Releases the zwp_idle_inhibit_manager_v1 interface.
After the interface has been released the IdleInhibitManager instance is no longer valid and can be setup with another zwp_idle_inhibit_manager_v1 interface.
Definition at line 51 of file idleinhibit.cpp.
◆ removed
|
signal |
The corresponding global for this interface on the Registry got removed.
This signal gets only emitted if the IdleInhibitManager got created by Registry::createIdleInhibitManager
◆ setEventQueue()
void KWayland::Client::IdleInhibitManager::setEventQueue | ( | EventQueue * | queue | ) |
Sets the queue
to use for creating objects with this IdleInhibitManager.
Definition at line 76 of file idleinhibit.cpp.
◆ setup()
void KWayland::Client::IdleInhibitManager::setup | ( | zwp_idle_inhibit_manager_v1 * | idleinhibitmanager | ) |
Setup this IdleInhibitManager to manage the idleinhibitmanager
.
When using Registry::createIdleInhibitManager there is no need to call this method.
Definition at line 46 of file idleinhibit.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.