File indexing completed on 2024-05-19 05:32:34

 /*
     SPDX-FileCopyrightText: 2015 Martin Gräßlin <mgraesslin@kde.org>
 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
 #pragma once
 
 #include "kwin_export.h"
 
 #include <QObject>
 
 #include <memory>
 
 namespace KWin
 {
 class Display;
 class DpmsManagerInterfacePrivate;
 
 /**
  * @brief Global for server side Display Power Management Signaling interface.
  *
  * A DpmsManagerInterface allows a client to query the DPMS state
  * on a given OutputInterface and request changes to it.
  * Server-side the interaction happens only via the OutputInterface,
  * for clients the Dpms class provides the API.
  * This global implements org_kde_kwin_dpms_manager.
  *
  * To create a DpmsManagerInterface use:
  * @code
  * auto manager = display->createDpmsManager();
  * manager->create();
  * @endcode
  *
  * To interact with Dpms use one needs to mark it as enabled and set the
  * proper mode on the OutputInterface.
  * @code
  * // We have our OutputInterface called output.
  * output->setDpmsSupported(true);
  * output->setDpmsMode(Output::DpmsMode::On);
  * @endcode
  *
  * To connect to Dpms change requests use:
  * @code
  * connect(output, &Output::DpmsModeRequested,
  *         [] (Output::DpmsMode requestedMode) { qDebug() << "Mode change requested"; });
  * @endcode
  *
  * @see Display
  * @see OutputInterface
  */
 class KWIN_EXPORT DpmsManagerInterface : public QObject
 {
     Q_OBJECT
 
 public:
     explicit DpmsManagerInterface(Display *display, QObject *parent = nullptr);
     ~DpmsManagerInterface() override;
 
 private:
     std::unique_ptr<DpmsManagerInterfacePrivate> d;
 };
 
 }