Debian Codegraph @

dbus/org.freedesktop.UPower.KbdBacklight.xml

raw
1 <!DOCTYPE node PUBLIC
2 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
3 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [
4 <!ENTITY ERROR_GENERAL "org.freedesktop.UPower.GeneralError">
5 ]>
6 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
7 <interface name="org.freedesktop.UPower.KbdBacklight">
8 <doc:doc>
9 <doc:description>
10 <doc:para>
11 org.freedesktop.UPower.KbdBacklight is a DBus interface implemented
12 by UPower.
13 It allows the keyboard backlight (if present) to be controlled.
14
15 The object path "/org/freedesktop/UPower/KbdBacklight" is going to be deprecated in the future.
16 The new object path is based on this, but the suffix of the path is the device name.
17 For example:
18 The interface is: org.freedesktop.UPower.KbdBacklight
19 The object path will be: /org/freedesktop/UPower/KbdBacklight/tpacpiookbd_backlight
20 </doc:para>
21 </doc:description>
22 </doc:doc>
23
24 <!-- ************************************************************ -->
25 <method name="GetMaxBrightness">
26 <arg name="value" direction="out" type="i">
27 <doc:doc>
28 <doc:summary>
29 The maximum value of the keyboard backlight brightness.
30 </doc:summary>
31 </doc:doc>
32 </arg>
33 <doc:doc>
34 <doc:description>
35 <doc:para>
36 Get the maximum brightness level for the keyboard backlight.
37 </doc:para>
38 </doc:description>
39 <doc:errors>
40 <doc:error name="&ERROR_GENERAL;">if an error occurred while getting the maximum brightness</doc:error>
41 </doc:errors>
42 </doc:doc>
43 </method>
44
45 <!-- ************************************************************ -->
46 <method name="GetBrightness">
47 <arg name="value" direction="out" type="i">
48 <doc:doc>
49 <doc:summary>
50 The current value of the keyboard backlight brightness.
51 </doc:summary>
52 </doc:doc>
53 </arg>
54 <doc:doc>
55 <doc:description>
56 <doc:para>
57 Get the brightness level of the keyboard backlight.
58 </doc:para>
59 </doc:description>
60 <doc:errors>
61 <doc:error name="&ERROR_GENERAL;">if an error occurred while getting the brightness</doc:error>
62 </doc:errors>
63 </doc:doc>
64 </method>
65
66 <!-- ************************************************************ -->
67 <method name="SetBrightness">
68 <arg name="value" direction="in" type="i">
69 <doc:doc>
70 <doc:summary>
71 The value to set the KbdBacklight brightness.
72 </doc:summary>
73 </doc:doc>
74 </arg>
75 <doc:doc>
76 <doc:description>
77 <doc:para>
78 Set the brightness level of the keyboard backlight.
79 </doc:para>
80 </doc:description>
81 <doc:errors>
82 <doc:error name="&ERROR_GENERAL;">if an error occurred while setting the brightness</doc:error>
83 </doc:errors>
84 </doc:doc>
85 </method>
86
87 <!-- ************************************************************ -->
88 <property name="NativePath" type="s" access="read">
89 <doc:doc>
90 <doc:description>
91 <doc:para>
92 OS specific native path of the keyboard backlight LED device. On Linux this
93 is the sysfs path, for
94 example <doc:tt>/sys/devices/platform/thinkpad_acpi/leds/tpacpi\:\:kbd_backlight</doc:tt>.
95 </doc:para>
96 </doc:description>
97 </doc:doc>
98 </property>
99
100 <!-- ************************************************************ -->
101 <signal name="BrightnessChanged">
102 <arg name="value" direction="out" type="i">
103 <doc:doc>
104 <doc:summary>
105 The new brightness value of the keyboard backlight.
106 </doc:summary>
107 </doc:doc>
108 </arg>
109 <doc:doc>
110 <doc:description>
111 <doc:para>
112 The keyboard backlight brightness level has changed.
113 </doc:para>
114 </doc:description>
115 </doc:doc>
116 </signal>
117
118 <signal name="BrightnessChangedWithSource">
119 <arg name="value" direction="out" type="i">
120 <doc:doc>
121 <doc:summary>
122 The new brightness value of the keyboard backlight.
123 </doc:summary>
124 </doc:doc>
125 </arg>
126 <arg name="source" direction="out" type="s">
127 <doc:doc>
128 <doc:summary>
129 Source of the keyboard backlight brightness change, either
130 "external" if SetBrightness was called, or "internal" if the
131 hardware changed the keyboard brightness itself (automatically or
132 through a firmware-handled hotkey being pressed).
133 </doc:summary>
134 </doc:doc>
135 </arg>
136 <doc:doc>
137 <doc:description>
138 <doc:para>
139 The keyboard backlight brightness level has changed including
140 information about the source of the change.
141 </doc:para>
142 </doc:description>
143 </doc:doc>
144 </signal>
145
146 </interface>
147
148 </node>