aboutsummaryrefslogtreecommitdiffstats
path: root/src/doc/qtivi/src/reference-api.qdoc
blob: d1bab1d07c165ffbf88cedffa8396c49bf859e53 (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 QtIvi module of the Qt Toolkit.
**
** $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 reference-api.html
\title Using the Qt IVI Reference API

\section1 Overview

The Qt IVI module contains a reference API providing interfaces to common automotive
functionality. These APIs rely on the separation of the front-end API and the backend
implementation. The Qt IVI module also introduces a set of concepts used in the APIs:
zones and property attributes. More about the concepts can be read \l {Concepts} {here}.

\section1 Modules

Qt IVI consists of the following C++ modules:

\annotatedlist qtivi_modules

\b {Qt IVI Core} provides core base classes for the Qt IVI features,
and handles the discovery of Qt IVI backend plugins. Application
developers do not need to use Qt IVI Core directly. It is only needed
when implementing a new IVI feature, such as Qt IVI Vehicle Functions
ClimateControl.

\b {Qt IVI Vehicle Functions} provides interfaces to access vehicle
features.

\b {Qt IVI Media} provides interfaces to access media related APIs e.g.
Managing your music playlist or controlling the radio tuner.

The functionality provided by these modules is available to QML
applications:

\annotatedlist qtivi_qmlmodules
*/