hal/doc/spec hal-spec-properties.xml,1.1,1.2

[Richard Hughes]

Update of /cvs/hal/hal/doc/spec
In directory kemper:/tmp/cvs-serv25503/doc/spec

Modified Files:
	hal-spec-properties.xml 
Log Message:
2006-05-09  Richard Hughes  <richard at hughsie.com>
 * doc/spec/hal-spec-properties.xml: Add org.freedesktop.Hal.Device.LaptopPanel.GetBrightness and  org.freedesktop.Hal.Device.LaptopPanel.SetBrightness descriptions to the spec file.


Index: hal-spec-properties.xml
===================================================================
RCS file: /cvs/hal/hal/doc/spec/hal-spec-properties.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- hal-spec-properties.xml	9 May 2006 16:36:45 -0000	1.1
+++ hal-spec-properties.xml	9 May 2006 17:41:56 -0000	1.2
@@ -4058,6 +4058,56 @@
           </tbody>
         </tgroup>
       </informaltable>
+      <para>
+        The following methods exist on the interface
+        <literal>org.freedesktop.Hal.Device.LaptopPanel</literal>.
+      </para>
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>Method (parameter types)</entry>
+              <entry>Parameters</entry>
+              <entry>Mandatory</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry>
+                <literal>SetBrightness</literal> (integer)
+              </entry>
+              <entry>
+                The hardware brightness state, which should be between 0 and 
+                <literal>laptop_panel.num_levels</literal> - 1.
+              </entry>
+              <entry>No</entry>
+              <entry>
+                This method adjusts the brightness on an laptop screen.
+                The values are returned as hardware values rather than
+                percentages as we cannot easily to floating point rounding in
+                shell code and therefore use the raw values to prevent integer
+                rounding errors.
+              </entry>
+            </row>
+            <row>
+              <entry>
+                integer <literal>GetBrightness</literal> (void)
+              </entry>
+              <entry>
+                Returns the hardware brightness state, which should be
+                between 0 and <literal>laptop_panel.num_levels</literal> - 1.
+              </entry>
+              <entry>No</entry>
+              <entry>
+                This method gets the hardware brightness of the laptop screen,
+                which we may need to do fairly regually on hardware that
+                changes the values in hardware without a software event.
+              </entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
     </sect2>
     <sect2 id="device-properties-ac_adaptor">
       <title>