##// END OF EJS Templates
HG_REPOSITORIES » LPP » INSTRUMENTATION » USERS » JEANDET » qtcharts
RSS

Clone from http://code.qt.io/qt/qtcharts.git

Doc: Use a standard documentation config for a Qt module...
Topi Reinio -
r2862:b8bfb31b9099
parent child
Show More
Side by Side Unified
Context file:
r2862:b8bfb31b9099 Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,78 +1,78
1 ---------------
1 ---------------
2 Qt Charts 5.7.0
2 Qt Charts 5.7.0
3 ---------------
3 ---------------
4
4
5 Qt Charts module provides a set of easy to use chart components. It uses
5 Qt Charts module provides a set of easy to use chart components. It uses
6 the Qt Graphics View Framework, therefore charts can be easily integrated
6 the Qt Graphics View Framework, therefore charts can be easily integrated
7 to modern user interfaces.
7 to modern user interfaces.
8
8
9 System Requirements
9 System Requirements
10 ===================
10 ===================
11
11
12 - Qt 5.4 or newer
12 - Qt 5.4 or newer
13 - For QML applications QtQuick 2 is required
13 - For QML applications QtQuick 2 is required
14 - Manipulating Qt Charts graphs with QML Designer requires Qt Creator 3.3 or newer
14 - Manipulating Qt Charts graphs with QML Designer requires Qt Creator 3.3 or newer
15
15
16 Building
16 Building
17 ========
17 ========
18
18
19 Configure the project with qmake:
19 Configure the project with qmake:
20 qmake
20 qmake
21
21
22 After running qmake, build the project with make:
22 After running qmake, build the project with make:
23 (Linux) make
23 (Linux) make
24 (Windows with MinGw) mingw32-make
24 (Windows with MinGw) mingw32-make
25 (Windows with Visual Studio) nmake
25 (Windows with Visual Studio) nmake
26 (OS X) make
26 (OS X) make
27
27
28 The above generates the default makefiles for your configuration, which is typically
28 The above generates the default makefiles for your configuration, which is typically
29 the release build if you are using precompiled binary Qt distribution. To build both
29 the release build if you are using precompiled binary Qt distribution. To build both
30 debug and release, or one specifically, use one of the following qmake lines instead.
30 debug and release, or one specifically, use one of the following qmake lines instead.
31
31
32 For debug builds:
32 For debug builds:
33 qmake CONFIG+=debug
33 qmake CONFIG+=debug
34 make
34 make
35 or
35 or
36 qmake CONFIG+=debug_and_release
36 qmake CONFIG+=debug_and_release
37 make debug
37 make debug
38
38
39 For release builds:
39 For release builds:
40 qmake CONFIG+=release
40 qmake CONFIG+=release
41 make
41 make
42 or
42 or
43 qmake CONFIG+=debug_and_release
43 qmake CONFIG+=debug_and_release
44 make release
44 make release
45
45
46 For both builds (Windows/OS X only):
46 For both builds (Windows/OS X only):
47 qmake CONFIG+="debug_and_release build_all"
47 qmake CONFIG+="debug_and_release build_all"
48 make
48 make
49
49
50 After building, install the module to your Qt directory:
50 After building, install the module to your Qt directory:
51 make install
51 make install
52
52
53 If you want to uninstall the module:
53 If you want to uninstall the module:
54 make uninstall
54 make uninstall
55
55
56 Building as a statically linked library
56 Building as a statically linked library
57 =======================================
57 =======================================
58
58
59 The same as above applies, you will just have to add static to the CONFIG:
59 The same as above applies, you will just have to add static to the CONFIG:
60 qmake CONFIG+=static
60 qmake CONFIG+=static
61
61
62 Documentation
62 Documentation
63 =============
63 =============
64
64
65 The documentation can be generated with:
65 The documentation can be generated with:
66 make docs
66 make docs
67
67
68 The documentation is generated into the doc folder under the build folder.
68 The documentation is generated into the doc folder under the build folder.
69 Both Qt Assistant (qtcharts.qch) and in HTML format (qtcharts subfolder)
69 Both Qt Assistant (qtcharts.qch) and in HTML format (qtcharts subfolder)
70 documentation is generated.
70 documentation is generated.
71
71
72 Please refer to the generated documentation for more information:
72 Please refer to the generated documentation for more information:
73 doc/qtcharts/index.html
73 doc/qtcharts/qtcharts-index.html
74
74
75 Known issues
75 Known issues
76 ============
76 ============
77
77
78 - Zooming too far or too close may eventually freeze the zooming and scrolling.
78 - Zooming too far or too close may eventually freeze the zooming and scrolling.
Show file before | Show file after | Hide comments
@@ -1,72 +1,60
1 include($QT_INSTALL_DOCS/global/macros.qdocconf)
1 include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
2 include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf)
3 include($QT_INSTALL_DOCS/global/compat.qdocconf)
4 include($QT_INSTALL_DOCS/global/fileextensions.qdocconf)
5 include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)
6
2
7 project = QtCharts
3 project = QtCharts
8 description = Qt Charts Reference Documentation
4 description = Qt Charts Reference Documentation
9 version = $QT_VERSION
5 version = $QT_VERSION
10
6
11 sourcedirs += .. \
7 sourcedirs += .. \
12 ../../chartsqml2
8 ../../chartsqml2
13 headerdirs += .. \
9 headerdirs += .. \
14 ../../chartsqml2
10 ../../chartsqml2
15 exampledirs += ../../../examples/charts \
11 exampledirs += ../../../examples/charts \
16 snippets
12 snippets
17 imagedirs += images
13 imagedirs += images
18 examplesinstallpath = charts
14
15 examplesinstallpath = qtcharts/charts
19
16
20 sources.fileextensions = "*.cpp *.qdoc"
17 sources.fileextensions = "*.cpp *.qdoc"
21
18
22 indexes += $QT_INSTALL_DOCS/qtcore/qtcore.index \
19 depends = qtcore qtgui qtwidgets qtqml qtquick qtmultimedia qtdoc
23 $QT_INSTALL_DOCS/qtgui/qtgui.index \
24 $QT_INSTALL_DOCS/qtqml/qtqml.index \
25 $QT_INSTALL_DOCS/qtquick/qtquick.index \
26 $QT_INSTALL_DOCS/qtmultimedia/qtmultimedia.index
27
20
28 Cpp.ignoretokens = Q_INVOKABLE \
21 Cpp.ignoretokens += QT_CHARTS_EXPORT \
29 QT_CHARTS_EXPORT \
30 QT_CHARTS_END_NAMESPACE \
22 QT_CHARTS_END_NAMESPACE \
31 QT_CHARTS_BEGIN_NAMESPACE
23 QT_CHARTS_BEGIN_NAMESPACE
32
24
33 qhp.projects = QtCharts
25 qhp.projects = QtCharts
34 qhp.QtCharts.file = qtcharts.qhp
26 qhp.QtCharts.file = qtcharts.qhp
35 qhp.QtCharts.namespace = com.digia.qtcharts.$QT_VERSION_TAG
27 qhp.QtCharts.namespace = org.qt-project.qtcharts.$QT_VERSION_TAG
36 qhp.QtCharts.virtualFolder = qtcharts
28 qhp.QtCharts.virtualFolder = qtcharts
37 qhp.QtCharts.indexTitle = Qt Charts
29 qhp.QtCharts.indexTitle = Qt Charts
38 qhp.QtCharts.indexRoot =
30 qhp.QtCharts.indexRoot =
39
31
40 qhp.QtCharts.filterAttributes = qtcharts $QT_VERSION qtrefdoc
32 qhp.QtCharts.filterAttributes = qtcharts $QT_VERSION qtrefdoc
41 qhp.QtCharts.customFilters.Qt.name = QtCharts $QT_VERSION
33 qhp.QtCharts.customFilters.Qt.name = QtCharts $QT_VERSION
42 qhp.QtCharts.customFilters.Qt.filterAttributes = qtcharts $QT_VERSION
34 qhp.QtCharts.customFilters.Qt.filterAttributes = qtcharts $QT_VERSION
43
35
44 qhp.QtCharts.subprojects = gettingstarted classes types examples
36 qhp.QtCharts.subprojects = gettingstarted classes types examples
45
37
46 qhp.QtCharts.subprojects.gettingstarted.title = Getting Started
38 qhp.QtCharts.subprojects.gettingstarted.title = Getting Started
47 qhp.QtCharts.subprojects.gettingstarted.indexTitle = Qt Charts Getting Started
39 qhp.QtCharts.subprojects.gettingstarted.indexTitle = Qt Charts Getting Started
48 qhp.QtCharts.subprojects.gettingstarted.selectors = fake:page
40 qhp.QtCharts.subprojects.gettingstarted.selectors = fake:page
49 qhp.QtCharts.subprojects.gettingstarted.sortPages = true
41 qhp.QtCharts.subprojects.gettingstarted.sortPages = true
50
42
51 qhp.QtCharts.subprojects.classes.title = C++ Classes
43 qhp.QtCharts.subprojects.classes.title = C++ Classes
52 qhp.QtCharts.subprojects.classes.indexTitle = Qt Charts C++ Classes
44 qhp.QtCharts.subprojects.classes.indexTitle = Qt Charts C++ Classes
53 qhp.QtCharts.subprojects.classes.selectors = class
45 qhp.QtCharts.subprojects.classes.selectors = class
54 qhp.QtCharts.subprojects.classes.sortPages = true
46 qhp.QtCharts.subprojects.classes.sortPages = true
55
47
56 qhp.QtCharts.subprojects.types.title = QML Types
48 qhp.QtCharts.subprojects.types.title = QML Types
57 qhp.QtCharts.subprojects.types.indexTitle = Qt Charts QML Types
49 qhp.QtCharts.subprojects.types.indexTitle = Qt Charts QML Types
58 qhp.QtCharts.subprojects.types.selectors = qmlclass
50 qhp.QtCharts.subprojects.types.selectors = qmlclass
59 qhp.QtCharts.subprojects.types.sortPages = true
51 qhp.QtCharts.subprojects.types.sortPages = true
60
52
61 qhp.QtCharts.subprojects.examples.title = Examples
53 qhp.QtCharts.subprojects.examples.title = Examples
62 qhp.QtCharts.subprojects.examples.indexTitle = Qt Charts Examples
54 qhp.QtCharts.subprojects.examples.indexTitle = Qt Charts Examples
63 qhp.QtCharts.subprojects.examples.selectors = fake:example
55 qhp.QtCharts.subprojects.examples.selectors = fake:example
64 qhp.QtCharts.subprojects.examples.sortPages = true
56 qhp.QtCharts.subprojects.examples.sortPages = true
65
57
66 navigation.landingpage = Qt Charts
58 navigation.landingpage = Qt Charts
67 navigation.cppclassespage = Qt Charts C++ Classes
59 navigation.cppclassespage = Qt Charts C++ Classes
68 navigation.qmltypespage = Qt Charts QML Types
60 navigation.qmltypespage = Qt Charts QML Types
69
70 depends = qtwidgets
71
72 buildversion = Qt Charts $QT_VERSION Reference Documentation
Show file before | Show file after | Hide comments
@@ -1,71 +1,70
1 /****************************************************************************
1 /****************************************************************************
2 **
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
4 ** Contact: https://www.qt.io/licensing/
5 **
5 **
6 ** This file is part of the Qt Charts module of the Qt Toolkit.
6 ** This file is part of the Qt Charts module of the Qt Toolkit.
7 **
7 **
8 ** $QT_BEGIN_LICENSE:GPL$
8 ** $QT_BEGIN_LICENSE:GPL$
9 ** Commercial License Usage
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
16 **
17 ** GNU General Public License Usage
17 ** GNU General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU
18 ** Alternatively, this file may be used under the terms of the GNU
19 ** General Public License version 3 or (at your option) any later version
19 ** General Public License version 3 or (at your option) any later version
20 ** approved by the KDE Free Qt Foundation. The licenses are as published by
20 ** approved by the KDE Free Qt Foundation. The licenses are as published by
21 ** the Free Software Foundation and appearing in the file LICENSE.GPL3
21 ** the Free Software Foundation and appearing in the file LICENSE.GPL3
22 ** included in the packaging of this file. Please review the following
22 ** included in the packaging of this file. Please review the following
23 ** information to ensure the GNU General Public License requirements will
23 ** information to ensure the GNU General Public License requirements will
24 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
24 ** be met: https://www.gnu.org/licenses/gpl-3.0.html.
25 **
25 **
26 ** $QT_END_LICENSE$
26 ** $QT_END_LICENSE$
27 **
27 **
28 ****************************************************************************/
28 ****************************************************************************/
29
29
30 /*!
30 /*!
31 \title Qt Charts
31 \title Qt Charts
32 \page index.html
32 \page qtcharts-index.html
33 \keyword About
34
33
35 Qt Charts module provides a set of easy to use chart components. It uses the Qt Graphics View
34 Qt Charts module provides a set of easy to use chart components. It uses the Qt Graphics View
36 Framework, therefore charts can be easily integrated to modern user interfaces. Qt Charts can
35 Framework, therefore charts can be easily integrated to modern user interfaces. Qt Charts can
37 be used as QWidgets, QGraphicsWidget, or QML types. Users can easily create impressive
36 be used as QWidgets, QGraphicsWidget, or QML types. Users can easily create impressive
38 graphs by selecting one of the charts themes.
37 graphs by selecting one of the charts themes.
39
38
40 \section1 Getting Started
39 \section1 Getting Started
41
40
42 To import Qt Charts QML types, add the following import statement to your \c .qml file:
41 To import Qt Charts QML types, add the following import statement to your \c .qml file:
43
42
44 \snippet doc_src_qmlcharts.cpp 0
43 \snippet doc_src_qmlcharts.cpp 0
45
44
46 If you intend to use Qt Charts C++ classes in your application, use the
45 If you intend to use Qt Charts C++ classes in your application, use the
47 following include and using directives:
46 following include and using directives:
48
47
49 \snippet doc_src_qtcharts.cpp 0
48 \snippet doc_src_qtcharts.cpp 0
50
49
51 \note If you are only using a few classes from this module, we recommend including only those
50 \note If you are only using a few classes from this module, we recommend including only those
52 specific classes instead of the whole module.
51 specific classes instead of the whole module.
53
52
54 To link against the Qt Charts module, add this line to your \c qmake project file:
53 To link against the Qt Charts module, add this line to your \c qmake project file:
55
54
56 \snippet doc_src_qtcharts.pro 0
55 \snippet doc_src_qtcharts.pro 0
57
56
58 See the \l{Qt Charts Getting Started}{Getting started} page for further information on
57 See the \l{Qt Charts Getting Started}{Getting started} page for further information on
59 how to use Qt Charts in your application.
58 how to use Qt Charts in your application.
60
59
61 \section1 References
60 \section1 References
62 \list
61 \list
63 \li \l{Qt Charts C++ Classes}
62 \li \l{Qt Charts C++ Classes}
64 \li \l{Qt Charts QML Types}
63 \li \l{Qt Charts QML Types}
65 \endlist
64 \endlist
66
65
67 Qt Charts comes with the following examples:
66 Qt Charts comes with the following examples:
68
67
69 \annotatedlist qtcharts_examples
68 \annotatedlist qtcharts_examples
70
69
71 */
70 */
General Comments 0
You need to be logged in to leave comments. Login now