Differential D1989 Diff 5713 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		#include <QScopedPointer>
25		#include <QSGSimpleTextureNode>
26
27		class QElapsedTimer;
28
29		namespace KWayland
30		{
31		namespace Server
32		{
33		class Display;
34		class SeatInterface;
35		class ShellInterface;
36		class SurfaceInterface;
37		}
38		}
	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		class KWinQml : public QQuickItem
41		{
	graesslinUnsubmitted Done QQuickItem parent = nullptr graesslin:* QQuickItem *parent = nullptr
42		Q_OBJECT
43		/**
44		* socketName to pass to Wayland Server Display.
45		**/
46		Q_PROPERTY(QString socketName READ socketName WRITE setSocketName NOTIFY socketNameChanged)
	graesslinUnsubmitted Done const QStrig &socketName graesslin: const QStrig &socketName
47
48		public:
49		KWinQml(QQuickItem *parent = nullptr);
50		~KWinQml() override;
	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
52		void setSocketName(const QString &socketName)
53		{
54		if (m_socketName != socketName) {
55		m_socketName = socketName;
56		emit socketNameChanged(socketName);
57		}
58		}
59
60		QString socketName() const
61		{
62		return m_socketName;
63		}
	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		Q_INVOKABLE void start();
66		Q_INVOKABLE void stop();
67		QSGNode updatePaintNode(QSGNode node, UpdatePaintNodeData *);
68		void mousePressEvent(QMouseEvent *event);
69		void mouseReleaseEvent(QMouseEvent *event);
70		void keyPressEvent(QKeyEvent *event);
71		void keyReleaseEvent(QKeyEvent *event);
72		void hoverMoveEvent(QHoverEvent *event);
73
74		signals:
75		void socketNameChanged(QString);
76
77		private:
78		QString m_socketName;
79		KWayland::Server::Display *m_display = nullptr;
80		KWayland::Server::SeatInterface *m_seat = nullptr;
81		KWayland::Server::ShellInterface *m_shell = nullptr;
82		KWayland::Server::SurfaceInterface *m_surface = nullptr;
83		QProcess *m_kwinWaylandProcess;
84		QScopedPointer<QElapsedTimer> m_timeSinceStart;
85		QSGTexture *m_texture = nullptr;
86
87		};
88
89		#endif //KWINQML_H
90