org_kde_kwin_idle

Deprecatedversion 1
User idle time manager

This interface allows to monitor user idle time on a given seat. The interface allows to register timers which trigger after no user activity was registered on the seat for a given interval. It notifies when user activity resumes.

This is useful for applications wanting to perform actions when the user is not interacting with the system, e.g. chat applications setting the user as away, power management features to dim screen, etc..

get_idle_timeout(id: new_id<org_kde_kwin_idle_timeout>, seat: object<wl_seat>, timeout: uint)
Argument
Type
Description
idnew_id<org_kde_kwin_idle_timeout>
seatobject<wl_seat>
timeoutuint
The idle timeout in msec

org_kde_kwin_idle_timeout

Deprecatedversion 1

release()
Release the timeout object
simulate_user_activity()
Simulates user activity for this timeout, behaves just like real user activity on the seat
idle()
Triggered when there has not been any user activity in the requested idle time interval
resumed()
Triggered on the first user activity after an idle event

Compositor Support

MutterMutter
8/31/2023
KWinKWin
11/13/2023
SwaySway
1/7/2023
WestonWeston
9/27/2023
MirMir
7/22/2023
gamescopegamescope
12/14/2023
org_kde_kwin_idle
x
1
1
x
x
x

SPDX-FileCopyrightText: 2015 Martin Gräßlin

SPDX-License-Identifier: LGPL-2.1-or-later