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