summaryrefslogtreecommitdiffstats
path: root/doc/elements-systemui.qdoc
blob: 3e34182c749b7800cd2a04df51e7767fda4bc723 (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
/****************************************************************************
**
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Pelagicore Application Manager.
**
** $QT_BEGIN_LICENSE:FDL-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 Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!

\page qml-sysui.html
\title QtApplicationManager.SystemUI QML module
\brief Qt Application Manager module to be used in a System-UI

The QtApplicationManager.SystemUI QML module contains the components and types to be used in a System-UI.

Singleton QML types need not be declared, they are referenced by just their type name.

Instantiable QML types are declared with the their name followed by curly braces. These
declarations may be nested, creating parent-child relationships between the items.

Non-Instantiable QML types are return values provided to the System-UI code, that allow the user
direct access to data that would otherwise only be available (partially) through the singletons'
item models.

\section1 QML Singletons
\annotatedlist system-ui-singletons

\section1 Instantiable QML Types

These types are only available for the System-UI:

\annotatedlist system-ui

\section1 Non-Instantiable QML Types

All these types are only available from within the System-UI and cannot be instantiated from its QML code.

\annotatedlist system-ui-non-instantiable

*/