The QSystemBatteryInfo class provides access to battery and power information from the system. More...
#include <QSystemBatteryInfo>Inherits: QObject.
Note: All functions in this class are reentrant.
This class was introduced in Qt Mobility 1.2.
| enum | BatteryStatus { BatteryUnknown, BatteryEmpty, BatteryCritical, BatteryVeryLow, ..., BatteryFull } |
| enum | ChargerType { UnknownCharger, NoCharger, WallCharger, USBCharger, ..., VariableCurrentCharger } |
| enum | ChargingState { NotCharging, Charging, ChargingError } |
| enum | EnergyUnit { UnitUnknown, UnitmAh, UnitmWh } |
|
|
| QSystemBatteryInfo ( QObject * parent = 0 ) | |
| ~QSystemBatteryInfo () | |
| QSystemBatteryInfo::BatteryStatus | batteryStatus () const |
| QSystemBatteryInfo::ChargerType | chargerType () const |
| QSystemBatteryInfo::ChargingState | chargingState () const |
| int | currentFlow () const |
| QSystemBatteryInfo::EnergyUnit | energyMeasurementUnit () const |
| int | maxBars () const |
| int | nominalCapacity () const |
| int | remainingCapacity () const |
| int | remainingCapacityBars () const |
| int | remainingCapacityPercent () const |
| int | remainingChargingTime () const |
| int | voltage () const |
| void | batteryStatusChanged ( QSystemBatteryInfo::BatteryStatus status ) |
| void | chargerTypeChanged ( QSystemBatteryInfo::ChargerType type ) |
| void | chargingStateChanged ( QSystemBatteryInfo::ChargingState state ) |
| void | currentFlowChanged ( int flow ) |
| void | nominalCapacityChanged ( int capacity ) |
| void | remainingCapacityBarsChanged ( int bars ) |
| void | remainingCapacityChanged ( int capacity ) |
| void | remainingCapacityPercentChanged ( int capacity ) |
| void | remainingChargingTimeChanged ( int time ) |
The QSystemBatteryInfo class provides access to battery and power information from the system.
Note: All functions in this class are reentrant. However, in Symbian platform this class is not reentrant since Symbian Belle (Qt Mobility version 1.2).
Warning: On Symbian this class does not support QObject::moveToThread().
This enum describes the status of the main battery.
| Constant | Value | Description |
|---|---|---|
| QSystemBatteryInfo::BatteryUnknown | -1 | Battery level undetermined. |
| QSystemBatteryInfo::BatteryEmpty | 0 | Battery level reported as 0, system will shutdown. |
| QSystemBatteryInfo::BatteryCritical | 1 | Battery level is critical 3% or less. |
| QSystemBatteryInfo::BatteryVeryLow | 2 | Battery level is very low, 10% or less. |
| QSystemBatteryInfo::BatteryLow | 3 | Battery level is low 40% or less. |
| QSystemBatteryInfo::BatteryOk | 4 | Battery level is above 40%. |
| QSystemBatteryInfo::BatteryFull | 5 | Battery level is 100%. |
This enum describes the type of charger used.
| Constant | Value | Description |
|---|---|---|
| QSystemBatteryInfo::UnknownCharger | -1 | Charger type unknown, or error. |
| QSystemBatteryInfo::NoCharger | 0 | No charger. |
| QSystemBatteryInfo::WallCharger | 1 | Using wall (mains) charger. |
| QSystemBatteryInfo::USBCharger | 2 | Using USB charger when the system cannot differentiate the current. |
| QSystemBatteryInfo::USB_500mACharger | 3 | Using USB charger at 500 mA. |
| QSystemBatteryInfo::USB_100mACharger | 4 | Using USB charger at 100 mA. |
| QSystemBatteryInfo::VariableCurrentCharger | 5 | Using variable current charger such as bicycle or solar. |
This enum describes the charging state:
| Constant | Value | Description |
|---|---|---|
| QSystemBatteryInfo::NotCharging | 0 | Battery is not charging. |
| QSystemBatteryInfo::Charging | 1 | Battery is charging. |
| QSystemBatteryInfo::ChargingError | -1 | Error. |
This enum describes the energy unit used by the system.
| Constant | Value | Description |
|---|---|---|
| QSystemBatteryInfo::UnitUnknown | -1 | Energy unit unknown. |
| QSystemBatteryInfo::UnitmAh | 0 | Energy described in milli Amp hours (mAh) |
| QSystemBatteryInfo::UnitmWh | 1 | Energy described in milli watt hours (mWh) |
This property holds the battery status.
Returns the status of the battery.
Access functions:
| QSystemBatteryInfo::BatteryStatus | batteryStatus () const |
Notifier signal:
| void | batteryStatusChanged ( QSystemBatteryInfo::BatteryStatus status ) |
This property holds the charger type.
Returns the currently used charger type.
Access functions:
| QSystemBatteryInfo::ChargerType | chargerType () const |
Notifier signal:
| void | chargerTypeChanged ( QSystemBatteryInfo::ChargerType type ) |
This property holds the charging state.
Returns the charging state.
Access functions:
| QSystemBatteryInfo::ChargingState | chargingState () const |
Notifier signal:
| void | chargingStateChanged ( QSystemBatteryInfo::ChargingState state ) |
This property holds the battery current flow.
Returns the amount of current flowing out from the battery, in milliapmeres (mA). A positive flow means discharging, a negative flow means charging, and 0 is returned if on error or information is not available.
Access functions:
| int | currentFlow () const |
Notifier signal:
| void | currentFlowChanged ( int flow ) |
This property holds the energy unit used by the system.
Returns the energy unit that the system uses.
Access functions:
| QSystemBatteryInfo::EnergyUnit | energyMeasurementUnit () const |
See also QSystemBatteryInfo::EnergyUnit.
This property holds the maximum number of bars the system uses.
Returns the maximum number of bars the system uses. If this information is not available or on error, -1 is returned.
Access functions:
| int | maxBars () const |
This property holds the nominal battery capacity.
Returns the nominal (maximum) capacity of the battery, measured in QSystemBatteryInfo::EnergyUnit. If no battery is found or on error, -1 is returned.
Access functions:
| int | nominalCapacity () const |
Notifier signal:
| void | nominalCapacityChanged ( int capacity ) |
This property holds the battery level in QSystemBatteryInfo::EnergyUnit.
Returns the remaining battery level of the battery, measured in QSystemBatteryInfo::EnergyUnit. If no battery is found or on error, -1 is returned.
Access functions:
| int | remainingCapacity () const |
Notifier signal:
| void | remainingCapacityChanged ( int capacity ) |
See also QSystemBatteryInfo::energyMeasurementUnit().
This property holds the remaining capacity in number of bars.
Returns the remaining capacity in number of bars.
Access functions:
| int | remainingCapacityBars () const |
Notifier signal:
| void | remainingCapacityBarsChanged ( int bars ) |
This property holds the battery level in percent.
Returns the remaining battery level of the battery in percent. If no battery is found or on error, -1 is returned.
Access functions:
| int | remainingCapacityPercent () const |
Notifier signal:
| void | remainingCapacityPercentChanged ( int capacity ) |
This property holds the remaining time of charging.
Returns the remaining charging time in seconds. 0 is returned if the battery is full or not charging. If no battery is found or on error, -1 is returned.
Access functions:
| int | remainingChargingTime () const |
Notifier signal:
| void | remainingChargingTimeChanged ( int time ) |
This property holds the battery voltage.
Returns the voltage of the battery, in millivolts (mV). If no battery is found or on error, -1 is returned.
Access functions:
| int | voltage () const |
Constructs a QSystemBatteryInfo object with the given parent.
Destroys the QSystemBatteryInfo object.
This signal is emitted when battery status has changed to status.
See also QSystemBatteryInfo::ChargingState.
This signal is emitted when the charger type has changed to type.
This signal is emitted when charging state has changed to state.
This signal is emitted when the current battery current has changed to flow.
On some systems, listening to this signal would lead to a CPU intensive process, so you should disconnect from this signal when finished.
This signal is emitted when nominal (maximum) battery level has changed to capacity.
This signal is emitted when the remaining capacity in the number of bars has changed to bars.
This signal is emitted when battery's remaining capacity has changed to capacity, which is reported in QSystemBatteryInfo::EnergyUnit.
See also QSystemBatteryInfo::energyMeasurementUnit.
This signal is emitted when battery capacity in percent has changed to capacity.
This signal is emitted when remianing charge time has changed to time.