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
0
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     1
<?xml version="1.0" encoding="UTF-8"?>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     2
<protocol name="idle">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     3
  <copyright><![CDATA[
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     4
    Copyright (C) 2015 Martin Gräßlin
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     5
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     6
    This program is free software: you can redistribute it and/or modify
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     7
    it under the terms of the GNU Lesser General Public License as published by
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     8
    the Free Software Foundation, either version 2.1 of the License, or
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
     9
    (at your option) any later version.
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    10
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    11
    This program is distributed in the hope that it will be useful,
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    12
    but WITHOUT ANY WARRANTY; without even the implied warranty of
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    13
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    14
    GNU Lesser General Public License for more details.
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    15
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    16
    You should have received a copy of the GNU Lesser General Public License
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    17
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    18
  ]]></copyright>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    19
  <interface  name="org_kde_kwin_idle" version="1">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    20
      <description summary="User idle time manager">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    21
        This interface allows to monitor user idle time on a given seat. The interface
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    22
        allows to register timers which trigger after no user activity was registered
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    23
        on the seat for a given interval. It notifies when user activity resumes.
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    24
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    25
        This is useful for applications wanting to perform actions when the user is not
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    26
        interacting with the system, e.g. chat applications setting the user as away, power
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    27
        management features to dim screen, etc..
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    28
      </description>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    29
      <request name="get_idle_timeout">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    30
        <arg name="id" type="new_id" interface="org_kde_kwin_idle_timeout"/>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    31
        <arg name="seat" type="object" interface="wl_seat"/>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    32
        <arg name="timeout" type="uint" summary="The idle timeout in msec"/>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    33
      </request>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    34
  </interface>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    35
  <interface name="org_kde_kwin_idle_timeout" version="1">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    36
      <request name="release" type="destructor">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    37
        <description summary="release the timeout object"/>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    38
      </request>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    39
      <request name="simulate_user_activity">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    40
          <description summary="Simulates user activity for this timeout, behaves just like real user activity on the seat"/>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    41
      </request>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    42
      <event name="idle">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    43
          <description summary="Triggered when there has not been any user activity in the requested idle time interval"/>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    44
      </event>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    45
      <event name="resumed">
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    46
          <description summary="Triggered on the first user activity after an idle event"/>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    47
      </event>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    48
  </interface>
5f04caa7212d git import
agaric <agaric@protonmail.com>
parents:
diff changeset
    49
</protocol>