Differential D9599 Diff 24565 src/client/server_decoration_palette.h

Changeset View

Standalone View

View Options

src/client/server_decoration_palette.h

  • This file was added.
1​/****************************************************************************
2​Copyright 2017 David Edmundson <kde@davidedmundson.co.uk>
3​
4​This library is free software; you can redistribute it and/or
5​modify it under the terms of the GNU Lesser General Public
6​License as published by the Free Software Foundation; either
7​version 2.1 of the License, or (at your option) version 3, or any
8​later version accepted by the membership of KDE e.V. (or its
9​successor approved by the membership of KDE e.V.), which shall
10​act as a proxy defined in Section 6 of version 3 of the license.
11​
12​This library is distributed in the hope that it will be useful,
13​but WITHOUT ANY WARRANTY; without even the implied warranty of
14​MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15​Lesser General Public License for more details.
16​
17​You should have received a copy of the GNU Lesser General Public
18​License along with this library. If not, see <http://www.gnu.org/licenses/>.
19​****************************************************************************/
20​#ifndef KWAYLAND_CLIENT_SERVER_DECORATION_PALETTE_H
21​#define KWAYLAND_CLIENT_SERVER_DECORATION_PALETTE_H
22​
23​#include <QObject>
24​
25​#include <KWayland/Client/kwaylandclient_export.h>
26​
27​struct org_kde_kwin_server_decoration_palette_manager;
28​struct org_kde_kwin_server_decoration_palette;
29​
30​namespace KWayland
31​{
32​namespace Client
33​{
34​
35​class EventQueue;
36​class Surface;
37​class ServerDecorationPalette;
38​
39​/**
40​ * @short Wrapper for the org_kde_kwin_server_decoration_palette_manager interface.
41​ *
42​ * This class provides a convenient wrapper for the org_kde_kwin_server_decoration_palette_manager interface.
43​ *
44​ * To use this class one needs to interact with the Registry. There are two
45​ * possible ways to create the ServerDecorationPaletteManager interface:
46​ * @code
47​ * ServerDecorationPaletteManager *c = registry->createServerDecorationPaletteManager(name, version);
48​ * @endcode
49​ *
50​ * This creates the ServerDecorationPaletteManager and sets it up directly. As an alternative this
51​ * can also be done in a more low level way:
52​ * @code
53​ * ServerDecorationPaletteManager *c = new ServerDecorationPaletteManager;
54​ * c->setup(registry->bindServerDecorationPaletteManager(name, version));
55​ * @endcode
56​ *
57​ * The ServerDecorationPaletteManager can be used as a drop-in replacement for any org_kde_kwin_server_decoration_palette_manager
58​ * pointer as it provides matching cast operators.
59​ *
60​ * @see Registry
61​ **/
62​class KWAYLANDCLIENT_EXPORT ServerSideDecorationPaletteManager : public QObject
63​{
64​ Q_OBJECT
65​public:
66​ /**
67​ * Creates a new ServerDecorationPaletteManager.
68​ * Note: after constructing the ServerDecorationPaletteManager it is not yet valid and one needs
69​ * to call setup. In order to get a ready to use ServerDecorationPaletteManager prefer using
70​ * Registry::createServerDecorationPaletteManager.
71​ **/
72​ explicit ServerSideDecorationPaletteManager(QObject *parent = nullptr);
73​ virtual ~ServerSideDecorationPaletteManager();
74​
75​ /**
76​ * Setup this ServerDecorationPaletteManager to manage the @p serverDecorationPaletteManager.
77​ * When using Registry::createServerDecorationPaletteManager there is no need to call this
78​ * method.
79​ **/
80​ void setup(org_kde_kwin_server_decoration_palette_manager *serverDecorationPaletteManager);
81​ /**
82​ * @returns @c true if managing a org_kde_kwin_server_decoration_palette_manager.
83​ **/
84​ bool isValid() const;
85​ /**
86​ * Releases the org_kde_kwin_server_decoration_palette_manager interface.
87​ * After the interface has been released the ServerDecorationPaletteManager instance is no
88​ * longer valid and can be setup with another org_kde_kwin_server_decoration_palette_manager interface.
89​ **/
90​ void release();
91​ /**
92​ * Destroys the data held by this ServerDecorationPaletteManager.
93​ * This method is supposed to be used when the connection to the Wayland
94​ * server goes away. If the connection is not valid anymore, it's not
95​ * possible to call release anymore as that calls into the Wayland
96​ * connection and the call would fail. This method cleans up the data, so
97​ * that the instance can be deleted or set up to a new org_kde_kwin_server_decoration_palette_manager interface
98​ * once there is a new connection available.
99​ *
100​ * It is suggested to connect this method to ConnectionThread::connectionDied:
101​ * @code
102​ * connect(connection, &ConnectionThread::connectionDied, palettemanager, &ServerDecorationPaletteManager::destroy);
103​ * @endcode
104​ *
105​ * @see release
106​ **/
107​ void destroy();
108​
109​ /**
110​ * Sets the @p queue to use for creating objects with this ServerDecorationPaletteManager.
111​ **/
112​ void setEventQueue(EventQueue *queue);
113​ /**
114​ * @returns The event queue to use for creating objects with this ServerDecorationPaletteManager.
115​ **/
116​ EventQueue *eventQueue();
117​
118​ ServerDecorationPalette *create(Surface *surface, QObject *parent = nullptr);
119​
120​ operator org_kde_kwin_server_decoration_palette_manager*();
121​ operator org_kde_kwin_server_decoration_palette_manager*() const;
122​
123​Q_SIGNALS:
124​ /**
125​ * The corresponding global for this interface on the Registry got removed.
126​ *
127​ * This signal gets only emitted if the ServerDecorationPaletteManager got created by
128​ * Registry::createServerDecorationPaletteManager
129​ **/
130​ void removed();
131​
132​private:
133​ class Private;
134​ QScopedPointer<Private> d;
135​};
136​
137​class KWAYLANDCLIENT_EXPORT ServerDecorationPalette : public QObject
138​{
139​ Q_OBJECT
140​public:
141​ virtual ~ServerDecorationPalette();
142​
143​ /**
144​ * Setup this ServerDecorationPalette to manage the @p serversidedecorationpalette.
145​ * When using ServerDecorationPaletteManager::create there is no need to call this
146​ * method.
147​ **/
148​ void setup(org_kde_kwin_server_decoration_palette *serversidedecorationpalette);
149​ /**
150​ * @returns @c true if managing a org_kde_kwin_server_decoration_palette.
151​ **/
152​ bool isValid() const;
153​ /**
154​ * Releases the org_kde_kwin_server_decoration_palette interface.
155​ * After the interface has been released the ServerDecorationPalette instance is no
156​ * longer valid and can be setup with another org_kde_kwin_server_decoration_palette interface.
157​ **/
158​ void release();
159​ /**
160​ * Destroys the data held by this ServerDecorationPalette.
161​ * This method is supposed to be used when the connection to the Wayland
162​ * server goes away. If the connection is not valid anymore, it's not
163​ * possible to call release anymore as that calls into the Wayland
164​ * connection and the call would fail. This method cleans up the data, so
165​ * that the instance can be deleted or set up to a new org_kde_kwin_server_decoration_palette interface
166​ * once there is a new connection available.
167​ *
168​ * It is suggested to connect this method to ConnectionThread::connectionDied:
169​ * @code
170​ * connect(connection, &ConnectionThread::connectionDied, appmenu, &ServerDecorationPalette::destroy);
171​ * @endcode
172​ *
173​ * @see release
174​ **/
175​ void destroy();
176​
177​ /**
178​ * Sets the appmenu address. The DBus object should be registered before making this call
179​ * Strings should be valid DBus formatted names, in latin1.
180​ */
181​ void setPalette(const QString &palette);
182​
183​ operator org_kde_kwin_server_decoration_palette*();
184​ operator org_kde_kwin_server_decoration_palette*() const;
185​
186​private:
187​ friend class ServerSideDecorationPaletteManager;
188​ explicit ServerDecorationPalette(QObject *parent = nullptr);
189​ class Private;
190​ QScopedPointer<Private> d;
191​};
192​
193​
194​}
195​}
196​
197​#endif