KWayland::Server::IdleInterface

KWayland::Server::IdleInterface Class Reference

#include <idle_interface.h>

Inheritance diagram for KWayland::Server::IdleInterface:

Signals

void inhibitedChanged ()
 
- Signals inherited from KWayland::Server::Global
void aboutToDestroyGlobal ()
 

Public Member Functions

void inhibit ()
 
bool isInhibited () const
 
void simulateUserActivity ()
 
void uninhibit ()
 
- Public Member Functions inherited from KWayland::Server::Global
void create ()
 
void destroy ()
 
Displaydisplay ()
 
bool isValid () const
 
 operator wl_global * ()
 
 operator wl_global * () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, 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 QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const 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)
 
QThreadthread () const 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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from KWayland::Server::Global
 Global (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 const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 
- Protected Attributes inherited from KWayland::Server::Global
QScopedPointer< Private > d
 

Detailed Description

Global representing the org_kde_kwin_idle interface.

The IdleInterface allows to register callbacks which are invoked if there has not been any user activity (no input) for a specified time span on a seat.

A client can bind an idle timeout for a SeatInterface and through that register an idle timeout. The complete interaction is handled internally, thus the API user only needs to create the IdleInterface in order to provide this feature.

This interface is useful for clients as it allows them to perform power management, chat applications might want to set to away after no user input for some time, etc.

Of course this exposes the global input usage to all clients. Normally clients don't know whether the input devices are used, only if their surfaces have focus. With this interface it is possible to notice that there are input events. A server should consider this to decide whether it wants to provide this feature!

Since
5.4

Definition at line 41 of file idle_interface.h.

Member Function Documentation

void KWayland::Server::IdleInterface::inhibit ( )

Inhibits the IdleInterface.

While inhibited no IdleTimeoutInterface interface gets notified about an idle timeout.

This can be used to inhibit power management, screen locking, etc. directly from Compositor side.

To resume idle timeouts invoke uninhibit}. It is possible to invoke inhibit several times, in that case uninhibit needs to called the same amount as inhibit has been called.

See also
uninhibit
isInhibited
inhibitedChanged
Since
5.41

Definition at line 122 of file idle_interface.cpp.

void KWayland::Server::IdleInterface::inhibitedChanged ( )
signal

Emitted when the system gets inhibited or uninhibited.

See also
inhibit
uninhibit
isInhibited
Since
5.41
bool KWayland::Server::IdleInterface::isInhibited ( ) const
Returns
Whether idle timeouts are currently inhibited
See also
inhibit
uninhibit
inhibitedChanged
Since
5.41

Definition at line 140 of file idle_interface.cpp.

void KWayland::Server::IdleInterface::simulateUserActivity ( )

Calling this method allows the Compositor to simulate user activity.

This means the same action is performed as if the user interacted with an input device on the SeatInterface. Idle timeouts are resumed and the idle time gets restarted.

Since
5.42

Definition at line 146 of file idle_interface.cpp.

void KWayland::Server::IdleInterface::uninhibit ( )

Inhibits the IdleInterface.

The idle timeouts are only restarted if uninhibit has been called the same amount as inhibit.

See also
inhibit
isInhibited
inhibitedChanged
Since
5.41

Definition at line 131 of file idle_interface.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 1 2020 22:51:45 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.