kwin/colorcorrection/colorcorrectdbusinterface.h

127 lines
3.6 KiB
C++

/********************************************************************
KWin - the KDE window manager
This file is part of the KDE project.
Copyright 2017 Roman Gilg <subdiff@gmail.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#ifndef KWIN_NIGHTCOLOR_DBUS_INTERFACE_H
#define KWIN_NIGHTCOLOR_DBUS_INTERFACE_H
#include <QObject>
#include <QtDBus/QtDBus>
namespace KWin
{
namespace ColorCorrect
{
class Manager;
class ColorCorrectDBusInterface : public QObject
{
Q_OBJECT
Q_CLASSINFO("D-Bus Interface", "org.kde.kwin.ColorCorrect")
public:
explicit ColorCorrectDBusInterface(Manager *parent);
virtual ~ColorCorrectDBusInterface() = default;
public Q_SLOTS:
/**
* @brief Gives information about the current state of Night Color.
*
* The returned variant hash has always the fields:
* - ActiveEnabled
* - Active
* - Mode
* - NightTemperatureEnabled
* - NightTemperature
* - Running
* - CurrentColorTemperature
* - LatitudeAuto
* - LongitudeAuto
* - LocationEnabled
* - LatitudeFixed
* - LongitudeFixed
* - TimingsEnabled
* - MorningBeginFixed
* - EveningBeginFixed
* - TransitionTime
*
* @return QHash<QString, QVariant>
* @see nightColorConfigChange
* @see signalNightColorConfigChange
* @since 5.12
**/
QHash<QString, QVariant> nightColorInfo();
/**
* @brief Allows changing the Night Color configuration.
*
* The provided variant hash can have the following fields:
* - Active
* - Mode
* - NightTemperature
* - LatitudeAuto
* - LongitudeAuto
* - LatitudeFixed
* - LongitudeFixed
* - MorningBeginFixed
* - EveningBeginFixed
* - TransitionTime
*
* It returns true if the configuration change was succesful, otherwise false.
* A change request for the location or timings needs to provide all relevant fields at the same time
* to be succesful. Otherwise the whole change request will get ignored. A change request will be ignored
* as a whole as well, if one of the provided informations has been sent in a wrong format.
*
* @return bool
* @see nightColorInfo
* @see signalNightColorConfigChange
* @since 5.12
**/
bool setNightColorConfig(QHash<QString, QVariant> data);
/**
* @brief For receiving auto location updates, primarily through the KDE Daemon
* @return void
* @since 5.12
**/
void nightColorAutoLocationUpdate(double latitude, double longitude);
Q_SIGNALS:
/**
* @brief Emits that the Night Color configuration has been changed.
*
* The provided variant hash provides the same fields as @link nightColorInfo
*
* @return void
* @see nightColorInfo
* @see nightColorConfigChange
* @since 5.12
**/
void nightColorConfigChanged(QHash<QString, QVariant> data);
private:
Manager *m_manager;
};
}
}
#endif // KWIN_NIGHTCOLOR_DBUS_INTERFACE_H