1
0
Fork 0
mutter-performance-source/data/dbus-interfaces/org.gnome.Mutter.IdleMonitor.xml
Philip Withnall 1b64353427 dbus-interfaces: Add some docs to the IdleMonitor interface
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>
2024-05-26 10:04:19 +00:00

65 lines
2.1 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE node PUBLIC
'-//freedesktop//DTD D-BUS Object Introspection 1.0//EN'
'http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd'>
<node>
<!--
org.gnome.Mutter.IdleMonitor:
@short_description: idle monitor interface
This interface is used by gnome-desktop to implement
user activity monitoring.
-->
<interface name="org.gnome.Mutter.IdleMonitor">
<method name="GetIdletime">
<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 its fired)
by calling #org.gnome.Mutter.IdleMonitor.RemoveWatch.
-->
<method name="AddUserActiveWatch">
<arg name="id" direction="out" type="u" />
</method>
<method name="RemoveWatch">
<arg name="id" direction="in" type="u" />
</method>
<method name="ResetIdletime"/>
<signal name="WatchFired">
<arg name="id" direction="out" type="u" />
</signal>
</interface>
</node>