KWayland

idleinhibit_interface.h
1 /*
2  SPDX-FileCopyrightText: 2017 Martin Flöser <[email protected]>
3 
4  SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
5 */
6 #ifndef KWAYLAND_SERVER_IDLEINHIBIT_INTERFACE_H
7 #define KWAYLAND_SERVER_IDLEINHIBIT_INTERFACE_H
8 
9 #include "global.h"
10 #include "resource.h"
11 
12 #include <KWayland/Server/kwaylandserver_export.h>
13 
14 namespace KWayland
15 {
16 namespace Server
17 {
18 
19 /**
20  * Enum describing the interface versions the IdleInhibitManagerInterface can support.
21  *
22  * @since 5.41
23  **/
25  /**
26  * zwp_idle_inhibit_manager_v1
27  **/
28  UnstableV1,
29 };
30 
31 /**
32  * The IdleInhibitorManagerInterface is used by clients to inhibit idle on a
33  * SurfaceInterface. Whether a SurfaceInterface inhibits idle is exposes through
34  * @link{SurfaceInterface::inhibitsIdle}.
35  *
36  * @since 5.41
37  **/
38 class KWAYLANDSERVER_EXPORT IdleInhibitManagerInterface : public Global
39 {
40  Q_OBJECT
41 public:
42  virtual ~IdleInhibitManagerInterface();
43 
44  /**
45  * @returns The interface version used by this IdleInhibitManagerInterface
46  **/
47  IdleInhibitManagerInterfaceVersion interfaceVersion() const;
48 
49 protected:
50  class Private;
51  explicit IdleInhibitManagerInterface(Private *d, QObject *parent = nullptr);
52 
53 private:
54  Private *d_func() const;
55 };
56 
57 }
58 }
59 
60 #endif
The IdleInhibitorManagerInterface is used by clients to inhibit idle on a SurfaceInterface.
Base class for all Globals.
Definition: global.h:46
IdleInhibitManagerInterfaceVersion
Enum describing the interface versions the IdleInhibitManagerInterface can support.
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Thu Sep 23 2021 22:51:08 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.