Differential D27338 Diff 78417 src/server/inputmethod_interface.h

Changeset View

Standalone View

src/server/inputmethod_interface.h

This file was added.

1		/*
2		SPDX-FileCopyrightText: 2020 Aleix Pol Gonzalez <aleixpol@kde.org>
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_INPUTMETHOD_INTERFACE_H
8		#define WAYLAND_SERVER_INPUTMETHOD_INTERFACE_H
9
10		#include <KWayland/Server/kwaylandserver_export.h>
11		#include <QVector>
12
13		#include "resource.h"
	zzagUnsubmitted Done Do we actually need it? zzag: Do we actually need it?
14
15		namespace KWayland
16		{
17		namespace Server
18		{
19		class OutputInterface;
20		class SurfaceInterface;
21		class Display;
22		class InputPanelSurfaceInterface;
23		class InputMethodContextInterface;
24
25		/**
26		* Implements the input-method-unstable-v1.xml protocol
27		*
28		* @since 5.68
29		*/
30		class KWAYLANDSERVER_EXPORT InputMethodInterface : public QObject
31		{
32		Q_OBJECT
33		public:
34		InputMethodInterface(Display d, QObject parent);
35		virtual ~InputMethodInterface();
36
37		/**
38		* Activates the input method.
39		*/
40		void sendActivate();
41
42		/**
43		* Deactivates the input method, probably because we're not on some area
44		* where we can write text.
45		*/
46		void sendDeactivate();
47
48		InputMethodContextInterface *context() const;
49
50		private:
51		class Private;
52		QScopedPointer<Private> d;
53		};
54
55		/**
56		* Offers information about the input context and allows us to interact with it.
57		*
58		* @since 5.68
59		*/
60		class KWAYLANDSERVER_EXPORT InputMethodContextInterface : public QObject
61		{
62		Q_OBJECT
63		public:
64		virtual ~InputMethodContextInterface();
65
66		void sendSurroundingText(const QString &text, quint32 cursor, quint32 anchor);
67		void sendReset();
68		void sendContentType(quint32 hint, quint32 purpose);
69		void sendInvokeAction(quint32 button, quint32 index);
70		void sendCommitState(quint32 serial);
71		void sendPreferredLanguage(const QString &language);
72
73		Q_SIGNALS:
74		void commitString(quint32 serial, const QString &text);
75		void preeditString(quint32 serial, const QString &text, const QString &commit);
76		void preeditStyling(quint32 index, quint32 length, quint32 style);
77		void preeditCursor(qint32 index);
78		void deleteSurroundingText(qint32 index, quint32 length);
79		void cursorPosition(qint32 index, qint32 anchor);
80		void keysym(quint32 serial, quint32 time, quint32 sym, bool pressed, Qt::KeyboardModifiers modifiers);
81		void grabKeyboard(quint32 keyboard);
82		void key(quint32 serial, quint32 time, quint32 key, bool pressed);
83		void modifiers(quint32 serial, Qt::KeyboardModifiers mods_depressed, Qt::KeyboardModifiers mods_latched, Qt::KeyboardModifiers mods_locked, quint32 group);
84		void language(quint32 serial, const QString &language);
85		void textDirection(quint32 serial, Qt::LayoutDirection direction);
86
87		private:
88		friend class InputMethodInterface;
89		InputMethodContextInterface(InputMethodInterface *parent);
90		class Private;
91		QScopedPointer<Private> d;
92		};
93
94		class KWAYLANDSERVER_EXPORT InputPanelInterface : public QObject
95		{
96		Q_OBJECT
97		public:
98		InputPanelInterface(Display d, QObject parent);
99		virtual ~InputPanelInterface();
100
101		Q_SIGNALS:
102		void inputPanelSurfaceAdded(quint32 id, InputPanelSurfaceInterface *surface);
	zzagUnsubmitted Done API design nitpick: it would be nice to have a signal with only parameter - InputPanelSurfaceInterface surface. Is there a reason why InputPanelSurfaceInterface can't have an id getter? zzag:* API design nitpick: it would be nice to have a signal with only parameter…
103
104		private:
105		class Private;
106		QScopedPointer<Private> d;
107		};
108
109		/**
110		* Representation of the panel's surface to tell the compositor where and how to show
111		*
112		* @since 5.68
113		*/
114		class KWAYLANDSERVER_EXPORT InputPanelSurfaceInterface : public QObject
115		{
116		Q_OBJECT
117		public:
118		virtual ~InputPanelSurfaceInterface();
119
120		enum Position {
121		CenterBottom = 0
122		};
123		Q_ENUM(Position)
	Lint: unknownMacro There is an unknown macro here somewhere. Configuration is required. If Q_ENUM is a macro then please configure it. Lint: unknownMacro: There is an unknown macro here somewhere. Configuration is required. If Q_ENUM is a macro then…
	Lint: unknownMacro There is an unknown macro here somewhere. Configuration is required. If Q_ENUM is a macro then please configure it. Lint: unknownMacro: There is an unknown macro here somewhere. Configuration is required. If Q_ENUM is a macro then…
124
125		SurfaceInterface *surface() const;
126
127		Q_SIGNALS:
128		void topLevel(OutputInterface *output, Position position);
129		void overlayPanel();
130
131		private:
132		InputPanelSurfaceInterface(QObject *parent);
133		friend class InputPanelInterface;
134		class Private;
135		QScopedPointer<Private> d;
136		};
137
138		}
139		}
140
141		Q_DECLARE_METATYPE(KWayland::Server::InputMethodInterface *)
142
143		#endif