KWin
Loading...
Searching...
No Matches
Public Member Functions | List of all members
KWin::IdleInterface Class Reference

Global representing the org_kde_kwin_idle interface. More...

#include <idle.h>

Inheritance diagram for KWin::IdleInterface:

Public Member Functions

 IdleInterface (Display *display, QObject *parent=nullptr)
 
 ~IdleInterface () override
 

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!

Definition at line 37 of file idle.h.

Constructor & Destructor Documentation

◆ IdleInterface()

KWin::IdleInterface::IdleInterface ( Display * display,
QObject * parent = nullptr )
explicit

Definition at line 37 of file idle.cpp.

◆ ~IdleInterface()

KWin::IdleInterface::~IdleInterface ( )
overridedefault

The documentation for this class was generated from the following files: