KWayland::Client::Idle

KWayland::Client::Idle Class Reference

#include <idle.h>

Inheritance diagram for KWayland::Client::Idle:

Signals

void removed ()
 

Public Member Functions

 Idle (QObject *parent=nullptr)
 
void destroy ()
 
EventQueueeventQueue ()
 
IdleTimeoutgetTimeout (quint32 msecs, Seat *seat, QObject *parent=nullptr)
 
bool isValid () const
 
 operator org_kde_kwin_idle * ()
 
 operator org_kde_kwin_idle * () const
 
void release ()
 
void setEventQueue (EventQueue *queue)
 
void setup (org_kde_kwin_idle *manager)
 
- 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 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)
 

Detailed Description

Wrapper for the org_kde_kwin_idle interface.

With the help of Idle it is possible to get notified when a Seat is not being used. E.g. a chat application which wants to set the user automatically to away if the user did not interact with the Seat for 5 minutes can create an IdleTimeout to get notified when the Seat has been idle for the given amount of time.

This class provides a convenient wrapper for the org_kde_kwin_idle interface.

To use this class one needs to interact with the Registry. There are two possible ways to create the Idle interface:

Idle *m = registry->createIdle(name, version);

This creates the Idle and sets it up directly. As an alternative this can also be done in a more low level way:

Idle *m = new Idle;
m->setup(registry->bindIdle(name, version));

The Idle can be used as a drop-in replacement for any org_kde_kwin_idle pointer as it provides matching cast operators.

See also
Registry

Definition at line 53 of file idle.h.

Constructor & Destructor Documentation

KWayland::Client::Idle::Idle ( QObject parent = nullptr)
explicit

Creates a new Idle.

Note: after constructing the Idle it is not yet valid and one needs to call setup. In order to get a ready to use Idle prefer using Registry::createIdle.

Definition at line 25 of file idle.cpp.

Member Function Documentation

void KWayland::Client::Idle::destroy ( )

Destroys the data held by this Idle.

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 org_kde_kwin_idle interface once there is a new connection available.

This method is automatically invoked when the Registry which created this Idle gets destroyed.

See also
release

Definition at line 41 of file idle.cpp.

EventQueue * KWayland::Client::Idle::eventQueue ( )
Returns
The event queue to use for creating a IdleTimeout.

Definition at line 58 of file idle.cpp.

IdleTimeout * KWayland::Client::Idle::getTimeout ( quint32  msecs,
Seat seat,
QObject parent = nullptr 
)

Creates a new IdleTimeout for the seat.

If the seat has been idle, that is none of the connected input devices got used for msec, the IdleTimeout will emit the IdleTimeout::idle signal.

It is not guaranteed that the signal will be emitted exactly at the given timeout. A Wayland server might for example have a minimum timeout which is larger than msec.

Parameters
msecThe duration in milliseconds after which an idle timeout should fire
seatThe Seat on which the user activity should be monitored.

Definition at line 68 of file idle.cpp.

bool KWayland::Client::Idle::isValid ( ) const
Returns
true if managing a org_kde_kwin_idle.

Definition at line 46 of file idle.cpp.

void KWayland::Client::Idle::release ( )

Releases the org_kde_kwin_idle interface.

After the interface has been released the Idle instance is no longer valid and can be setup with another org_kde_kwin_idle interface.

Definition at line 36 of file idle.cpp.

void KWayland::Client::Idle::removed ( )
signal

The corresponding global for this interface on the Registry got removed.

This signal gets only emitted if the Compositor got created by Registry::createIdle

Since
5.5
void KWayland::Client::Idle::setEventQueue ( EventQueue queue)

Sets the queue to use for creating a IdleTimeout.

Definition at line 63 of file idle.cpp.

void KWayland::Client::Idle::setup ( org_kde_kwin_idle *  manager)

Setup this Idle to manage the manager.

When using Registry::createIdle there is no need to call this method.

Definition at line 51 of file idle.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 Wed Aug 12 2020 22:50:26 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.