KWayland::Client::IdleTimeout

KWayland::Client::IdleTimeout Class Reference

#include <idle.h>

Inheritance diagram for KWayland::Client::IdleTimeout:

Signals

void idle ()
 
void resumeFromIdle ()
 

Public Member Functions

 IdleTimeout (QObject *parent=nullptr)
 
void destroy ()
 
bool isValid () const
 
 operator org_kde_kwin_idle_timeout * ()
 
 operator org_kde_kwin_idle_timeout * () const
 
void release ()
 
void setup (org_kde_kwin_idle_timeout *timeout)
 
void simulateUserActivity ()
 
- 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_timeout interface.

This class is a convenient wrapper for the org_kde_kwin_idle_timeout interface. To create a IdleTimeout call IdleTimeoutManager::getIdleTimeout.

See also
IdleTimeoutManager

Definition at line 148 of file idle.h.

Constructor & Destructor Documentation

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

To create an IdleTimeout prefer using Idle::getTimeout which sets up the IdleTimeout to be fully functional.

Definition at line 137 of file idle.cpp.

Member Function Documentation

void KWayland::Client::IdleTimeout::destroy ( )

Destroys the data held by this IdleTimeout.

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

It is suggested to connect this method to ConnectionThread::connectionDied:

See also
release

Definition at line 148 of file idle.cpp.

void KWayland::Client::IdleTimeout::idle ( )
signal

Emitted when this IdleTimeout triggered.

This means the system has been idle for the duration specified when creating the IdleTimeout.

See also
Idle::getTimeout.
resumeFromIdle
bool KWayland::Client::IdleTimeout::isValid ( ) const
Returns
true if managing a org_kde_kwin_idle_timeout.

Definition at line 158 of file idle.cpp.

void KWayland::Client::IdleTimeout::release ( )

Releases the org_kde_kwin_idle_timeout interface.

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

Definition at line 153 of file idle.cpp.

void KWayland::Client::IdleTimeout::resumeFromIdle ( )
signal

Emitted when the system shows activity again after the idle state was reached.

See also
idle
void KWayland::Client::IdleTimeout::setup ( org_kde_kwin_idle_timeout *  timeout)

Setup this IdleTimeout to manage the timeout.

When using IdleTimeoutManager::createIdleTimeout there is no need to call this method.

Definition at line 163 of file idle.cpp.

void KWayland::Client::IdleTimeout::simulateUserActivity ( )

Simulates user activity.

If the IdleTimeout is in idle state this will trigger the resumeFromIdle signal. The current idle duration is reset, so the idle will only be emitted after a complete idle duration as requested for this IdleTimeout.

Definition at line 168 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 Sun May 24 2020 23:07:28 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.