tderootsystemdevice.h

/* This file is part of the TDE libraries
   Copyright (C) 2012 Timothy Pearson <kb9vqf@pearsoncomputing.net>
             (C) 2013 Golubev Alexander <fatzer2@gmail.com>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef _TDEROOTSYSTEMDEVICE_H
#define _TDEROOTSYSTEMDEVICE_H

#include "tdegenericdevice.h"
#include "tdehwcommontypes.h"

namespace TDESystemFormFactor {
enum TDESystemFormFactor {
    Unclassified,
    Desktop,
    Laptop,
    Server,
    Other = 0x80000000
};
};

namespace TDESystemPowerState {
enum TDESystemPowerState {
    Active,
    Standby,
    Freeze,
    Suspend,
    Hibernate,
    PowerOff,
    Reboot,
    HybridSuspend,
    Disk   // Used temporarily to detect hibernation and hybrid suspend capability
};
};

namespace TDESystemHibernationMethod {
enum TDESystemHibernationMethod {
    Unsupported,
    Platform,
    Shutdown,
    Reboot,
    TestProc,
    Test,
    Suspend
};
};

typedef TQValueList<TDESystemPowerState::TDESystemPowerState> TDESystemPowerStateList;
typedef TQValueList<TDESystemHibernationMethod::TDESystemHibernationMethod> TDESystemHibernationMethodList;

class TDECORE_EXPORT TDERootSystemDevice : public TDEGenericDevice
{
    public:
        TDERootSystemDevice(TDEGenericDeviceType::TDEGenericDeviceType dt, TQString dn=TQString::null);

        ~TDERootSystemDevice();

        TDESystemFormFactor::TDESystemFormFactor formFactor();

        TDESystemPowerStateList powerStates();

        TDESystemHibernationMethodList hibernationMethods();

        TDESystemHibernationMethod::TDESystemHibernationMethod hibernationMethod();

        unsigned long diskSpaceNeededForHibernation();

        bool canSetHibernationMethod();

        bool canStandby();

        bool canFreeze();

        bool canSuspend();

        bool canHibernate();

        bool canHybridSuspend();

        bool canPowerOff();

        bool canReboot();

        void setHibernationMethod(TDESystemHibernationMethod::TDESystemHibernationMethod hm);

        bool setPowerState(TDESystemPowerState::TDESystemPowerState ps);

    protected:
        void internalSetFormFactor(TDESystemFormFactor::TDESystemFormFactor ff);

        void internalSetPowerStates(TDESystemPowerStateList ps);

        void internalSetHibernationMethods(TDESystemHibernationMethodList hm);

        void internalSetHibernationMethod(TDESystemHibernationMethod::TDESystemHibernationMethod hm);

        void internalSetDiskSpaceNeededForHibernation(unsigned long sz);

    private:
        TDESystemFormFactor::TDESystemFormFactor m_formFactor;
        TDESystemPowerStateList m_powerStates;
        TDESystemHibernationMethodList m_hibernationMethods;
        TDESystemHibernationMethod::TDESystemHibernationMethod m_hibernationMethod;
        unsigned long m_hibernationSpace;

    friend class TDEHardwareDevices;
};

#endif // _TDEROOTSYSTEMDEVICE_H