Differential D29231 Diff 81491 src/server/keyboard_shortcuts_inhibit_interface.h

Changeset View

Standalone View

src/server/keyboard_shortcuts_inhibit_interface.h

This file was added.

1		/*
2		SPDX-FileCopyrightText: 2020 Benjamin Port <benjamin.port@enioka.com>
3
4		SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
5		*/
6
7		#ifndef WAYLAND_SERVER_KEYBOARD_SHORTCUTS_INHIBIT_INTERFACE_H
8		#define WAYLAND_SERVER_KEYBOARD_SHORTCUTS_INHIBIT_INTERFACE_H
9
10		#include <KWayland/Server/kwaylandserver_export.h>
11		#include <QObject>
12		#include "seat_interface.h"
13
14		namespace KWayland
15		{
16		namespace Server
17		{
18		/**
19		* This is an implementation of wayland-protocols/unstable/keyboard-shortcuts-inhibit/keyboard-shortcuts-inhibit-unstable-v1.xml
20		*
21		* This class is just the means to get a @class KeyboardShortcutsInhibitorInterface, which is
22		* the class that will have all of the information we need.
23		*
24		* @since 5.71
25		*/
26
27		class KeyboardShortcutsInhibitManagerInterface;
28
29		class KWAYLANDSERVER_EXPORT KeyboardShortcutsInhibitorInterface : public QObject
30		{
31		Q_OBJECT
32
33		public:
	zzagUnsubmitted Not Done Indentation. Also, it's probably a minor thing, but it's really nice when Q_OBJECT is separated from code below by a single empty line (cosmetics). zzag: Indentation. Also, it's probably a minor thing, but it's really nice when Q_OBJECT is separated…
34		~KeyboardShortcutsInhibitorInterface() override;
35
36		SurfaceInterface *surface() const;
37		SeatInterface *seat() const;
38		void setActive(bool active);
39		bool isActive() const;
40		private:
	crossiUnsubmitted Not Done Should be const crossi: Should be const
41		friend class KeyboardShortcutsInhibitManagerInterface;
42		explicit KeyboardShortcutsInhibitorInterface(wl_resource resource, int id, SurfaceInterface surface, SeatInterface seat, KeyboardShortcutsInhibitManagerInterface manager);
43		class Private;
44		QScopedPointer<Private> d;
45		};
46
47
48		class KWAYLANDSERVER_EXPORT KeyboardShortcutsInhibitManagerInterface : public QObject
49		{
50		Q_OBJECT
51
52		public:
53		~KeyboardShortcutsInhibitManagerInterface() override;
54
55		/**
56		* return shortucts inhibitor associated with surface and seat, if no shortcut are associated, return nullptr
57		* @param surface
58		* @param seat
59		* @return
60		*/
61		KeyboardShortcutsInhibitorInterface getShortcutsInhibitor(SurfaceInterface surface, SeatInterface *seat) const;
	zzagUnsubmitted Not Done We probably don't need it to be public. Only emit inhibitorCreated. zzag: We probably don't need it to be public. Only emit inhibitorCreated.
	zzagUnsubmitted Not Done We usually don't prefix getters with "get". What about shortcutsInhibitor() or findInhibitior()? zzag: We usually don't prefix getters with "get". What about shortcutsInhibitor() or findInhibitior()?
62
63		Q_SIGNALS:
64		void inhibitorCreated(KeyboardShortcutsInhibitorInterface *inhibitor);
65
66		private:
67		friend class Display;
68		friend class KeyboardShortcutsInhibitorInterface;
69		explicit KeyboardShortcutsInhibitManagerInterface(Display d, QObject parent);
	crossiUnsubmitted Not Done parent parameter should be defaulted to nullptr crossi: parent parameter should be defaulted to nullptr
70		void removeInhibitor(SurfaceInterface const surface, SeatInterface const seat);
71		class Private;
72		QScopedPointer<Private> d;
73		};
74
75		}
76		}
77
78		#endif