sungmg/mutter-performance-source
1
0
Fork 0
Code Activity

dbus-interfaces: Add some docs to the IdleMonitor interface

Browse source 
They’re not complete, but they’re something.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3768>
This commit is contained in:
Philip Withnall 2024-05-23 11:35:45 +01:00 • committed by Marge Bot
parent 173332e928
commit 1b64353427
1 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
data/dbus-interfaces/org.gnome.Mutter.IdleMonitor.xml
View file

@ -15,11 +15,39 @@
<arg name="idletime" direction="out" type="t"/>
</method>
<!--
AddIdleWatch:
@interval: Interval, in milliseconds
@id: Watch ID, guaranteed to be greater than zero
Add a new idle watch for a specific idle time. When the user has been
idle for @interval milliseconds in a row, #org.gnome.Mutter.IdleMonitor.WatchFired
will be emitted with the returned watch @id.
The watch will continue emitting the signal every time the
idle time condition is reached until it is removed.
The returned @id can be used to remove the watch by calling
#org.gnome.Mutter.IdleMonitor.RemoveWatch.
-->
<method name="AddIdleWatch">
<arg name="interval" direction="in" type="t" />
<arg name="id" direction="out" type="u" />
</method>
<!--
AddUserActiveWatch:
@id: Watch ID, guaranteed to be greater than zero
Add a new active watch. When the user has been idle and becomes
active again, #org.gnome.Mutter.IdleMonitor.WatchFired will be
emitted with the returned watch @id, and the watch will be removed.
Unlike idle watches, an active watch is fired only once.
The returned @id can be used to remove the watch (before it’s fired)
by calling #org.gnome.Mutter.IdleMonitor.RemoveWatch.
-->
<method name="AddUserActiveWatch">
<arg name="id" direction="out" type="u" />
</method>