summaryrefslogtreecommitdiffstats
path: root/src/window-lib/window.h
blob: a741d53e6a32fac2f21254f74466c1f8b7a308e9 (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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/****************************************************************************
**
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Pelagicore Application Manager.
**
** $QT_BEGIN_LICENSE:LGPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite licenses may use
** this file in accordance with the commercial license agreement provided
** with the Software or, alternatively, in accordance with the terms
** contained in a written agreement between you and The Qt Company.  For
** licensing terms and conditions see https://www.qt.io/terms-conditions.
** For further information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: LGPL-3.0
**
****************************************************************************/

#pragma once

#include <QObject>
#include <QVariantMap>
#include <QPointer>
#include <QQuickItem>
#include <QSet>
#include <QtAppManCommon/global.h>

QT_BEGIN_NAMESPACE_AM

class AbstractApplication;
class WindowItem;

// A Window object exists for every application window that is managed by the application-manager
// and has been shown (mapped) at least once.
// In the Wayland case, every Window is a surface, but not every surface is a Window. That's why
// there is a separate WindowSurface class in waylandcompositor.h.

class Window : public QObject
{
    Q_OBJECT

    Q_PROPERTY(QSize size READ size NOTIFY sizeChanged)
    Q_PROPERTY(ContentState contentState READ contentState NOTIFY contentStateChanged)
    Q_PROPERTY(AbstractApplication* application READ application CONSTANT)

public:

    enum ContentState {
        SurfaceWithContent,
        SurfaceNoContent,
        NoSurface
    };
    Q_ENUM(ContentState)

    Window(AbstractApplication *app);
    virtual ~Window();

    virtual bool isInProcess() const = 0;
    virtual AbstractApplication *application() const;

    // Controls how many items (which are views from a model-view perspective) are currently rendering this window
    void registerItem(WindowItem *item);
    void unregisterItem(WindowItem *item);
    const QSet<WindowItem*> &items() const { return m_items; }

    void setPrimaryItem(WindowItem *item);
    WindowItem *primaryItem() const { return m_primaryItem; }

    // Whether there's any view (WindowItem) holding a reference to this window
    bool isBeingDisplayed() const;

    virtual ContentState contentState() const = 0;

    Q_INVOKABLE virtual bool setWindowProperty(const QString &name, const QVariant &value) = 0;
    Q_INVOKABLE virtual QVariant windowProperty(const QString &name) const = 0;
    Q_INVOKABLE virtual QVariantMap windowProperties() const = 0;

    Q_INVOKABLE virtual void close() = 0;

    virtual QSize size() const = 0;
    Q_INVOKABLE virtual void resize(const QSize &size) = 0;

signals:
    void sizeChanged();
    void windowPropertyChanged(const QString &name, const QVariant &value);
    void isBeingDisplayedChanged();
    void contentStateChanged();

    // Emitted when this window is destroyed. This signal exists because QObject::destroyed
    // doesn't reach the QML/Javascript side. This exists just for testing purposes and
    // is not considered part of the public API (hence the '_' prefix).
    void _windowDestroyed();

protected:
    AbstractApplication *m_application;

    QSet<WindowItem*> m_items;
    WindowItem *m_primaryItem{nullptr};
};

QT_END_NAMESPACE_AM

Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE_AM(Window*))