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

Changeset View

Standalone View

View Options

plugins/qml/kwinqml/kwinqml.h

  • This file was added.
1​#include <QtQuick/QQuickItem>
bshahUnsubmitted
Done

You are missing include guard in this header file.

bshah: You are missing include guard in this header file.
2​#include <QObject>
3​
4​namespace KWayland
5​{
6​namespace Server
7​{
8​class Display;
9​class SeatInterface;
10​class ShellInterface;
11​}
12​}
13​
14​class KWinQml : public QQuickItem
15​{
16​ Q_OBJECT
17​ Q_PROPERTY(QString socketName READ socketName WRITE setSocketName NOTIFY socketNameChanged)
18​
19​public:
20​ KWinQml();
21​ ~KWinQml() override;
22​
23​ void setSocketName(const QString socketName)
24​ {
25​ m_socketName = socketName;
26​ emit socketNameChanged(socketName);
27​ }
28​
29​ QString socketName() const
30​ {
31​ return m_socketName;
32​ }
33​
34​ Q_INVOKABLE void start();
35​
36​signals:
37​ void socketNameChanged(QString);
38​
graesslinUnsubmitted
Done

please add documentation

graesslin: please add documentation
39​private:
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​ QString m_socketName;
41​ KWayland::Server::Display *m_display = nullptr;
graesslinUnsubmitted
Done

QQuickItem *parent = nullptr

graesslin: QQuickItem *parent = nullptr
42​ KWayland::Server::SeatInterface *m_seat = nullptr;
43​ KWayland::Server::ShellInterface *m_shell = nullptr;
44​
45​};
46​
graesslinUnsubmitted
Done

const QStrig &socketName

graesslin: const QStrig &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.
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…