summaryrefslogtreecommitdiffstats
path: root/src/charts/doc/src/index.qdoc
blob: d4f6825ad8881b4706b56b0d7bcac099a2f177a4 (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
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt 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$
**
****************************************************************************/

/*!
    \title Qt Charts
    \page qtcharts-index.html

    The Qt Charts module provides a set of easy-to-use chart components. It uses
    the Qt Graphics View Framework to integrate charts with modern user
    interfaces. Qt Charts can be used as QWidgets, QGraphicsWidget, or QML
    types. Users can easily create impressive charts by selecting one of the
    themes.

    \section1 Getting Started

    To import Qt Charts QML types, add the following import statement to your \c .qml file:

    \qml \QtMinorVersion
    import QtCharts 2.\1
    \endqml

    If you intend to use Qt Charts C++ classes in your application, use the
    following include and using directives:

    \snippet doc_src_qtcharts.cpp 0

    \if !defined(qtforpython)
    \note Projects created with Qt Creator's Qt Quick Application
    wizard are based on the Qt Quick 2 template that uses QGuiApplication by default.
    All such QGuiApplication instances in the project must be replaced with
    QApplication as the module depends on Qt's \l{Graphics View Framework}
    for rendering.

    To link against the Qt Charts module, add this line to your \c qmake project file:

    \snippet doc_src_qtcharts.pro 0
    \endif

    \section1 Module Evolution
    \l{Changes to Qt Charts} lists important changes in the module API
    and functionality that were done for the Qt 6 series of Qt.

    \section1 Licenses

    Qt Charts is available under commercial licenses from \l{The Qt Company}.
    In addition, it is available under the \l{GNU General Public License, version 3}.
    See \l{Qt Licensing} for further details.

    \section1 Articles and Guides
    \list
        \li \l{Qt Charts Overview}
    \endlist

    \section1 Examples
    \list
        \li \l{Qt Charts Examples}
    \endlist

    \section1 API Reference
    \list
        \li \l{Qt Charts C++ Classes}{C++ Classes}
        \li \l{Qt Charts QML Types}{QML Types}
    \endlist
*/