1 : /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
2 : * vim: sw=2 ts=8 et :
3 : */
4 : /* ***** BEGIN LICENSE BLOCK *****
5 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6 : *
7 : * The contents of this file are subject to the Mozilla Public License Version
8 : * 1.1 (the "License"); you may not use this file except in compliance with
9 : * the License. You may obtain a copy of the License at:
10 : * http://www.mozilla.org/MPL/
11 : *
12 : * Software distributed under the License is distributed on an "AS IS" basis,
13 : * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14 : * for the specific language governing rights and limitations under the
15 : * License.
16 : *
17 : * The Original Code is Mozilla Code.
18 : *
19 : * The Initial Developer of the Original Code is
20 : * The Mozilla Foundation
21 : * Portions created by the Initial Developer are Copyright (C) 2011
22 : * the Initial Developer. All Rights Reserved.
23 : *
24 : * Contributor(s):
25 : * Chris Jones <jones.chris.g@gmail.com>
26 : *
27 : * Alternatively, the contents of this file may be used under the terms of
28 : * either the GNU General Public License Version 2 or later (the "GPL"), or
29 : * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
30 : * in which case the provisions of the GPL or the LGPL are applicable instead
31 : * of those above. If you wish to allow use of your version of this file only
32 : * under the terms of either the GPL or the LGPL, and not to allow others to
33 : * use your version of this file under the terms of the MPL, indicate your
34 : * decision by deleting the provisions above and replace them with the notice
35 : * and other provisions required by the GPL or the LGPL. If you do not delete
36 : * the provisions above, a recipient may use your version of this file under
37 : * the terms of any one of the MPL, the GPL or the LGPL.
38 : *
39 : * ***** END LICENSE BLOCK ***** */
40 :
41 : #ifndef nsBaseScreen_h
42 : #define nsBaseScreen_h
43 :
44 : #include "mozilla/Attributes.h"
45 : #include "nsIScreen.h"
46 :
47 : class nsBaseScreen : public nsIScreen
48 : {
49 : public:
50 : nsBaseScreen();
51 : virtual ~nsBaseScreen();
52 :
53 : NS_DECL_ISUPPORTS
54 :
55 : // nsIScreen interface
56 :
57 : /**
58 : * Simple management of screen brightness locks. This abstract base class
59 : * allows all widget implementations to share brightness locking code.
60 : */
61 : NS_IMETHOD LockMinimumBrightness(PRUint32 aBrightness);
62 : NS_IMETHOD UnlockMinimumBrightness(PRUint32 aBrightness);
63 :
64 0 : NS_IMETHOD GetRotation(PRUint32* aRotation) {
65 0 : *aRotation = nsIScreen::ROTATION_0_DEG;
66 0 : return NS_OK;
67 : }
68 0 : NS_IMETHOD SetRotation(PRUint32 aRotation) { return NS_ERROR_NOT_AVAILABLE; }
69 :
70 : protected:
71 : /**
72 : * Manually set the current level of brightness locking. This is called after
73 : * we determine, based on the current active locks, what the strongest
74 : * lock is. You should normally not call this function - it will be
75 : * called automatically by this class.
76 : *
77 : * Each widget implementation should implement this in a way that
78 : * makes sense there. This is normally the only function that
79 : * contains widget-specific code.
80 : *
81 : * The default implementation does nothing.
82 : *
83 : * @param aBrightness The current brightness level to set. If this is
84 : * nsIScreen_MOZILLA_2_0_BRANCH::BRIGHTNESS_LEVELS
85 : * (an impossible value for a brightness level to be),
86 : * then that signifies that there is no current
87 : * minimum brightness level, and the screen can shut off.
88 : */
89 0 : virtual void ApplyMinimumBrightness(PRUint32 aBrightness) { }
90 :
91 : private:
92 : /**
93 : * Checks what the minimum brightness value is, and calls
94 : * ApplyMinimumBrightness.
95 : */
96 : void CheckMinimumBrightness();
97 :
98 : PRUint32 mBrightnessLocks[nsIScreen::BRIGHTNESS_LEVELS];
99 : };
100 :
101 : #endif // nsBaseScreen_h
|