1 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 : /* ***** BEGIN LICENSE BLOCK *****
3 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 : *
5 : * The contents of this file are subject to the Mozilla Public License Version
6 : * 1.1 (the "License"); you may not use this file except in compliance with
7 : * the License. You may obtain a copy of the License at
8 : * http://www.mozilla.org/MPL/
9 : *
10 : * Software distributed under the License is distributed on an "AS IS" basis,
11 : * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 : * for the specific language governing rights and limitations under the
13 : * License.
14 : *
15 : * The Original Code is mozilla.org code.
16 : *
17 : * The Initial Developer of the Original Code is Mozilla Foundation
18 : * Portions created by the Initial Developer are Copyright (C) 2011
19 : * the Initial Developer. All Rights Reserved.
20 : *
21 : * Contributor(s):
22 : * Mounir Lamouri <mounir.lamouri@mozilla.com> (Original Author)
23 : *
24 : * Alternatively, the contents of this file may be used under the terms of
25 : * either of the GNU General Public License Version 2 or later (the "GPL"),
26 : * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 : * in which case the provisions of the GPL or the LGPL are applicable instead
28 : * of those above. If you wish to allow use of your version of this file only
29 : * under the terms of either the GPL or the LGPL, and not to allow others to
30 : * use your version of this file under the terms of the MPL, indicate your
31 : * decision by deleting the provisions above and replace them with the notice
32 : * and other provisions required by the GPL or the LGPL. If you do not delete
33 : * the provisions above, a recipient may use your version of this file under
34 : * the terms of any one of the MPL, the GPL or the LGPL.
35 : *
36 : * ***** END LICENSE BLOCK ***** */
37 :
38 : #ifndef mozilla_dom_battery_BatteryManager_h
39 : #define mozilla_dom_battery_BatteryManager_h
40 :
41 : #include "nsIDOMBatteryManager.h"
42 : #include "nsDOMEventTargetHelper.h"
43 : #include "nsCycleCollectionParticipant.h"
44 : #include "mozilla/Observer.h"
45 : #include "Types.h"
46 : #include "nsDOMEventTargetHelper.h"
47 :
48 : class nsPIDOMWindow;
49 : class nsIScriptContext;
50 :
51 : namespace mozilla {
52 :
53 : namespace hal {
54 : class BatteryInformation;
55 : } // namespace hal
56 :
57 : namespace dom {
58 : namespace battery {
59 :
60 : class BatteryManager : public nsDOMEventTargetHelper
61 : , public nsIDOMMozBatteryManager
62 : , public BatteryObserver
63 0 : {
64 : public:
65 : NS_DECL_ISUPPORTS
66 : NS_DECL_NSIDOMMOZBATTERYMANAGER
67 0 : NS_FORWARD_NSIDOMEVENTTARGET(nsDOMEventTargetHelper::)
68 :
69 : BatteryManager();
70 :
71 : void Init(nsPIDOMWindow *aWindow);
72 : void Shutdown();
73 :
74 : // For IObserver.
75 : void Notify(const hal::BatteryInformation& aBatteryInfo);
76 :
77 1464 : NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(BatteryManager,
78 : nsDOMEventTargetHelper)
79 :
80 : /**
81 : * Returns whether the battery api is supported (ie. not disabled by the user)
82 : * @return whether the battery api is supported.
83 : */
84 : static bool HasSupport();
85 :
86 :
87 : private:
88 : /**
89 : * Dispatch a trusted non-cancellable and non-bubbling event to itself.
90 : */
91 : nsresult DispatchTrustedEventToSelf(const nsAString& aEventName);
92 :
93 : /**
94 : * Update the battery information stored in the battery manager object using
95 : * a battery information object.
96 : */
97 : void UpdateFromBatteryInfo(const hal::BatteryInformation& aBatteryInfo);
98 :
99 : double mLevel;
100 : bool mCharging;
101 : /**
102 : * Represents the discharging time or the charging time, dpending on the
103 : * current battery status (charging or not).
104 : */
105 : double mRemainingTime;
106 :
107 : NS_DECL_EVENT_HANDLER(levelchange)
108 : NS_DECL_EVENT_HANDLER(chargingchange)
109 : NS_DECL_EVENT_HANDLER(chargingtimechange)
110 : NS_DECL_EVENT_HANDLER(dischargingtimechange)
111 : };
112 :
113 : } // namespace battery
114 : } // namespace dom
115 : } // namespace mozilla
116 :
117 : #endif // mozilla_dom_battery_BatteryManager_h
|