powermanagement.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_POWERMANAGEMENT_H
#define SOLID_POWERMANAGEMENT_H

#include <QtCore/QObject>
#include <QtCore/QSet>

#include <solid/solid_export.h>

namespace Solid
{
    namespace PowerManagement
    {
        enum SleepState { StandbyState = 1, SuspendState = 2, HibernateState = 4 };

        SOLID_EXPORT bool appShouldConserveResources();


        SOLID_EXPORT QSet<SleepState> supportedSleepStates();

        SOLID_EXPORT void requestSleep(SleepState state, QObject *receiver, const char *member);

        SOLID_EXPORT int beginSuppressingSleep(const QString &reason = QString());

        SOLID_EXPORT bool stopSuppressingSleep(int cookie);

        SOLID_EXPORT int beginSuppressingScreenPowerManagement(const QString &reason = QString());

        SOLID_EXPORT bool stopSuppressingScreenPowerManagement(int cookie);

        class SOLID_EXPORT Notifier : public QObject
        {
            Q_OBJECT
        Q_SIGNALS:
            void appShouldConserveResourcesChanged(bool newState);

            void resumingFromSuspend();

        protected:
            Notifier();
        };

        SOLID_EXPORT Notifier *notifier();
    }
}

#endif