forked from quickshell/quickshell
240 lines
9.9 KiB
C++
240 lines
9.9 KiB
C++
#pragma once
|
|
|
|
#include <qcontainerfwd.h>
|
|
#include <qobject.h>
|
|
#include <qqmlintegration.h>
|
|
#include <qtmetamacros.h>
|
|
#include <qtypes.h>
|
|
|
|
#include "../../core/doc.hpp"
|
|
#include "../../dbus/properties.hpp"
|
|
#include "dbus_device.h"
|
|
|
|
namespace qs::service::upower {
|
|
|
|
///! Power state of a UPower device.
|
|
/// See @@UPowerDevice.state.
|
|
class UPowerDeviceState: public QObject {
|
|
Q_OBJECT;
|
|
QML_ELEMENT;
|
|
QML_SINGLETON;
|
|
|
|
public:
|
|
enum Enum {
|
|
Unknown = 0,
|
|
Charging = 1,
|
|
Discharging = 2,
|
|
Empty = 3,
|
|
FullyCharged = 4,
|
|
/// The device is waiting to be charged after it was plugged in.
|
|
PendingCharge = 5,
|
|
/// The device is waiting to be discharged after being unplugged.
|
|
PendingDischarge = 6,
|
|
};
|
|
Q_ENUM(Enum);
|
|
|
|
Q_INVOKABLE static QString toString(qs::service::upower::UPowerDeviceState::Enum status);
|
|
};
|
|
|
|
///! Type of a UPower device.
|
|
/// See @@UPowerDevice.type.
|
|
class UPowerDeviceType: public QObject {
|
|
Q_OBJECT;
|
|
QML_ELEMENT;
|
|
QML_SINGLETON;
|
|
|
|
public:
|
|
enum Enum {
|
|
Unknown = 0,
|
|
LinePower = 1,
|
|
Battery = 2,
|
|
Ups = 3,
|
|
Monitor = 4,
|
|
Mouse = 5,
|
|
Keyboard = 6,
|
|
Pda = 7,
|
|
Phone = 8,
|
|
MediaPlayer = 9,
|
|
Tablet = 10,
|
|
Computer = 11,
|
|
GamingInput = 12,
|
|
Pen = 13,
|
|
Touchpad = 14,
|
|
Modem = 15,
|
|
Network = 16,
|
|
Headset = 17,
|
|
Speakers = 18,
|
|
Headphones = 19,
|
|
Video = 20,
|
|
OtherAudio = 21,
|
|
RemoteControl = 22,
|
|
Printer = 23,
|
|
Scanner = 24,
|
|
Camera = 25,
|
|
Wearable = 26,
|
|
Toy = 27,
|
|
BluetoothGeneric = 28,
|
|
};
|
|
Q_ENUM(Enum);
|
|
|
|
Q_INVOKABLE static QString toString(qs::service::upower::UPowerDeviceType::Enum type);
|
|
};
|
|
|
|
struct PowerPercentage;
|
|
|
|
} // namespace qs::service::upower
|
|
|
|
namespace qs::dbus {
|
|
|
|
template <>
|
|
struct DBusDataTransform<qs::service::upower::UPowerDeviceState::Enum> {
|
|
using Wire = quint32;
|
|
using Data = qs::service::upower::UPowerDeviceState::Enum;
|
|
static DBusResult<Data> fromWire(Wire wire);
|
|
};
|
|
|
|
template <>
|
|
struct DBusDataTransform<qs::service::upower::UPowerDeviceType::Enum> {
|
|
using Wire = quint32;
|
|
using Data = qs::service::upower::UPowerDeviceType::Enum;
|
|
static DBusResult<Data> fromWire(Wire wire);
|
|
};
|
|
|
|
template <>
|
|
struct DBusDataTransform<qs::service::upower::PowerPercentage> {
|
|
using Wire = qreal;
|
|
using Data = qreal;
|
|
static DBusResult<Data> fromWire(Wire wire);
|
|
};
|
|
|
|
} // namespace qs::dbus
|
|
|
|
namespace qs::service::upower {
|
|
|
|
///! A device exposed through the UPower system service.
|
|
class UPowerDevice: public QObject {
|
|
Q_OBJECT;
|
|
// clang-format off
|
|
/// The type of device.
|
|
Q_PROPERTY(qs::service::upower::UPowerDeviceType::Enum type READ type NOTIFY typeChanged BINDABLE bindableType);
|
|
/// If the device is a power supply for your computer and can provide charge.
|
|
Q_PROPERTY(bool powerSupply READ powerSupply NOTIFY powerSupplyChanged BINDABLE bindablePowerSupply);
|
|
/// Current energy level of the device in watt-hours.
|
|
Q_PROPERTY(qreal energy READ energy NOTIFY energyChanged BINDABLE bindableEnergy);
|
|
/// Maximum energy capacity of the device in watt-hours
|
|
Q_PROPERTY(qreal energyCapacity READ energyCapacity NOTIFY energyCapacityChanged BINDABLE bindableEnergyCapacity);
|
|
/// Rate of energy change in watts (positive when charging, negative when discharging).
|
|
Q_PROPERTY(qreal changeRate READ changeRate NOTIFY changeRateChanged BINDABLE bindableChangeRate);
|
|
/// Estimated time until the device is fully discharged, in seconds.
|
|
///
|
|
/// Will be set to `0` if charging.
|
|
Q_PROPERTY(qreal timeToEmpty READ timeToEmpty NOTIFY timeToEmptyChanged BINDABLE bindableTimeToEmpty);
|
|
/// Estimated time until the device is fully charged, in seconds.
|
|
///
|
|
/// Will be set to `0` if discharging.
|
|
Q_PROPERTY(qreal timeToFull READ timeToFull NOTIFY timeToFullChanged BINDABLE bindableTimeToFull);
|
|
/// Current charge level as a percentage.
|
|
///
|
|
/// This would be equivalent to @@energy / @@energyCapacity.
|
|
Q_PROPERTY(qreal percentage READ percentage NOTIFY percentageChanged BINDABLE bindablePercentage);
|
|
/// If the power source is present in the bay or slot, useful for hot-removable batteries.
|
|
///
|
|
/// If the device `type` is not `Battery`, then the property will be invalid.
|
|
Q_PROPERTY(bool isPresent READ isPresent NOTIFY isPresentChanged BINDABLE bindableIsPresent);
|
|
/// Current state of the device.
|
|
Q_PROPERTY(qs::service::upower::UPowerDeviceState::Enum state READ state NOTIFY stateChanged BINDABLE bindableState);
|
|
/// Health of the device as a percentage of its original health.
|
|
Q_PROPERTY(qreal healthPercentage READ healthPercentage NOTIFY healthPercentageChanged BINDABLE bindableHealthPercentage);
|
|
Q_PROPERTY(bool healthSupported READ healthSupported NOTIFY healthSupportedChanged BINDABLE bindableHealthSupported);
|
|
/// Name of the icon representing the current state of the device, or an empty string if not provided.
|
|
Q_PROPERTY(QString iconName READ iconName NOTIFY iconNameChanged BINDABLE bindableIconName);
|
|
/// If the device is a laptop battery or not. Use this to check if your device is a valid battery.
|
|
///
|
|
/// This will be equivalent to @@type == Battery && @@powerSupply == true.
|
|
Q_PROPERTY(bool isLaptopBattery READ isLaptopBattery NOTIFY isLaptopBatteryChanged BINDABLE bindableIsLaptopBattery);
|
|
/// Native path of the device specific to your OS.
|
|
Q_PROPERTY(QString nativePath READ nativePath NOTIFY nativePathChanged BINDABLE bindableNativePath);
|
|
// clang-format on
|
|
QML_ELEMENT;
|
|
QML_UNCREATABLE("UPowerDevices can only be acquired from UPower");
|
|
|
|
public:
|
|
explicit UPowerDevice(const QString& path, QObject* parent = nullptr);
|
|
|
|
[[nodiscard]] bool isValid() const;
|
|
[[nodiscard]] QString address() const;
|
|
[[nodiscard]] QString path() const;
|
|
|
|
QS_BINDABLE_GETTER(UPowerDeviceType::Enum, bType, type, bindableType);
|
|
QS_BINDABLE_GETTER(bool, bPowerSupply, powerSupply, bindablePowerSupply);
|
|
QS_BINDABLE_GETTER(qreal, bEnergy, energy, bindableEnergy);
|
|
QS_BINDABLE_GETTER(qreal, bEnergyCapacity, energyCapacity, bindableEnergyCapacity);
|
|
QS_BINDABLE_GETTER(qreal, bChangeRate, changeRate, bindableChangeRate);
|
|
QS_BINDABLE_GETTER(qlonglong, bTimeToEmpty, timeToEmpty, bindableTimeToEmpty);
|
|
QS_BINDABLE_GETTER(qlonglong, bTimeToFull, timeToFull, bindableTimeToFull);
|
|
QS_BINDABLE_GETTER(qreal, bPercentage, percentage, bindablePercentage);
|
|
QS_BINDABLE_GETTER(bool, bIsPresent, isPresent, bindableIsPresent);
|
|
QS_BINDABLE_GETTER(UPowerDeviceState::Enum, bState, state, bindableState);
|
|
QS_BINDABLE_GETTER(qreal, bHealthPercentage, healthPercentage, bindableHealthPercentage);
|
|
QS_BINDABLE_GETTER(bool, bHealthSupported, healthSupported, bindableHealthSupported);
|
|
QS_BINDABLE_GETTER(QString, bIconName, iconName, bindableIconName);
|
|
QS_BINDABLE_GETTER(bool, bIsLaptopBattery, isLaptopBattery, bindableIsLaptopBattery);
|
|
QS_BINDABLE_GETTER(QString, bNativePath, nativePath, bindableNativePath);
|
|
|
|
signals:
|
|
QSDOC_HIDE void ready();
|
|
|
|
void typeChanged();
|
|
void powerSupplyChanged();
|
|
void energyChanged();
|
|
void energyCapacityChanged();
|
|
void changeRateChanged();
|
|
void timeToEmptyChanged();
|
|
void timeToFullChanged();
|
|
void percentageChanged();
|
|
void isPresentChanged();
|
|
void stateChanged();
|
|
void healthPercentageChanged();
|
|
void healthSupportedChanged();
|
|
void iconNameChanged();
|
|
void isLaptopBatteryChanged();
|
|
void nativePathChanged();
|
|
|
|
private:
|
|
// clang-format off
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, UPowerDeviceType::Enum, bType, &UPowerDevice::typeChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, bool, bPowerSupply, &UPowerDevice::powerSupplyChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, qreal, bEnergy, &UPowerDevice::energyChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, qreal, bEnergyCapacity, &UPowerDevice::energyCapacityChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, qreal, bChangeRate, &UPowerDevice::changeRateChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, qlonglong, bTimeToEmpty, &UPowerDevice::timeToEmptyChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, qlonglong, bTimeToFull, &UPowerDevice::timeToFullChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, qreal, bPercentage, &UPowerDevice::percentageChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, bool, bIsPresent, &UPowerDevice::isPresentChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, UPowerDeviceState::Enum, bState, &UPowerDevice::stateChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, qreal, bHealthPercentage, &UPowerDevice::healthPercentageChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, bool, bHealthSupported, &UPowerDevice::healthSupportedChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, QString, bIconName, &UPowerDevice::iconNameChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, bool, bIsLaptopBattery, &UPowerDevice::isLaptopBatteryChanged);
|
|
Q_OBJECT_BINDABLE_PROPERTY(UPowerDevice, QString, bNativePath, &UPowerDevice::nativePathChanged);
|
|
|
|
QS_DBUS_BINDABLE_PROPERTY_GROUP(UPowerDevice, deviceProperties);
|
|
QS_DBUS_PROPERTY_BINDING(UPowerDevice, pType, bType, deviceProperties, "Type");
|
|
QS_DBUS_PROPERTY_BINDING(UPowerDevice, pPowerSupply, bPowerSupply, deviceProperties, "PowerSupply");
|
|
QS_DBUS_PROPERTY_BINDING(UPowerDevice, pEnergy, bEnergy, deviceProperties, "Energy");
|
|
QS_DBUS_PROPERTY_BINDING(UPowerDevice, pEnergyCapacity, bEnergyCapacity, deviceProperties, "EnergyFull");
|
|
QS_DBUS_PROPERTY_BINDING(UPowerDevice, pChangeRate, bChangeRate, deviceProperties, "EnergyRate");
|
|
QS_DBUS_PROPERTY_BINDING(UPowerDevice, pTimeToEmpty, bTimeToEmpty, deviceProperties, "TimeToEmpty");
|
|
QS_DBUS_PROPERTY_BINDING(UPowerDevice, pTimeToFull, bTimeToFull, deviceProperties, "TimeToFull");
|
|
QS_DBUS_PROPERTY_BINDING(UPowerDevice, PowerPercentage, pPercentage, bPercentage, deviceProperties, "Percentage", true);
|
|
QS_DBUS_PROPERTY_BINDING(UPowerDevice, pIsPresent, bIsPresent, deviceProperties, "IsPresent");
|
|
QS_DBUS_PROPERTY_BINDING(UPowerDevice, pState, bState, deviceProperties, "State");
|
|
QS_DBUS_PROPERTY_BINDING(UPowerDevice, pHealthPercentage, bHealthPercentage, deviceProperties, "Capacity");
|
|
QS_DBUS_PROPERTY_BINDING(UPowerDevice, pIconName, bIconName, deviceProperties, "IconName");
|
|
QS_DBUS_PROPERTY_BINDING(UPowerDevice, pNativePath, bNativePath, deviceProperties, "NativePath");
|
|
// clang-format on
|
|
|
|
DBusUPowerDevice* device = nullptr;
|
|
};
|
|
|
|
} // namespace qs::service::upower
|