battery.h

Go to the documentation of this file.

/*
    Copyright 2006-2007 Kevin Ottens <ervin@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) version 3, or any
    later version accepted by the membership of KDE e.V. (or its
    successor approved by the membership of KDE e.V.), which shall
    act as a proxy defined in Section 6 of version 3 of the license.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef SOLID_BATTERY_H
#define SOLID_BATTERY_H

#include <solid/solid_export.h>

#include <solid/deviceinterface.h>

namespace Solid
{
    class BatteryPrivate;
    class Device;

    class SOLID_EXPORT Battery : public DeviceInterface
    {
        Q_OBJECT
        Q_ENUMS(BatteryType ChargeState)
        Q_PROPERTY(bool plugged READ isPlugged)
        Q_PROPERTY(bool powerSupply READ isPowerSupply)
        Q_PROPERTY(BatteryType type READ type)
        Q_PROPERTY(int chargePercent READ chargePercent)
        Q_PROPERTY(int capacity READ capacity)
        Q_PROPERTY(bool rechargeable READ isRechargeable)
        Q_PROPERTY(ChargeState chargeState READ chargeState)
        Q_DECLARE_PRIVATE(Battery)
        friend class Device;

    public:
        enum BatteryType { UnknownBattery, PdaBattery, UpsBattery,
                           PrimaryBattery, MouseBattery, KeyboardBattery,
                           KeyboardMouseBattery, CameraBattery,
                           PhoneBattery, MonitorBattery };

        enum ChargeState { NoCharge, Charging, Discharging };


    private:
        explicit Battery(QObject *backendObject);

    public:
        virtual ~Battery();


        static Type deviceInterfaceType() { return DeviceInterface::Battery; }

        bool isPlugged() const;

        bool isPowerSupply() const;

        BatteryType type() const;



        int chargePercent() const;

        int capacity() const;


        bool isRechargeable() const;

        ChargeState chargeState() const;

    Q_SIGNALS:
        void chargePercentChanged(int value, const QString &udi);

        void capacityChanged(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);
    };
}

#endif