daemon/dbus/org.freedesktop.UPower.KbdBacklight.xml

0001 <!DOCTYPE node PUBLIC
0002 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
0003 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd" [
0004   <!ENTITY ERROR_GENERAL "org.freedesktop.UPower.GeneralError">
0005 ]>
0006 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
0007   <interface name="org.freedesktop.UPower.KbdBacklight">
0008     <doc:doc>
0009       <doc:description>
0010         <doc:para>
0011           org.freedesktop.UPower.KbdBacklight is a DBus interface implemented
0012           by UPower.
0013           It allows the keyboard backlight (if present) to be controlled.
0014         </doc:para>
0015       </doc:description>
0016     </doc:doc>
0017
0018     <!-- ************************************************************ -->
0019     <method name="GetMaxBrightness">
0020       <arg name="value" direction="out" type="i">
0021         <doc:doc>
0022           <doc:summary>
0023             The maximum value of the keyboard backlight brightness.
0024           </doc:summary>
0025         </doc:doc>
0026       </arg>
0027       <doc:doc>
0028         <doc:description>
0029           <doc:para>
0030             Get the maximum brightness level for the keyboard backlight.
0031           </doc:para>
0032         </doc:description>
0033         <doc:errors>
0034           <doc:error name="&ERROR_GENERAL;">if an error occured while getting the maximum brightness</doc:error>
0035         </doc:errors>
0036       </doc:doc>
0037     </method>
0038
0039     <!-- ************************************************************ -->
0040     <method name="GetBrightness">
0041       <arg name="value" direction="out" type="i">
0042         <doc:doc>
0043           <doc:summary>
0044             The current value of the keyboard backlight brightness.
0045           </doc:summary>
0046         </doc:doc>
0047       </arg>
0048       <doc:doc>
0049         <doc:description>
0050           <doc:para>
0051             Get the brightness level of the keyboard backlight.
0052           </doc:para>
0053         </doc:description>
0054         <doc:errors>
0055           <doc:error name="&ERROR_GENERAL;">if an error occured while getting the brightness</doc:error>
0056         </doc:errors>
0057       </doc:doc>
0058     </method>
0059
0060     <!-- ************************************************************ -->
0061     <method name="SetBrightness">
0062       <arg name="value" direction="in" type="i">
0063         <doc:doc>
0064           <doc:summary>
0065             The value to set the KbdBacklight brightness.
0066           </doc:summary>
0067         </doc:doc>
0068       </arg>
0069       <doc:doc>
0070         <doc:description>
0071           <doc:para>
0072             Set the brightness level of the keyboard backlight.
0073           </doc:para>
0074         </doc:description>
0075         <doc:errors>
0076           <doc:error name="&ERROR_GENERAL;">if an error occured while setting the brightness</doc:error>
0077         </doc:errors>
0078       </doc:doc>
0079     </method>
0080
0081     <!-- ************************************************************ -->
0082     <signal name="BrightnessChanged">
0083       <arg name="value" direction="out" type="i">
0084         <doc:doc>
0085           <doc:summary>
0086             The new brightness value of the keyboard backlight.
0087           </doc:summary>
0088         </doc:doc>
0089       </arg>
0090       <doc:doc>
0091         <doc:description>
0092           <doc:para>
0093             The keyboard backlight brightness level has changed.
0094           </doc:para>
0095         </doc:description>
0096       </doc:doc>
0097     </signal>
0098
0099     <signal name="BrightnessChangedWithSource">
0100       <arg name="value" direction="out" type="i">
0101         <doc:doc>
0102           <doc:summary>
0103             The new brightness value of the keyboard backlight.
0104           </doc:summary>
0105         </doc:doc>
0106       </arg>
0107       <arg name="source" direction="out" type="s">
0108         <doc:doc>
0109           <doc:summary>
0110             Source of the keyboard backlight brightness change, either
0111             "external" if SetBrightness was called, or "internal" if the
0112             hardware changed the keyboard brightness itself (automatically or
0113             through a firmware-handled hotkey being pressed).
0114           </doc:summary>
0115         </doc:doc>
0116       </arg>
0117       <doc:doc>
0118         <doc:description>
0119           <doc:para>
0120             The keyboard backlight brightness level has changed including
0121             information about the source of the change.
0122           </doc:para>
0123         </doc:description>
0124       </doc:doc>
0125     </signal>
0126
0127   </interface>
0128
0129 </node>