• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.2 API Reference
  • KDE Home
  • Contact Us
 

Solid

  • Solid
  • Battery
Public Types | Signals | Public Member Functions | Static Public Member Functions | Properties
Solid::Battery Class Reference

#include <battery.h>

Inheritance diagram for Solid::Battery:
Solid::DeviceInterface QObject

List of all members.

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 chargePercentChanged (int value, const QString &udi)
void chargeStateChanged (int newState, const QString &udi)
void plugStateChanged (bool newState, const QString &udi)

Public Member Functions

virtual ~Battery ()
int chargePercent () const
ChargeState chargeState () const
bool isPlugged () const
bool isRechargeable () const
BatteryType type () const
- Public Member Functions inherited from Solid::DeviceInterface
virtual ~DeviceInterface ()
bool isValid () 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)

Properties

int chargePercent
ChargeState chargeState
bool plugged
bool rechargeable
BatteryType type

Additional Inherited Members

- Protected Member Functions inherited from Solid::DeviceInterface
 DeviceInterface (DeviceInterfacePrivate &dd, QObject *backendObject)
- 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 63 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 76 of file battery.h.


Constructor & Destructor Documentation

Solid::Battery::~Battery ( )
virtual

Destroys a Battery object.

Definition at line 40 of file battery.cpp.


Member Function Documentation

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:
valuethe new charge percent value of the battery
udithe 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:
newStatethe new charge state of the battery, it's one of the type Solid::Battery::ChargeState
See also:
Solid::Battery::ChargeState
Parameters:
udithe 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 103 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 45 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 63 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:
newStatethe new plugging state of the battery, type is boolean
udithe UDI of the battery with the new plugging state
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::chargePercent
read

Definition at line 42 of file battery.h.

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

Definition at line 44 of file battery.h.

bool Solid::Battery::plugged
read

Definition at line 40 of file battery.h.

bool Solid::Battery::rechargeable
read

Definition at line 43 of file battery.h.

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

Definition at line 41 of file battery.h.


The documentation for this class was generated from the following files:
  • battery.h
  • battery.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sun Apr 28 2013 14:25:19 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Solid

Skip menu "Solid"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.10.2 API Reference

Skip menu "kdelibs-4.10.2 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal