Differential D1989 Diff 5302 plugins/qml/kwinqml/kwinqml.h

Changeset View

Standalone View

plugins/qml/kwinqml/kwinqml.h

This file was added.

1		/********************************************************************
2		Copyright (C) 2016 Bhavisha Dhruve <bhavishadhruve@gmail.com>
	bshahUnsubmitted Done You are missing include guard in this header file. bshah: You are missing include guard in this header file.
3
4		This program is free software; you can redistribute it and/or modify
5		it under the terms of the GNU General Public License as published by
6		the Free Software Foundation; either version 2 of the License, or
7		(at your option) any later version.
8
9		This program is distributed in the hope that it will be useful,
10		but WITHOUT ANY WARRANTY; without even the implied warranty of
11		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12		GNU General Public License for more details.
13
14		You should have received a copy of the GNU General Public License
15		along with this program. If not, see <http://www.gnu.org/licenses/>.
16		*********************************************************************/
17
18		#ifndef KWINQML_H
19		#define KWINQML_H
20
21		#include <QtQuick/QQuickItem>
22		#include <QObject>
23		#include <QProcess>
24
25		namespace KWayland
26		{
27		namespace Server
28		{
29		class Display;
30		class SeatInterface;
31		class ShellInterface;
32		class SurfaceInterface;
33		}
34		}
35
36		class KWinQml : public QQuickItem
37		{
38		Q_OBJECT
	graesslinUnsubmitted Done please add documentation graesslin: please add documentation
39		/**
	graesslinUnsubmitted Done that's a comment and no doxygen documentation. For documentation you need to use /** * Socket name to pass to Wayland Server Display / graesslin: that's a comment and no doxygen documentation. For documentation you need to use ``` / *…
40		* socketName to pass to Wayland Server Display.
41		**/
	graesslinUnsubmitted Done QQuickItem parent = nullptr graesslin:* QQuickItem *parent = nullptr
42		Q_PROPERTY(QString socketName READ socketName WRITE setSocketName NOTIFY socketNameChanged)
43
44		public:
45		KWinQml(QQuickItem *parent = nullptr);
46		~KWinQml() override;
	graesslinUnsubmitted Done const QStrig &socketName graesslin: const QStrig &socketName
47
48		void setSocketName(const QString &socketName)
49		{
50		if (m_socketName != socketName) {
	graesslinUnsubmitted Done this also emits the changed if it does not change at all. graesslin: this also emits the changed if it does not change at all.
51		m_socketName = socketName;
52		emit socketNameChanged(socketName);
53		}
54		}
55
56		QString socketName() const
57		{
58		return m_socketName;
59		}
60
61		Q_INVOKABLE void start();
62		Q_INVOKABLE void stop();
63		QSGNode updatePaintNode(QSGNode node, UpdatePaintNodeData *);
	graesslinUnsubmitted Done I still do not really see the point in those two methods. The start could be handled by implementing the componentComplete method. The stop by calling that from the destructor. graesslin: I still do not really see the point in those two methods. The start could be handled by…
64
65		signals:
66		void socketNameChanged(QString);
67
68		private:
69		QString m_socketName;
70		KWayland::Server::Display *m_display = nullptr;
71		KWayland::Server::SeatInterface *m_seat = nullptr;
72		KWayland::Server::ShellInterface *m_shell = nullptr;
73		KWayland::Server::SurfaceInterface *m_surface = nullptr;
74		QProcess *m_kwinWaylandProcess;
75
76		};
77
78		#endif //KWINQML_H
79