summaryrefslogtreecommitdiffstats
path: root/src/manager-lib/inprocesssurfaceitem.h
blob: 8b3ec4e52c1f728316c656156cc4a9de30170ef3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
// Copyright (C) 2021 The Qt Company Ltd.
// Copyright (C) 2019 Luxoft Sweden AB
// Copyright (C) 2018 Pelagicore AG
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only

#ifndef INPROCESSSURFACEITEM_H
#define INPROCESSSURFACEITEM_H

#if 0
#pragma qt_sync_skip_header_check
#endif

#include <QColor>
#include <QPointer>
#include <QtQuick/private/qquickfocusscope_p.h>
#include <QtAppManCommon/global.h>

QT_BEGIN_NAMESPACE_AM

class ApplicationManagerWindow;

/*
 *  Item exposed to the System UI
 */
class InProcessSurfaceItem : public QQuickFocusScope
{
    Q_OBJECT
public:
    InProcessSurfaceItem(QQuickItem *parent = nullptr);
    ~InProcessSurfaceItem() override;

    bool setWindowProperty(const QString &name, const QVariant &value);
    QVariant windowProperty(const QString &name) const;
    QObject &windowProperties() { return m_windowProperties; }
    QVariantMap windowPropertiesAsVariantMap() const;

    // Whether the surface is visible on the client (application) side.
    // The when application hides its surface, System UI should, in an animated way,
    // remove it from user's view.
    // That's why a client shouldn't have control over the actual visible property
    // of its surface item.
    void setVisibleClientSide(bool visible);
    bool visibleClientSide() const;

    // Since Qt 6.9, qtwayland now distinguished again between hidden and destroyed, so we need to
    // track this state separately. This is used by the WindowManager to determine if the window
    // should be removed from its list of windows.
    void setDeadClientSide();
    bool isDeadClientSide() const;

    QColor color() const;
    void setColor(const QColor &c);

    void close();
    void setClosed(bool closed);
    bool isClosed() const;

    bool focusOnClick() const;
    void setFocusOnClick(bool newFocusOnClick);
    Q_SIGNAL void focusOnClickChanged();

    ApplicationManagerWindow *applicationManagerWindow();
    void setApplicationManagerWindow(ApplicationManagerWindow *win);

Q_SIGNALS:
    void visibleClientSideChanged();
    void deadClientSideChanged();
    void closedChanged();
    void windowPropertyChanged(const QString &name, const QVariant &value);
    void closeRequested();

    // Emitted when WindowManager is no longer tracking this surface item
    // (ie, the Window that was tracking this surface item has been destroyed)
    void released();

protected:
    bool eventFilter(QObject *o, QEvent *e) override;
    void mousePressEvent(QMouseEvent *e) override;
    void touchEvent(QTouchEvent *e) override;
    bool childMouseEventFilter(QQuickItem *item, QEvent *e) override;
    QSGNode *updatePaintNode(QSGNode *, UpdatePaintNodeData *) override;

private:
    void delayedForceActiveFocus();

    QObject m_windowProperties;
    bool m_visibleClientSide = true;
    bool m_deadClientSide = false;
    bool m_closed = false;
    bool m_focusOnClick = false;
    QColor m_color;
    QPointer<ApplicationManagerWindow> m_amWindow;
};

QT_END_NAMESPACE_AM

Q_DECLARE_METATYPE(QtAM::InProcessSurfaceItem*)
Q_DECLARE_METATYPE(QSharedPointer<QtAM::InProcessSurfaceItem>)

#endif // INPROCESSSURFACEITEM_H