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

Cage
Cage
0.2.0
COSMIC
COSMIC
1.0.0~beta.8
GameScope
GameScope
3.15.14
Hyprland
Hyprland
0.52.1
Jay
1.11.0
KWin
KWin
6.4
Labwc
Labwc
0.9.2
Louvre
Louvre
2.14.1
Mir
Mir
2.19
Muffin
Muffin
6.4.1
Mutter
Mutter
49.2
niri
niri
25.11
river
river
0.3.13
Sway
Sway
1.11
Treeland
Treeland
0.8.0
Wayfire
Wayfire
0.9.0
Weston
Weston
14.0.2
org_kde_kwin_idle
x
x
x
x
x
1
x
x
x
x
x
x
x
x
x
x
x

SPDX-FileCopyrightText: 2015 Martin Gräßlin

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