diff options
Diffstat (limited to 'src/org.freedesktop.UPower.KbdBacklight.xml')
-rw-r--r-- | src/org.freedesktop.UPower.KbdBacklight.xml | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/src/org.freedesktop.UPower.KbdBacklight.xml b/src/org.freedesktop.UPower.KbdBacklight.xml new file mode 100644 index 0000000..3ccc211 --- /dev/null +++ b/src/org.freedesktop.UPower.KbdBacklight.xml @@ -0,0 +1,101 @@ +<!DOCTYPE node PUBLIC +"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" +"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [ + <!ENTITY ERROR_GENERAL "org.freedesktop.UPower.GeneralError"> +]> +<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"> + <interface name="org.freedesktop.UPower.KbdBacklight"> + <doc:doc> + <doc:description> + <doc:para> + org.freedesktop.UPower.KbdBacklight is a DBus interface implimented + by UPower. + It allows the keyboard backlight (if present) to be controlled. + </doc:para> + </doc:description> + </doc:doc> + + <!-- ************************************************************ --> + <method name="GetMaxBrightness"> + <arg name="value" direction="out" type="i"> + <doc:doc> + <doc:summary> + The maximum value of the keyboard backlight brightness. + </doc:summary> + </doc:doc> + </arg> + <doc:doc> + <doc:description> + <doc:para> + Get the maximum brightness level for the keyboard backlight. + </doc:para> + </doc:description> + <doc:errors> + <doc:error name="&ERROR_GENERAL;">if an error occured while getting the maximum brightness</doc:error> + </doc:errors> + </doc:doc> + </method> + + <!-- ************************************************************ --> + <method name="GetBrightness"> + <arg name="value" direction="out" type="i"> + <doc:doc> + <doc:summary> + The current value of the keyboard backlight brightness. + </doc:summary> + </doc:doc> + </arg> + <doc:doc> + <doc:description> + <doc:para> + Get the brightness level of the keyboard backlight. + </doc:para> + </doc:description> + <doc:errors> + <doc:error name="&ERROR_GENERAL;">if an error occured while getting the brightness</doc:error> + </doc:errors> + </doc:doc> + </method> + + <!-- ************************************************************ --> + <method name="SetBrightness"> + <arg name="value" direction="in" type="i"> + <doc:doc> + <doc:summary> + The value to set the KbdBacklight brightness. + </doc:summary> + </doc:doc> + </arg> + <doc:doc> + <doc:description> + <doc:para> + Set the brightness level of the keyboard backlight. + </doc:para> + </doc:description> + <doc:errors> + <doc:error name="&ERROR_GENERAL;">if an error occured while setting the brightness</doc:error> + </doc:errors> + </doc:doc> + </method> + + <!-- ************************************************************ --> + <signal name="BrightnessChanged"> + <arg name="value" direction="out" type="i"> + <doc:doc> + <doc:summary> + The new brightness value of the keyboard backlight. + </doc:summary> + </doc:doc> + </arg> + <doc:doc> + <doc:description> + <doc:para> + The keyboard backlight brightness level has changed. + </doc:para> + </doc:description> + </doc:doc> + </signal> + + </interface> + +</node> |