summaryrefslogtreecommitdiffstats
path: root/src/org/cyanogenmod/hardware/KeyboardBacklight.java
blob: de32f3eb580a7604bf63e166e386e998560e2ed5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/*
 * Copyright (C) 2013 The CyanogenMod Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.cyanogenmod.hardware;

/*
 * Keyboard backlight brightness adjustment
 *
 * Exports methods to get the valid value boundaries, the
 * default and current backlight brightness, and a method to set
 * the backlight brightness.
 *
 * Values exported by min/max can be the direct values required
 * by the hardware, or a local (to KeyboardBacklightBrightness) abstraction
 * that's internally converted to something else prior to actual use. The
 * Settings user interface will normalize these into a 0-100 (percentage)
 * scale before showing them to the user, but all values passed to/from
 * the client (Settings) are in this class' scale.
 */

public class KeyboardBacklight {

    /*
     * All HAF classes should export this boolean.
     * Real implementations must, of course, return true
     */

    public static boolean isSupported() { return false; }

    /*
     * Set the keyboard backlight brightness to given integer input. That'll
     * be a value between the boundaries set by get(Max|Min)Intensity
     * (see below), and it's meant to be locally interpreted/used.
     */

    public static boolean setBrightness(int brightness)  {
        throw new UnsupportedOperationException();
    }

    /*
     * What's the maximum integer value we take for setBrightness()?
     */

    public static int getMaxBrightness()  {
        return -1;
    }

    /*
     * What's the minimum integer value we take for setBrightness()?
     */

    public static int getMinBrightness()  {
        return -1;
    }

    /*
     * What's the current brightness value?
     */

    public static int getCurBrightness()  {
        return -1;
    }

    /*
     * What's the shipping brightness value?
     */

    public static int getDefaultBrightness()  {
        return -1;
    }
}