#include <battery.h>

Inheritance diagram for Solid::Battery:

Public Types
enum	BatteryType { UnknownBattery, PdaBattery, UpsBattery, PrimaryBattery, MouseBattery, KeyboardBattery, KeyboardMouseBattery, CameraBattery, PhoneBattery, MonitorBattery }

enum	ChargeState { NoCharge, Charging, Discharging }

Public Types inherited from Solid::DeviceInterface
enum	Type { Unknown = 0, GenericInterface = 1, Processor = 2, Block = 3, StorageAccess = 4, StorageDrive = 5, OpticalDrive = 6, StorageVolume = 7, OpticalDisc = 8, Camera = 9, PortableMediaPlayer = 10, NetworkInterface = 11, AcAdapter = 12, Battery = 13, Button = 14, AudioInterface = 15, DvbInterface = 16, Video = 17, SerialInterface = 18, SmartCardReader = 19, InternetGateway = 20, NetworkShare = 21, Last = 0xffff }

Signals
void	capacityChanged (int value, const QString &udi)

void	chargePercentChanged (int value, const QString &udi)

void	chargeStateChanged (int newState, const QString &udi)

void	plugStateChanged (bool newState, const QString &udi)

void	powerSupplyStateChanged (bool newState, const QString &udi)

Public Member Functions
virtual	~Battery ()

int	capacity () const

int	chargePercent () const

ChargeState	chargeState () const

bool	isPlugged () const

bool	isPowerSupply () const

bool	isRechargeable () const

BatteryType	type () const

Public Member Functions inherited from Solid::DeviceInterface
virtual	~DeviceInterface ()

bool	isValid () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Static Public Member Functions
static Type	deviceInterfaceType ()

Static Public Member Functions inherited from Solid::DeviceInterface
static Type	stringToType (const QString &type)

static QString	typeDescription (Type type)

static QString	typeToString (Type type)

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Properties
int	capacity

int	chargePercent

ChargeState	chargeState

bool	plugged

bool	powerSupply

bool	rechargeable

BatteryType	type

Properties inherited from QObject
	objectName

Additional Inherited Members
Protected Member Functions inherited from Solid::DeviceInterface
	DeviceInterface (DeviceInterfacePrivate &dd, QObject *backendObject)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Protected Attributes inherited from Solid::DeviceInterface
DeviceInterfacePrivate *	d_ptr

Detailed Description

This device interface is available on batteries.

Definition at line 36 of file battery.h.

Member Enumeration Documentation

enum Solid::Battery::BatteryType

This enum type defines the type of the device holding the battery.

PdaBattery : A battery in a Personal Digital Assistant
UpsBattery : A battery in an Uninterruptible Power Supply
PrimaryBattery : A primary battery for the system (for example laptop battery)
MouseBattery : A battery in a mouse
KeyboardBattery : A battery in a keyboard
KeyboardMouseBattery : A battery in a combined keyboard and mouse
CameraBattery : A battery in a camera
PhoneBattery : A battery in a phone
MonitorBattery : A battery in a monitor
UnknownBattery : A battery in an unknown device

Enumerator
UnknownBattery
PdaBattery
UpsBattery
PrimaryBattery
MouseBattery
KeyboardBattery
KeyboardMouseBattery
CameraBattery
PhoneBattery
MonitorBattery

Definition at line 65 of file battery.h.

enum Solid::Battery::ChargeState

This enum type defines charge state of a battery.

NoCharge : Battery charge is stable, not charging or discharging or the state is Unknown
Charging : Battery is charging
Discharging : Battery is discharging

Enumerator
NoCharge
Charging
Discharging

Definition at line 78 of file battery.h.

Constructor & Destructor Documentation

Solid::Battery::~Battery ( )

virtual

Destroys a Battery object.

Definition at line 46 of file battery.cpp.

Member Function Documentation

int Solid::Battery::capacity ( ) const

