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

Solid

  • solid
  • solid
battery.h
Go to the documentation of this file.
1/*
2 Copyright 2006-2007 Kevin Ottens <ervin@kde.org>
3
4 This library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the License, or (at your option) version 3, or any
8 later version accepted by the membership of KDE e.V. (or its
9 successor approved by the membership of KDE e.V.), which shall
10 act as a proxy defined in Section 6 of version 3 of the license.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library. If not, see <http://www.gnu.org/licenses/>.
19*/
20
21#ifndef SOLID_BATTERY_H
22#define SOLID_BATTERY_H
23
24#include <solid/solid_export.h>
25
26#include <solid/deviceinterface.h>
27
28namespace Solid
29{
30 class BatteryPrivate;
31 class Device;
32
36 class SOLID_EXPORT Battery : public DeviceInterface
37 {
38 Q_OBJECT
39 Q_ENUMS(BatteryType ChargeState)
40 Q_PROPERTY(bool plugged READ isPlugged)
41 Q_PROPERTY(bool powerSupply READ isPowerSupply)
42 Q_PROPERTY(BatteryType type READ type)
43 Q_PROPERTY(int chargePercent READ chargePercent)
44 Q_PROPERTY(int capacity READ capacity)
45 Q_PROPERTY(bool rechargeable READ isRechargeable)
46 Q_PROPERTY(ChargeState chargeState READ chargeState)
47 Q_DECLARE_PRIVATE(Battery)
48 friend class Device;
49
50 public:
65 enum BatteryType { UnknownBattery, PdaBattery, UpsBattery,
66 PrimaryBattery, MouseBattery, KeyboardBattery,
67 KeyboardMouseBattery, CameraBattery,
68 PhoneBattery, MonitorBattery };
69
78 enum ChargeState { NoCharge, Charging, Discharging };
79
80
81 private:
90 explicit Battery(QObject *backendObject);
91
92 public:
96 virtual ~Battery();
97
98
105 static Type deviceInterfaceType() { return DeviceInterface::Battery; }
106
112 bool isPlugged() const;
113
120 bool isPowerSupply() const;
121
128 BatteryType type() const;
129
130
131
138 int chargePercent() const;
139
149 int capacity() const;
150
151
157 bool isRechargeable() const;
158
166 ChargeState chargeState() const;
167
168 Q_SIGNALS:
176 void chargePercentChanged(int value, const QString &udi);
177
185 void capacityChanged(int value, const QString &udi);
186
196 void chargeStateChanged(int newState, const QString &udi);
197
205 void plugStateChanged(bool newState, const QString &udi);
206
215 void powerSupplyStateChanged(bool newState, const QString &udi);
216 };
217}
218
219#endif
QObject
Solid::BatteryPrivate
Definition battery_p.h:29
Solid::Battery
This device interface is available on batteries.
Definition battery.h:37
Solid::Battery::BatteryType
BatteryType
This enum type defines the type of the device holding the battery.
Definition battery.h:65
Solid::Battery::MouseBattery
@ MouseBattery
Definition battery.h:66
Solid::Battery::PdaBattery
@ PdaBattery
Definition battery.h:65
Solid::Battery::KeyboardBattery
@ KeyboardBattery
Definition battery.h:66
Solid::Battery::MonitorBattery
@ MonitorBattery
Definition battery.h:68
Solid::Battery::UnknownBattery
@ UnknownBattery
Definition battery.h:65
Solid::Battery::UpsBattery
@ UpsBattery
Definition battery.h:65
Solid::Battery::CameraBattery
@ CameraBattery
Definition battery.h:67
Solid::Battery::KeyboardMouseBattery
@ KeyboardMouseBattery
Definition battery.h:67
Solid::Battery::PhoneBattery
@ PhoneBattery
Definition battery.h:68
Solid::Battery::PrimaryBattery
@ PrimaryBattery
Definition battery.h:66
Solid::Battery::plugStateChanged
void plugStateChanged(bool newState, const QString &udi)
This signal is emitted if the battery get plugged in/out of the battery bay.
Solid::Battery::capacityChanged
void capacityChanged(int value, const QString &udi)
This signal is emitted when the capacity of this battery has changed.
Solid::Battery::rechargeable
bool rechargeable
Definition battery.h:45
Solid::Battery::Device
friend class Device
Definition battery.h:48
Solid::Battery::plugged
bool plugged
Definition battery.h:40
Solid::Battery::isPlugged
bool isPlugged() const
Indicates if this battery is plugged.
Definition battery.cpp:51
Solid::Battery::powerSupplyStateChanged
void powerSupplyStateChanged(bool newState, const QString &udi)
This signal is emitted when the power supply state of the battery changes.
Solid::Battery::isRechargeable
bool isRechargeable() const
Indicates if the battery is rechargeable.
Definition battery.cpp:81
Solid::Battery::chargeStateChanged
void chargeStateChanged(int newState, const QString &udi)
This signal is emitted when the charge state of this battery has changed.
Solid::Battery::capacity
int capacity
Definition battery.h:44
Solid::Battery::type
BatteryType type
Definition battery.h:42
Solid::Battery::powerSupply
bool powerSupply
Definition battery.h:41
Solid::Battery::isPowerSupply
bool isPowerSupply() const
Indicates if this battery is powering the machine or from an attached deviced.
Definition battery.cpp:57
Solid::Battery::chargePercentChanged
void chargePercentChanged(int value, const QString &udi)
This signal is emitted when the charge percent value of this battery has changed.
Solid::Battery::chargeState
ChargeState chargeState
Definition battery.h:46
Solid::Battery::ChargeState
ChargeState
This enum type defines charge state of a battery.
Definition battery.h:78
Solid::Battery::NoCharge
@ NoCharge
Definition battery.h:78
Solid::Battery::Charging
@ Charging
Definition battery.h:78
Solid::Battery::Discharging
@ Discharging
Definition battery.h:78
Solid::Battery::deviceInterfaceType
static Type deviceInterfaceType()
Get the Solid::DeviceInterface::Type of the Battery device interface.
Definition battery.h:105
Solid::Battery::chargePercent
int chargePercent
Definition battery.h:43
Solid::DeviceInterface::Type
Type
This enum type defines the type of device interface that a Device can have.
Definition deviceinterface.h:67
Solid::DeviceInterface::Battery
@ Battery
Definition deviceinterface.h:71
Solid::DeviceInterface::DeviceInterface
DeviceInterface(DeviceInterfacePrivate &dd, QObject *backendObject)
Definition deviceinterface.cpp:29
Solid::Device
This class allows applications to deal with devices available in the underlying system.
Definition device.h:49
deviceinterface.h
Solid
Definition acadapter.h:29
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 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.14.38 API Reference

Skip menu "kdelibs-4.14.38 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