diff options
Diffstat (limited to 'src/charts/doc/src/index.qdoc')
-rw-r--r-- | src/charts/doc/src/index.qdoc | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/src/charts/doc/src/index.qdoc b/src/charts/doc/src/index.qdoc new file mode 100644 index 00000000..15408f24 --- /dev/null +++ b/src/charts/doc/src/index.qdoc @@ -0,0 +1,61 @@ +/**************************************************************************** +** +** Copyright (C) 2014 Digia Plc +** All rights reserved. +** For any questions to Digia, please use contact form at http://qt.digia.com +** +** This file is part of the QtCharts module. +** +** Licensees holding valid Qt Enterprise licenses may use this file in +** accordance with the Qt Enterprise License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. +** +** If you have questions regarding the use of this file, please use +** contact form at http://qt.digia.com +** +****************************************************************************/ + +/*! + \title Qt Charts + \page index.html + \keyword About + + Qt Charts is a part of the Qt Enterprise addons package. It provides a set of easy to use chart + components which are available for Qt customers. It uses the Qt Graphics View + Framework, therefore charts can be easily integrated to modern user interfaces. Qt Charts can + be used as QWidgets, QGraphicsWidget, or QML types. Users can easily create impressive + graphs by selecting one of the charts themes. + + \section1 Getting Started + + To import Qt Charts QML types, add the following import statement to your \c .qml file: + + \snippet doc_src_qmlcharts.cpp 0 + + 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 + + \note If you are only using a few classes from this module, we recommend including only those + specific classes instead of the whole module. + + To link against the Qt Charts module, add this line to your \c qmake project file: + + \snippet doc_src_qtcharts.pro 0 + + See the \l{Qt Charts Getting Started}{Getting started} page for further information on + how to use Qt Charts in your application. + + \section1 References + \list + \li \l{Qt Charts C++ Classes} + \li \l{Qt Charts QML Types} + \endlist + + Qt Charts comes with the following examples: + + \annotatedlist qtcharts_examples + +*/ |