Retrieves the battery capacity normalised to percent, meaning how much energy can it hold compared to what it is designed to.

The capacity of the battery will reduce with age. A capacity value less than 75% is usually a sign that you should renew your battery.

Since: 4.11

Returns: the battery capacity normalised to percent

void Solid::Battery::capacityChanged	(	int	value,
		const QString &	udi
	)

signal

This signal is emitted when the capacity of this battery has changed.

Parameters

value	the new capacity of the battery
udi	the UDI of the battery with the new capacity

Since: 4.11

int Solid::Battery::chargePercent ( ) const

Retrieves the current charge level of the battery normalised to percent.

Returns: the current charge level normalised to percent

void Solid::Battery::chargePercentChanged	(	int	value,
		const QString &	udi
	)

signal

This signal is emitted when the charge percent value of this battery has changed.

Parameters

value	the new charge percent value of the battery
udi	the UDI of the battery with the new charge percent

ChargeState Solid::Battery::chargeState ( ) const

Retrieves the current charge state of the battery.

It can be in a stable state (no charge), charging or discharging.

Returns: the current battery charge state

See also: Solid::Battery::ChargeState

void Solid::Battery::chargeStateChanged	(	int	newState,
		const QString &	udi
	)

signal

This signal is emitted when the charge state of this battery has changed.

Parameters

newState the new charge state of the battery, it's one of the type Solid::Battery::ChargeState

See also: Solid::Battery::ChargeState

Parameters

udi	the UDI of the battery with the new charge state

static Type Solid::Battery::deviceInterfaceType ( )

inlinestatic

Get the Solid::DeviceInterface::Type of the Battery device interface.

Returns: the Battery device interface type

See also: Solid::DeviceInterface::Type

Definition at line 105 of file battery.h.

bool Solid::Battery::isPlugged ( ) const

Indicates if this battery is plugged.

Returns: true if the battery is plugged, false otherwise

Definition at line 51 of file battery.cpp.

bool Solid::Battery::isPowerSupply ( ) const

Indicates if this battery is powering the machine or from an attached deviced.

Since: 4.11

Returns: true the battery is a powersupply, false otherwise

Definition at line 57 of file battery.cpp.

bool Solid::Battery::isRechargeable ( ) const

Indicates if the battery is rechargeable.

Returns: true if the battery is rechargeable, false otherwise (one time usage)

Definition at line 81 of file battery.cpp.

void Solid::Battery::plugStateChanged	(	bool	newState,
		const QString &	udi
	)

signal

This signal is emitted if the battery get plugged in/out of the battery bay.

Parameters

newState	the new plugging state of the battery, type is boolean
udi	the UDI of the battery with the new plugging state

void Solid::Battery::powerSupplyStateChanged	(	bool	newState,
		const QString &	udi
	)

signal

This signal is emitted when the power supply state of the battery changes.

Parameters

newState	the new power supply state, type is boolean
udi	the UDI of the battery with the new power supply state

Since: 4.11

BatteryType Solid::Battery::type ( ) const

Retrieves the type of device holding this battery.

Returns: the type of device holding this battery

See also: Solid::Battery::BatteryType

Property Documentation

int Solid::Battery::capacity

read

Definition at line 44 of file battery.h.

int Solid::Battery::chargePercent

read

Definition at line 43 of file battery.h.

Solid::Battery::ChargeState Solid::Battery::chargeState

read

Definition at line 46 of file battery.h.

bool Solid::Battery::plugged

read

Definition at line 40 of file battery.h.

bool Solid::Battery::powerSupply

read

Definition at line 41 of file battery.h.

bool Solid::Battery::rechargeable

read

Definition at line 45 of file battery.h.

Solid::Battery::BatteryType Solid::Battery::type

read

Definition at line 42 of file battery.h.

The documentation for this class was generated from the following files:

Solid

Public Types

Signals

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation

Solid

kdelibs API Reference

Search