aboutsummaryrefslogtreecommitdiffstats
path: root/imports_shared/application/windows/NeptuneWindow.qml
blob: ae3f39e0e9c35cb334c2709eb4e27a8dae1ad188 (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
/****************************************************************************
**
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Neptune 3 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.8
import QtApplicationManager.Application 2.0
import shared.utils 1.0
import shared.Style 1.0
import shared.Sizes 1.0

/*!
    \qmltype NeptuneWindow
    \inqmlmodule application.windows
    \inherits ApplicationManagerWindow
    \since 5.12
    \brief The basic type of Neptune Window for Neptune 3 applications.

    The Neptune Window provides the basic type of application window to be used by the application.

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

    \section2 Example Usage

    The following example uses \l{NeptuneWindow}:

    \qml
    import QtQuick 2.10
    import application.windows 1.0

    NeptuneWindow {
        id: root

        Rectangle {
            anchors.fill: parent
            color: "blue"
        }
    }

    \endqml

*/
ApplicationManagerWindow {
    id: root

    LayoutMirroring.enabled: Config.rtlMode
    LayoutMirroring.childrenInherit: true

    color: "transparent"

    /*!
        \qmlproperty bool NeptuneWindow::isRightToLeft
        This property holds whether the current locale uses the right-to-left
        text direction (RTL)
    */
    readonly property bool isRightToLeft: Config.rtlMode

    onWindowPropertyChanged: {
        switch (name) {
        case "neptuneScale":
            root.Sizes.scale = value;
            break;
        case "neptuneAccentColor":
            root.Style.accentColor = value;
            break;
        case "neptuneTheme":
            root.Style.theme = value;
            break;
        case "neptuneLanguageLocale":
            Config.languageLocale = value;
            break;
        case "neptuneRtlMode":
            Config.rtlMode = value;
            break;
        }
    }
}