Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

QPowerStatus Class Reference
[QtBaseModule]

The QPowerStatus class provides a simplified interface to the device's primary power sources. More...

    #include <QPowerStatus>

Inherits QObject.

List of all members, including inherited members

Public Types

enum BatteryStatus { Normal, Low, VeryLow, Critical, NoBattery }
enum WallStatus { Available, NotAvailable, NoWallSource }

Public Functions

QPowerStatus ( QObject * parent = 0 )
virtual ~QPowerStatus ()
bool batteryCharging () const
QPowerSource * batterySource () const
BatteryStatus batteryStatus () const
QPowerSource * wallSource () const
WallStatus wallStatus () const

29 public functions inherited from QObject

Signals

void batteryChargingChanged ( bool charging )
void batteryStatusChanged ( QPowerStatus::BatteryStatus status )
void wallStatusChanged ( QPowerStatus::WallStatus status )

1 signal inherited from QObject

Additional Inherited Members

1 property inherited from QObject
1 public slot inherited from QObject
1 public type inherited from QObject
4 static public members inherited from QObject
7 protected functions inherited from QObject
2 protected variables inherited from QObject

Detailed Description

The QPowerStatus class provides a simplified interface to the device's primary power sources.

Applications may use the QPowerStatus class to obtain a simplified view of the system's power status. A more complete view can be obtained by examining the supported QPowerSource providers.

Each device may contain two primary power sources - a primary wall power source and a primary battery power source. Both sources are optional, and a specific device may have one, both or neither.

The primary power source sources are selected from the list of available QPowerSource providers. The selection may be configured in the Trolltech/HardwareAccessories configuration file in the following way:

Key	Description
PowerSources/PrimaryWallSource	Name of the QPowerSource to use as the primary wall source.
PowerSources/PrimaryBatterySource	Name of the QPowerSource to use as the primary battery source.

If the primary wall source is not configured, the PrimaryAC QPowerSource name is tried first, and, if not available, the first AC source is used. If the primary wall source is configured, but the specified provider does not exist, then no QPowerSource is used.

If the primary battery source is not configured, the DefaultBattery QPowerSource is tried first, and, if not available, the first battery source is used. If the primary battery source is configured, but the specified provider does not exist, then no QPowerSource is used.

The battery status level is determined by mapping a battery percentage to one the four defined levels. The configuration for the various battery status levels are also defined in the Trolltech/HardwareAccessories configuration file in the following way:

Key	Description
PrimaryBattery/NormalStatus	If the battery charge is above this percentage level, it is considered Normal. The default is 30.
PrimaryBattery/LowStatus	If the battery charge is above this percentage level, but below the normal status level, it is considered Low. The default is 15.
PrimaryBattery/VeryLowStatus	If the battery charge is above this percentage level, but below the low status level, it is considered very Low. The default is 5.

If any one of these values is specified illegally (for example, the NormalStatus is lower than the LowStatus), the default values are used.

Member Type Documentation

enum QPowerStatus::BatteryStatus

Describes the status of the device's battery connection.

Constant	Value	Description
`QPowerStatus::Normal`	`0`	The battery level is within normal operational range.
`QPowerStatus::Low`	`1`	The battery is low.
`QPowerStatus::VeryLow`	`2`	The battery is very low.
`QPowerStatus::Critical`	`3`	The battery is at a critical level. The device should shut down to preserve data.
`QPowerStatus::NoBattery`	`4`	There is no battery in the device.

enum QPowerStatus::WallStatus

Describes the status of the device's wall connection.

Constant	Value	Description
`QPowerStatus::Available`	`0`	The device is connected to a wall power supply.
`QPowerStatus::NotAvailable`	`1`	The device is not connected to a wall power supply, but connection is supported.
`QPowerStatus::NoWallSource`	`2`	The device is not connected to a wall power supply, and no such connection is supported.

Member Function Documentation

QPowerStatus::QPowerStatus ( QObject * parent = 0 )

Construct a new QPowerStatus instance with the specified parent.

QPowerStatus::~QPowerStatus () `[virtual]`

Destroy the QPowerStatus instance.

bool QPowerStatus::batteryCharging () const

Returns true if the primary battery is charging, false if not. If there is no primary battery, false is returned.

void QPowerStatus::batteryChargingChanged ( bool charging ) `[signal]`

This signal is emitted when the batteries charging flag changes.

QPowerSource * QPowerStatus::batterySource () const

Returns a pointer to the QPowerSource instance representing the primary battery power source, or null if there is no primary battery power source.

BatteryStatus QPowerStatus::batteryStatus () const

Returns the status of the primary battery power source, or NoBattery if there is no primary battery source.

void QPowerStatus::batteryStatusChanged ( QPowerStatus::BatteryStatus status ) `[signal]`

This signal is emitted whenever the battery status changes.

QPowerSource * QPowerStatus::wallSource () const

Returns a pointer to the QPowerSource instance representing the primary wall power source, or null if there is no primary wall power source.

WallStatus QPowerStatus::wallStatus () const

Return the status of the primary wall power source, or NoWallSource if there is no primary wall power source.

void QPowerStatus::wallStatusChanged ( QPowerStatus::WallStatus status ) `[signal]`

This signal is emitted whenever the wall status changes.

QPowerStatus Class Reference[QtBaseModule]