diff options
Diffstat (limited to 'src/charts/doc/src/qtcharts.qdoc')
| -rw-r--r-- | src/charts/doc/src/qtcharts.qdoc | 149 |
1 files changed, 18 insertions, 131 deletions
diff --git a/src/charts/doc/src/qtcharts.qdoc b/src/charts/doc/src/qtcharts.qdoc index 7d6e78ea..e83e2631 100644 --- a/src/charts/doc/src/qtcharts.qdoc +++ b/src/charts/doc/src/qtcharts.qdoc @@ -1,23 +1,31 @@ -/****************************************************************************** +/**************************************************************************** ** -** Copyright (C) 2015 The Qt Company Ltd. -** Contact: http://www.qt.io/licensing/ +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ ** -** This file is part of the Qt Charts module. -** -** $QT_BEGIN_LICENSE:COMM$ +** This file is part of the Qt Charts module of the Qt Toolkit. ** +** $QT_BEGIN_LICENSE:GPL$ ** 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 http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/contact-us. +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3 or (at your option) any later version +** approved by the KDE Free Qt Foundation. The licenses are as published by +** the Free Software Foundation and appearing in the file LICENSE.GPL3 +** included in the packaging of this file. Please review the following +** information to ensure the GNU General Public License requirements will +** be met: https://www.gnu.org/licenses/gpl-3.0.html. ** ** $QT_END_LICENSE$ ** -******************************************************************************/ +****************************************************************************/ /*! \module Qt Charts @@ -42,7 +50,7 @@ */ /*! - \qmlmodule QtCharts 2.0 + \qmlmodule QtCharts 2.1 \title Qt Charts QML Types \ingroup qmlmodules @@ -78,124 +86,3 @@ \annotatedlist qtcharts_examples */ - -/*! - \group qtcharts_getting_started - \title Qt Charts Getting Started - - \section1 Installing the Qt Charts module - - Use the \c {Package Manager} in \c {Maintenance Tool} or the \c {Online installer} to install - the Qt Charts module. The module can be found under \c {Qt Enterprise Add-Ons} in the - package manager. - - After installation Qt Charts documentation and examples are available in Qt Creator. - Examples can be found on the examples page of Qt Creator by selecting the Qt Charts - component from the drop-down menu. - - The source code is installed into the QtCharts folder under EnterpriseAddOns. - - \section1 Building Qt Charts - - To build the Qt Charts module from source code yourself, set up a command prompt with - an environment for building Qt applications, navigate to the directory containing - \c {qtcharts.pro}, and configure the project with qmake: - \code - qmake - \endcode - - qmake should be run from the folder where Qt has been installed. For example, - if Qt is built with -prefix /opt/MyXCompiledQt, then qmake should be run - from /opt/MyXCompiledQt/bin/qmake. - - After running qmake, build the project with make: - \table - \header - \li OS \li Make command - \row - \li Linux \li make - \row - \li Windows (MinGw) \li mingw32-make - \row - \li Windows (MSVC) \li nmake - \row - \li OSX \li make - \endtable - - The above generates the default makefiles for your configuration, which is typically - the release build if you are using precompiled binary Qt distribution. To build both debug - and release, or one specifically, use one of the following qmake lines instead. - - For debug builds: - \code - qmake CONFIG+=debug - make - \endcode - or - \code - qmake CONFIG+=debug_and_release - make debug - \endcode - - For release builds: - \code - qmake CONFIG+=release - make - \endcode - or - \code - qmake CONFIG+=debug_and_release - make release - \endcode - - For both builds (Windows/OS X only): - \code - qmake CONFIG+="debug_and_release build_all" - make - \endcode - - After building, install the module to your Qt directory: - \code - make install - \endcode - - If you want to uninstall the module: - \code - make uninstall - \endcode - - To build a statically linked version of the Qt Charts module, give the following commands: - - \snippet doc_src_qtcharts.cpp 1 - - \section1 Running examples - - Qt Charts examples are found under the \c examples subdirectory. To build and run a single - example, in this case qmlpolarchart, navigate to the example directory and enter the following - commands: - - \snippet doc_src_qtcharts.cpp 2 - - \note On some platforms, such as Windows, the executable can be generated under debug or - release folders, depending on your build. - - \section1 Creating a simple application - - To create a simple application, start by creating a new Qt Gui Application project in Qt - Creator and add this line to the \c .pro file of the project: - - \snippet doc_src_qtcharts.pro 0 - - In the \c main.cpp file, include the module headers and declare namespace usage: - - \snippet doc_src_qtcharts.cpp 0 - - \note Since Qt Creator 3.0 the project created with Qt Quick Application wizard based on - Qt Quick 2 template uses QGuiApplication by default. As Qt Charts utilizes Qt Graphics View - Framework for drawing, QApplication must be used. The project created with the wizard is - usable with Qt Charts after the QGuiApplication is replaced with QApplication. - - For further code examples, see one of the Qt Charts examples: - - \annotatedlist qtcharts_examples -*/ |