protocols/idle.xml
author agaric <agaric@protonmail.com>
Tue, 09 Mar 2021 07:18:07 +0000
changeset 0 5f04caa7212d
permissions -rw-r--r--
git import
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="idle">
  <copyright><![CDATA[
    Copyright (C) 2015 Martin Gräßlin

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 2.1 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  ]]></copyright>
  <interface  name="org_kde_kwin_idle" version="1">
      <description summary="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..
      </description>
      <request name="get_idle_timeout">
        <arg name="id" type="new_id" interface="org_kde_kwin_idle_timeout"/>
        <arg name="seat" type="object" interface="wl_seat"/>
        <arg name="timeout" type="uint" summary="The idle timeout in msec"/>
      </request>
  </interface>
  <interface name="org_kde_kwin_idle_timeout" version="1">
      <request name="release" type="destructor">
        <description summary="release the timeout object"/>
      </request>
      <request name="simulate_user_activity">
          <description summary="Simulates user activity for this timeout, behaves just like real user activity on the seat"/>
      </request>
      <event name="idle">
          <description summary="Triggered when there has not been any user activity in the requested idle time interval"/>
      </event>
      <event name="resumed">
          <description summary="Triggered on the first user activity after an idle event"/>
      </event>
  </interface>
</protocol>