aboutsummaryrefslogtreecommitdiffstats
path: root/imports/shared/utils/AppUIScreen.qml
blob: f31791e9e4edd81aa499057728d63d25440e2357 (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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/****************************************************************************
**
** Copyright (C) 2017 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Neptune IVI UI.
**
** $QT_BEGIN_LICENSE:GPL-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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) 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.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-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: GPL-3.0
**
****************************************************************************/

import QtQuick 2.6

import QtApplicationManager 1.0
import controls 1.0
import utils 1.0

/*!
    \qmltype AppUIScreen
    \inqmlmodule utils
    \inherits ApplicationManagerWindow
    \brief A base QML item for developing applications.

    AppUIScreen is a QML item which should be a root element in every
    Neptune UI application. It provides APIs for interacting with a system UI and
    for positioning the application's visual elements.

    See \l{Neptune UI Application Development} for best practices on how to use the APIs.

    \section2 Example Usage

    The following example uses \l{AppUIScreen} as a root element:

    \qml

    AppUIScreen {
        id: root
        title: "Neptune Template"

        UIScreen {
            Content {
                anchors.centerIn: parent
                width: Style.hspan(13)
                height: Style.vspan(24)
            }

            onBackScreen: root.back()
        }
    }
    \endqml

*/

ApplicationManagerWindow {
    id: pelagicoreWindow
    width: Style.hspan(24)
    height: Style.vspan(24)

    /*!
         \qmlproperty Item AppUIScreen::content

         A default property that specifies a content area for the application's visual content.
    */

    default property alias content: content.children

    /*!
         \qmlproperty Item AppUIScreen::cluster

         If a cluster is available, this property assigns visual content for the cluster window.
    */

    property alias cluster: clusterContainer.children

    /*!
         \qmlsignal AppUIScreen::clusterKeyPressed(int key)

         This signal is emitted every time a key is pressed in a cluster.

    */

    signal clusterKeyPressed(int key)

    /*!
         \qmlsignal AppUIScreen::raiseApp()

         This signal is emitted every time an application is started.

    */

    signal raiseApp()

    /*!
         \qmlsignal AppUIScreen::closeApp()

         This signal is emitted every time an application is closed by clicking
         the back button.

    */

    signal closeApp()

    /*!
        \qmlmethod AppUIScreen::back()

        This method is called when an application needs to exit. It ensures the
        system UI screen visibility when a back button is clicked.

        \qml
        AppUIScreen {
            id: root
            title: "Neptune Template"

            UIScreen {
                Content {
                    anchors.centerIn: parent
                    width: Style.hspan(13)
                    height: Style.vspan(24)
                }

                onBackScreen: root.back()
            }
        }
        \endqml

    */


    function back() {
        pelagicoreWindow.setWindowProperty("visibility", false)
        closeApp();
    }

    onWindowPropertyChanged: {
        if (name === "visibility" && value === true) {
            pelagicoreWindow.raiseApp()
        }
    }

    BackgroundPane {
        anchors.fill: parent
    }

    ApplicationManagerWindow {
        id: clusterSurface
        width: typeof parent !== 'undefined' ? parent.width : Style.hspan(24)
        height: typeof parent !== 'undefined' ? parent.height : Style.vspan(24)
        visible: clusterContainer.children.length > 0 && Style.withCluster
        color: "transparent"

        Item {
            id: clusterContainer
            anchors.fill: parent
        }

        Component.onCompleted: {
            clusterSurface.setWindowProperty("windowType", "clusterWidget")
        }

        onWindowPropertyChanged: {
            //print(":::AppUIScreen::: window property changed", name, value, Qt.Key_Up)
            pelagicoreWindow.clusterKeyPressed(value)
        }
    }

    Item {
        id: content
        anchors.fill: parent
    }
}