diff --git a/charts.pro b/charts.pro index 530e4f6..c9bf56c 100644 --- a/charts.pro +++ b/charts.pro @@ -20,11 +20,18 @@ feature.files = $$PWD/features/qtcommercialchart.prf INSTALLS += feature # docs -CHARTS_VERSION = 1.3.0 -CHARTS_VERSION_TAG = 130 +CHARTS_VERSION = 1.3.1 +CHARTS_VERSION_TAG = 131 + +contains(QT_MAJOR_VERSION, 5) { + QDOC_CONFFILE = qcharts-qt5.qdocconf + DEFINES += QDOC_QT5 +} else { + QDOC_CONFFILE = qcharts-qt4.qdocconf +} contains(QMAKE_HOST.os, Windows) { - QDOC_CONF = $$CHART_BUILD_DOC_DIR\\qcharts.qdocconf + QDOC_CONF = $$CHART_BUILD_DOC_DIR\\docconf\\$$QDOC_CONFFILE win32-g++|qnx { VERSION_SETTINGS = \ set QT_CHARTS_VERSION=$$CHARTS_VERSION&& set QT_CHARTS_VERSION_TAG=$$CHARTS_VERSION_TAG&& @@ -34,7 +41,7 @@ contains(QMAKE_HOST.os, Windows) { set QT_CHARTS_VERSION_TAG=$$CHARTS_VERSION_TAG $$escape_expand(\\n\\t) } } else { - QDOC_CONF = $$CHART_BUILD_DOC_DIR/qcharts.qdocconf + QDOC_CONF = $$CHART_BUILD_DOC_DIR/docconf/$$QDOC_CONFFILE VERSION_SETTINGS = \ QT_CHARTS_VERSION=$$CHARTS_VERSION QT_CHARTS_VERSION_TAG=$$CHARTS_VERSION_TAG } diff --git a/doc/compat.qdocconf b/doc/docconf/compat.qdocconf similarity index 92% rename from doc/compat.qdocconf rename to doc/docconf/compat.qdocconf index 4b8d7a4..d14b78e 100644 --- a/doc/compat.qdocconf +++ b/doc/docconf/compat.qdocconf @@ -1,5 +1,5 @@ macro.0 = "\\\\0" -macro.b = "\\\\b" +macro.b = "\\bold" macro.n = "\\\\n" macro.r = "\\\\r" macro.i = "\\o" @@ -26,3 +26,6 @@ macro.relatesto = "\\relates" spurious = "Missing comma in .*" \ "Missing pattern .*" + +macro.li = "\\o" +macro.e = "\\i" \ No newline at end of file diff --git a/doc/macros.qdocconf b/doc/docconf/macros.qdocconf similarity index 100% rename from doc/macros.qdocconf rename to doc/docconf/macros.qdocconf diff --git a/doc/qchart-html-template.qdocconf b/doc/docconf/qchart-html-template.qdocconf similarity index 100% rename from doc/qchart-html-template.qdocconf rename to doc/docconf/qchart-html-template.qdocconf diff --git a/doc/qchart-html.qdocconf b/doc/docconf/qchart-html.qdocconf similarity index 68% rename from doc/qchart-html.qdocconf rename to doc/docconf/qchart-html.qdocconf index 52b8ce2..f7cf8ad 100644 --- a/doc/qchart-html.qdocconf +++ b/doc/docconf/qchart-html.qdocconf @@ -4,7 +4,7 @@ HTML.templatedir = . -HTML.stylesheets = style/offline.css +HTML.stylesheets = ../style/offline.css HTML.scripts = @@ -27,25 +27,24 @@ extraimages.HTML = qt-logo.png \ bg.png # extraimages definition for Qt5 -HTML.extraimages = ./images/qt-logo.png \ - ./images/digia_logo.png \ - ./images/qcharts.png \ - ./images/arrow_down.png \ - ./images/breadcrumb.png \ - ./images/bullet_gt.png \ - ./images/bullet_dn.png \ - ./images/bullet_sq.png \ - ./images/bullet_up.png \ - ./images/horBar.png \ - ./images/presenterchart_example.png \ - ./images/bg.png +HTML.extraimages = ../images/qt-logo.png \ + ../images/digia_logo.png \ + ../images/qcharts.png \ + ../images/arrow_down.png \ + ../images/breadcrumb.png \ + ../images/bullet_gt.png \ + ../images/bullet_dn.png \ + ../images/bullet_sq.png \ + ../images/bullet_up.png \ + ../images/horBar.png \ + ../images/bg.png # Include the style sheets and scripts used. HTML.headerstyles = \ " \n" -HTML.headerscripts = +HTML.headerscripts = HTML.endheader = \ "\n" \ diff --git a/doc/qchart-qch.qdocconf b/doc/docconf/qchart-qch.qdocconf similarity index 97% rename from doc/qchart-qch.qdocconf rename to doc/docconf/qchart-qch.qdocconf index 49f6f5c..8c3d9d6 100644 --- a/doc/qchart-qch.qdocconf +++ b/doc/docconf/qchart-qch.qdocconf @@ -1,4 +1,4 @@ -qhp.projects = QtCharts +qhp.projects = QtCharts qhp.QtCharts.file = qtcharts.qhp qhp.QtCharts.namespace = com.digia.qtcharts.$QT_CHARTS_VERSION_TAG qhp.QtCharts.virtualFolder = doc @@ -28,17 +28,17 @@ qhp.QtCharts.subprojects.demos.indexTitle = Qt Charts Demos # Files not referenced in any qdoc file. # See also extraimages.HTML qhp.QtCharts.extraFiles = index.html \ - examples.html \ - demos.html \ - images/arrow_down.png \ - images/bg.png \ - images/breadcrumb.png \ - images/bullet_gt.png \ - images/bullet_dn.png \ - images/bullet_sq.png \ - images/bullet_up.png \ - images/digia_logo.png \ - images/horBar.png \ - images/qcharts.png \ - images/qt-logo.png \ - style/offline.css + examples.html \ + demos.html \ + images/arrow_down.png \ + images/bg.png \ + images/breadcrumb.png \ + images/bullet_gt.png \ + images/bullet_dn.png \ + images/bullet_sq.png \ + images/bullet_up.png \ + images/digia_logo.png \ + images/horBar.png \ + images/qcharts.png \ + images/qt-logo.png \ + style/offline.css diff --git a/doc/docconf/qcharts-qt4.qdocconf b/doc/docconf/qcharts-qt4.qdocconf new file mode 100644 index 0000000..6df07fd --- /dev/null +++ b/doc/docconf/qcharts-qt4.qdocconf @@ -0,0 +1,9 @@ +include(compat.qdocconf) +include(macros.qdocconf) +include(qchart-html-template.qdocconf) +include(qchart-qch.qdocconf) +include(qcharts.qdocconf) + +outputdir = ../html +imagedirs = ../images +sourcedirs += ../src_qt4 diff --git a/doc/docconf/qcharts-qt5.qdocconf b/doc/docconf/qcharts-qt5.qdocconf new file mode 100644 index 0000000..5c1fe53 --- /dev/null +++ b/doc/docconf/qcharts-qt5.qdocconf @@ -0,0 +1,9 @@ +include(macros.qdocconf) +include(qchart-html-template.qdocconf) +include(qchart-qch.qdocconf) +include(qcharts.qdocconf) + +defines = QDOC_QT5 +outputdir = ../html +imagedirs = ../../images +excludedirs += ../src_qt4 diff --git a/doc/qcharts.qdocconf b/doc/docconf/qcharts.qdocconf similarity index 64% rename from doc/qcharts.qdocconf rename to doc/docconf/qcharts.qdocconf index b83476f..55185ce 100644 --- a/doc/qcharts.qdocconf +++ b/doc/docconf/qcharts.qdocconf @@ -1,33 +1,24 @@ -include(compat.qdocconf) -include(macros.qdocconf) -include(qchart-html-template.qdocconf) -include(qchart-qch.qdocconf) - project = Qt Charts description = Library for creating charts +version = 1.3.1 -sourcedirs = ../src \ - ../examples \ - ./src \ - ../plugins/declarative -headerdirs = ../src \ - ../examples \ - ../plugins/declarative -exampledirs = ../ \ - ../src \ - ../examples - -excludefiles += ../examples/linechart/linechart.pro +sourcedirs = ../../src \ + ../../examples \ + ../src \ + ../qch \ + ../../plugins/declarative +headerdirs = ../../src \ + ../../examples \ + ../../plugins/declarative +exampledirs = ../../ \ + ../../src \ + ../../examples -sources.fileextensions = *.cpp *.qdoc *.mm *.qml +sources.fileextensions = *.cpp *.qdoc *.mm *.qml *.qdocinc headers.fileextensions = *.h *.ch *.h++ *.hh *.hpp *.hxx examples.fileextensions = *.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml examples.imageextensions = *.png *.jpeg *.jpg *.gif *.mng -imagedirs = ./images -outputdir = ./html - - Cpp.ignoretokens = QTCOMMERCIALCHART_EXPORT \ QTCOMMERCIALCHART_END_NAMESPACE \ QTCOMMERCIALCHART_BEGIN_NAMESPACE diff --git a/doc/src/abstractaxis.qdocinc b/doc/src/abstractaxis.qdocinc new file mode 100644 index 0000000..79cce2e --- /dev/null +++ b/doc/src/abstractaxis.qdocinc @@ -0,0 +1,6 @@ +\brief The AbstractAxis is a base element used for specialized axis elements. + +Each series can be bound to only one horizontal and vertical axis. + +Properties and visibility of various axis elements such as axis line, title, labels, grid lines, +and shades can be individually controlled. diff --git a/doc/src/abstractbarseries.qdocinc b/doc/src/abstractbarseries.qdocinc new file mode 100644 index 0000000..5dc8698 --- /dev/null +++ b/doc/src/abstractbarseries.qdocinc @@ -0,0 +1,9 @@ +\inherits AbstractSeries + +The following QML shows how to create a simple bar chart: +\snippet ../demos/qmlchart/qml/qmlchart/View6.qml 1 + +\beginfloatleft +\image demos_qmlchart6.png +\endfloat +\clearfloat diff --git a/doc/src/abstractseries.qdocinc b/doc/src/abstractseries.qdocinc new file mode 100644 index 0000000..40286e6 --- /dev/null +++ b/doc/src/abstractseries.qdocinc @@ -0,0 +1,2 @@ +AbstractSeries is the base class for all series. +The class cannot be instantiated by the user. diff --git a/doc/src/areaseries.qdocinc b/doc/src/areaseries.qdocinc new file mode 100644 index 0000000..1fd2122 --- /dev/null +++ b/doc/src/areaseries.qdocinc @@ -0,0 +1,8 @@ +\inherits AbstractSeries + +The following QML shows how to create a simple area chart: +\snippet ../demos/qmlchart/qml/qmlchart/View4.qml 1 +\beginfloatleft +\image demos_qmlchart4.png +\endfloat +\clearfloat diff --git a/doc/src/barcategoryaxis.qdocinc b/doc/src/barcategoryaxis.qdocinc new file mode 100644 index 0000000..858e704 --- /dev/null +++ b/doc/src/barcategoryaxis.qdocinc @@ -0,0 +1,17 @@ +\inherits AbstractAxis + +\brief The Axis element is used for manipulating chart's axes. + +Axis can be setup to show axis line with tick marks, grid lines and shades. +Categories are drawn between ticks. Note that you can use this also with lineseries too. + +To access BarCategoryAxis you can use ChartView API. For example: +\code + ChartView { + BarCategoryAxis { + id: categoryAxis + categories: ["Jan", "Feb", "Mar", "Apr", "May", "Jun" ] + } + // Add a few series... + } +\endcode diff --git a/doc/src/barseries.qdocinc b/doc/src/barseries.qdocinc new file mode 100644 index 0000000..4deb9fe --- /dev/null +++ b/doc/src/barseries.qdocinc @@ -0,0 +1,8 @@ +\inherits AbstractBarSeries + +The following QML shows how to create a simple grouped bar chart: +\snippet ../demos/qmlchart/qml/qmlchart/View6.qml 1 +\beginfloatleft +\image demos_qmlchart6.png +\endfloat +\clearfloat diff --git a/doc/src/barset.qdocinc b/doc/src/barset.qdocinc new file mode 100644 index 0000000..d9098ae --- /dev/null +++ b/doc/src/barset.qdocinc @@ -0,0 +1,5 @@ +BarSet represents one set of bars. Set of bars contains one data value for each category. +First value of set is assumed to belong to first category, second to second category and so on. +If set has fewer values than there are categories, then the missing values are assumed to be +at the end of set. For missing values in middle of a set, numerical value of zero is used. +\sa AbstractBarSeries, BarSeries, StackedBarSeries, PercentBarSeries diff --git a/doc/src/categoryaxis.qdocinc b/doc/src/categoryaxis.qdocinc new file mode 100644 index 0000000..a0c313e --- /dev/null +++ b/doc/src/categoryaxis.qdocinc @@ -0,0 +1,12 @@ +\inherits AbstractAxis +\brief CategoryAxis allows putting a named ranges on the axis. + +For example: +\table + \row + \li \br + \br + \br + \snippet ../demos/qmlaxes/qml/qmlaxes/View3.qml 1 + \li \inlineimage demos_qmlaxes3.png +\endtable diff --git a/doc/src/categoryrange.qdocinc b/doc/src/categoryrange.qdocinc new file mode 100644 index 0000000..59a1d85 --- /dev/null +++ b/doc/src/categoryrange.qdocinc @@ -0,0 +1,2 @@ +\brief With CategoryRange you can define a range used by a CategoryAxis. +\sa CategoryAxis diff --git a/doc/src/chartview.qdocinc b/doc/src/chartview.qdocinc new file mode 100644 index 0000000..10a2460 --- /dev/null +++ b/doc/src/chartview.qdocinc @@ -0,0 +1,11 @@ +ChartView element is the parent that is responsible for showing different chart series types. + +The following QML shows how to create a simple chart with one pie series: +\snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 1 +\snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 2 +\snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 3 + +\beginfloatleft +\image examples_qmlpiechart.png +\endfloat +\clearfloat diff --git a/doc/src/classes.qdoc b/doc/src/classes.qdoc index 7b180ee..290e4bd 100644 --- a/doc/src/classes.qdoc +++ b/doc/src/classes.qdoc @@ -89,6 +89,7 @@
  • QBoxSet
  • QHBarModelMapper
  • QVBarModelMapper
    • +
  • QVBoxPlotModelMapper
  • QHorizontalBarSeries
  • QHorizontalStackedBarSeries
  • QHorizontalPercentBarSeries
    • diff --git a/doc/src/datetimeaxis.qdocinc b/doc/src/datetimeaxis.qdocinc new file mode 100644 index 0000000..1f1be20 --- /dev/null +++ b/doc/src/datetimeaxis.qdocinc @@ -0,0 +1,6 @@ +\brief The DateTimeAxis element is used for manipulating chart's axes. +\inherits AbstractAxis + +The labels can be configured by setting an appropriate DateTime format. +Note that any date before 4714 BCE or after about 1.4 million CE may not be accurately stored. +DateTimeAxis can be setup to show axis line with tick marks, grid lines and shades. diff --git a/doc/src/declarativeboxplotseries.qdocinc b/doc/src/declarativeboxplotseries.qdocinc new file mode 100644 index 0000000..8b08cd6 --- /dev/null +++ b/doc/src/declarativeboxplotseries.qdocinc @@ -0,0 +1,34 @@ +\inherits AbstractSeries + +BoxPlotSeries represents a series of data shown as box-and-whiskers bars. The purpose of this class is to act as +a container for single box-and-whiskers items. Each item is drawn to own slot. If chart includes multiple instances of +BoxPlotSeries then box-and-whiskers items with the same index are drawn to same slot. + +The following QML shows how to create a simple box-and-whiskers chart: +\code +import QtQuick 1.0 +import QtCommercial.Chart 1.3 + +ChartView { + title: "Box Plot series" + width: 400 + height: 300 + theme: ChartView.ChartThemeBrownSand + legend.alignment: Qt.AlignBottom + + BoxPlotSeries { + id: plotSeries + name: "Income" + BoxSet { label: "Jan"; values: [3, 4, 5.1, 6.2, 8.5] } + BoxSet { label: "Feb"; values: [5, 6, 7.5, 8.6, 11.8] } + BoxSet { label: "Mar"; values: [3.2, 5, 5.7, 8, 9.2] } + BoxSet { label: "Apr"; values: [3.8, 5, 6.4, 7, 8] } + BoxSet { label: "May"; values: [4, 5, 5.2, 6, 7] } + } +} +\endcode + +\beginfloatleft +\image examples_qmlboxplot.png +\endfloat +\clearfloat diff --git a/doc/src/declarativeboxset.qdocinc b/doc/src/declarativeboxset.qdocinc new file mode 100644 index 0000000..8dd9c99 --- /dev/null +++ b/doc/src/declarativeboxset.qdocinc @@ -0,0 +1,6 @@ +BoxSet represents one box-and-whiskers item. It takes five values to create a graphical representation +of range and three medians. There are two ways to give the values. The first one is with constructor +or with append method. In these the values have to be given in the following order: lower extreme, lower quartile, median, +upper quartile and upper extreme. The second method is to create an empty QBoxSet instance and give the values using +value specific methods. +\sa BoxPlotSeries diff --git a/doc/src/declarativepolarchart.qdocinc b/doc/src/declarativepolarchart.qdocinc new file mode 100644 index 0000000..778b089 --- /dev/null +++ b/doc/src/declarativepolarchart.qdocinc @@ -0,0 +1,20 @@ +PolarChartView element is the parent that is responsible for showing different chart series types +in a polar chart. + +Polar charts support line, spline, area, and scatter series, and all axis types +supported by those series. + +\note When setting ticks to an angular ValueAxis, keep in mind that the first and last tick +are co-located at 0/360 degree angle. + +\note If the angular distance between two consecutive points in a series is more than 180 degrees, +any line connecting the two points becomes meaningless, so choose the axis ranges accordingly +when displaying line, spline, or area series. + +The following QML shows how to create a polar chart with two series: +\snippet ../demos/qmlpolarchart/qml/qmlpolarchart/View1.qml 1 + +\beginfloatleft +\image demos_qmlpolarchart1.png +\endfloat +\clearfloat diff --git a/doc/src/declarativexypoint.qdocinc b/doc/src/declarativexypoint.qdocinc new file mode 100644 index 0000000..7df317a --- /dev/null +++ b/doc/src/declarativexypoint.qdocinc @@ -0,0 +1,3 @@ +XYPoint is a convenience element for initializing XY-series with static coordinate data. To +manipulate an XY-series dynamically, use it's data manipulation functions instead. +\sa LineSeries, AreaSeries, ScatterSeries, SplineSeries diff --git a/doc/src/demos-qmlaxes.qdoc b/doc/src/demos-qmlaxes.qdoc index 9fe2bcd..155dd74 100644 --- a/doc/src/demos-qmlaxes.qdoc +++ b/doc/src/demos-qmlaxes.qdoc @@ -7,26 +7,26 @@ \table \row - \o \br + \li \br We begin with a chart that has a line series and a scatter series with random data. Both series use the same axes. \br \br \snippet ../demos/qmlaxes/qml/qmlaxes/View1.qml 1 - \o \inlineimage demos_qmlaxes1.png + \li \inlineimage demos_qmlaxes1.png \row - \o \br + \li \br The next example shows a chart with some accurate historical data that makes us to use a DateTimeAxis. \br \br \snippet ../demos/qmlaxes/qml/qmlaxes/View2.qml 1 - \o \inlineimage demos_qmlaxes2.png + \li \inlineimage demos_qmlaxes2.png \row - \o \br + \li \br And the final example with a chart that uses a CategoryAxis to make the data easier to understand. \br \br \snippet ../demos/qmlaxes/qml/qmlaxes/View3.qml 1 - \o \inlineimage demos_qmlaxes3.png + \li \inlineimage demos_qmlaxes3.png \endtable */ diff --git a/doc/src/demos-qmlchart.qdoc b/doc/src/demos-qmlchart.qdoc index 2573f9b..77c6635 100644 --- a/doc/src/demos-qmlchart.qdoc +++ b/doc/src/demos-qmlchart.qdoc @@ -8,111 +8,111 @@ \table \row - \o \br + \li \br To create a pie, we use the PieSeries API together with a few PieSlices: \br \br \snippet ../demos/qmlchart/qml/qmlchart/View1.qml 1 - \o \inlineimage demos_qmlchart1.png + \li \inlineimage demos_qmlchart1.png \endtable \table \row - \o \br + \li \br To create a chart with a line series: \br \br \snippet ../demos/qmlchart/qml/qmlchart/View2.qml 1 - \o \inlineimage demos_qmlchart2.png + \li \inlineimage demos_qmlchart2.png \endtable \table \row - \o \br + \li \br And spline series: \br \br \snippet ../demos/qmlchart/qml/qmlchart/View3.qml 1 - \o \inlineimage demos_qmlchart3.png + \li \inlineimage demos_qmlchart3.png \endtable \table \row - \o \br + \li \br Then we create a chart that illustrates the NHL All-Star player selections by using three area series: \br \br \snippet ../demos/qmlchart/qml/qmlchart/View4.qml 1 - \o \inlineimage demos_qmlchart4.png + \li \inlineimage demos_qmlchart4.png \endtable \table \row - \o \br + \li \br Then a couple of scatter series: \br \br \snippet ../demos/qmlchart/qml/qmlchart/View5.qml 1 - \o \inlineimage demos_qmlchart5.png + \li \inlineimage demos_qmlchart5.png \endtable And a few different bar series: \table \row - \o \br + \li \br \br \br \snippet ../demos/qmlchart/qml/qmlchart/View6.qml 1 - \o \inlineimage demos_qmlchart6.png + \li \inlineimage demos_qmlchart6.png \endtable \table \row - \o \br + \li \br \br \br \snippet ../demos/qmlchart/qml/qmlchart/View7.qml 1 - \o \inlineimage demos_qmlchart7.png + \li \inlineimage demos_qmlchart7.png \endtable \table \row - \o \br + \li \br \br \br \snippet ../demos/qmlchart/qml/qmlchart/View8.qml 1 - \o \inlineimage demos_qmlchart8.png + \li \inlineimage demos_qmlchart8.png \endtable \table \row - \o \br + \li \br \br \br \snippet ../demos/qmlchart/qml/qmlchart/View9.qml 1 - \o \inlineimage demos_qmlchart9.png + \li \inlineimage demos_qmlchart9.png \endtable \table \row - \o \br + \li \br \br \br \snippet ../demos/qmlchart/qml/qmlchart/View10.qml 1 - \o \inlineimage demos_qmlchart10.png + \li \inlineimage demos_qmlchart10.png \endtable \table \row - \o \br + \li \br \br \br \snippet ../demos/qmlchart/qml/qmlchart/View11.qml 1 - \o \inlineimage demos_qmlchart11.png + \li \inlineimage demos_qmlchart11.png \endtable \table \row - \o \br + \li \br And finally an example demonstrating how to create a donut chart with two pie series: \br \br \snippet ../demos/qmlchart/qml/qmlchart/View12.qml 1 - \o \inlineimage demos_qmlchart12.png + \li \inlineimage demos_qmlchart12.png \endtable */ diff --git a/doc/src/demos-qmlcustomlegend.qdoc b/doc/src/demos-qmlcustomlegend.qdoc index 9e2d973..fe79e37 100644 --- a/doc/src/demos-qmlcustomlegend.qdoc +++ b/doc/src/demos-qmlcustomlegend.qdoc @@ -8,16 +8,16 @@ \table \row - \o \br + \li \br The main view of the application shows a stacked area chart. This is how one of \br the stacked areas is created. See ChartViewStacked.qml and AnimatedAreaSeries.qml. \br \br \snippet ../demos/qmlcustomlegend/qml/qmlcustomlegend/ChartViewStacked.qml 1 - \o \inlineimage demos-qmlcustomlegend1.png + \li \inlineimage demos-qmlcustomlegend1.png \row - \o \br + \li \br Hovering with mouse on top of the legend will highlight the hovered series. \br (see CustomLegend.qml). @@ -26,15 +26,15 @@ \snippet ../demos/qmlcustomlegend/qml/qmlcustomlegend/CustomLegend.qml 1 \snippet ../demos/qmlcustomlegend/qml/qmlcustomlegend/CustomLegend.qml 2 \snippet ../demos/qmlcustomlegend/qml/qmlcustomlegend/CustomLegend.qml 3 - \o \inlineimage demos-qmlcustomlegend2.png + \li \inlineimage demos-qmlcustomlegend2.png \row - \o \br + \li \br You can also select one of the stacked areas for a closer look as a line series by \br a mouse click (see ChartViewHighlighted.qml). \br \br \snippet ../demos/qmlcustomlegend/qml/qmlcustomlegend/ChartViewHighlighted.qml 1 - \o \inlineimage demos-qmlcustomlegend3.png + \li \inlineimage demos-qmlcustomlegend3.png \endtable */ diff --git a/doc/src/demos-qmlpolarchart.qdoc b/doc/src/demos-qmlpolarchart.qdoc index faa736c..ffe2105 100644 --- a/doc/src/demos-qmlpolarchart.qdoc +++ b/doc/src/demos-qmlpolarchart.qdoc @@ -7,27 +7,27 @@ \table \row - \o \br + \li \br We begin with a chart that has a spline series and a scatter series with random data. Both series use the same axes. \br \br \snippet ../demos/qmlpolarchart/qml/qmlpolarchart/View1.qml 1 - \o \inlineimage demos_qmlpolarchart1.png + \li \inlineimage demos_qmlpolarchart1.png \row - \o \br + \li \br The next example shows a chart with some accurate historical data for which we need to use a DateTimeAxis and a AreaSeries. \br \br \snippet ../demos/qmlpolarchart/qml/qmlpolarchart/View2.qml 1 - \o \inlineimage demos_qmlpolarchart2.png + \li \inlineimage demos_qmlpolarchart2.png \row - \o \br + \li \br And the final example with a chart that uses a CategoryAxis to make the data easier to understand. \br \br \snippet ../demos/qmlpolarchart/qml/qmlpolarchart/View3.qml 1 - \o \inlineimage demos_qmlpolarchart3.png + \li \inlineimage demos_qmlpolarchart3.png \endtable */ diff --git a/doc/src/examples-legend.qdoc b/doc/src/examples-legend.qdoc index 5128e29..cbefa1f 100644 --- a/doc/src/examples-legend.qdoc +++ b/doc/src/examples-legend.qdoc @@ -10,8 +10,8 @@ \table \row - \o \inlineimage examples_legend_detach.png - \o \inlineimage examples_legend_detach2.png + \li \inlineimage examples_legend_detach.png + \li \inlineimage examples_legend_detach2.png \endtable Here we turn the legend visible and set its alignment to the bottom of the chart. diff --git a/doc/src/font.qdocinc b/doc/src/font.qdocinc new file mode 100644 index 0000000..6cb17aa --- /dev/null +++ b/doc/src/font.qdocinc @@ -0,0 +1,3 @@ +\brief Defines the font used for drawing text. + +Font instantiates the C++ class QFont diff --git a/doc/src/gettingstarted.qdoc b/doc/src/gettingstarted.qdoc index 0aa8a9d..081a7b9 100644 --- a/doc/src/gettingstarted.qdoc +++ b/doc/src/gettingstarted.qdoc @@ -31,7 +31,7 @@ make install \endcode - Please note that the \i build_all option is necessary for the install to work correctly. Otherwise it will not install both versions. + Please note that the \e build_all option is necessary for the install to work correctly. Otherwise it will not install both versions. Building without demos and examples: \code @@ -40,7 +40,7 @@ make install \endcode - \bold {New project} + \b {New project} Create a new project in a usual way and then add to your project's *.pro file following line: @@ -48,7 +48,7 @@ CONFIG += qtcommercialchart \endcode - \bold {Widget project} + \b {Widget project} To use the Qt Charts classes add Qt Charts namespace macro in your header file. \code @@ -60,7 +60,7 @@ class ExampleWidget : public QWidget \endcode - \bold {QML project} + \b {QML project} Add an import line to your *.qml file: \code diff --git a/doc/src/hbarmodelmapper.qdocinc b/doc/src/hbarmodelmapper.qdocinc new file mode 100644 index 0000000..f4e7dcb --- /dev/null +++ b/doc/src/hbarmodelmapper.qdocinc @@ -0,0 +1,17 @@ +HBarModelMapper allows you to use your own QAbstractItemModel derived model with data in rows as a data source +for any bar series. It is possible to use both QAbstractItemModel and bar series data API to manipulate data. +HBarModelMapper keeps the series and the model in sync. + +The following QML example would create a bar series with three bar sets (assuming the model has +at least four rows). Each bar set would contain data starting from column 1. The name of a set would be defined by +the vertical header (of the row). +\code + BarSeries { + HBarModelMapper { + model: myCustomModel // QAbstractItemModel derived implementation + firstBarSetRow: 1 + lastBarSetRow: 3 + firstColumn: 1 + } + } +\endcode diff --git a/doc/src/horizontalbarseries.qdocinc b/doc/src/horizontalbarseries.qdocinc new file mode 100644 index 0000000..6c04915 --- /dev/null +++ b/doc/src/horizontalbarseries.qdocinc @@ -0,0 +1,8 @@ +\inherits AbstractBarSeries + +The following QML shows how to create a simple horizontal bar chart: +\snippet ../demos/qmlchart/qml/qmlchart/View9.qml 1 +\beginfloatleft +\image demos_qmlchart9.png +\endfloat +\clearfloat diff --git a/doc/src/horizontalpercentbarseries.qdocinc b/doc/src/horizontalpercentbarseries.qdocinc new file mode 100644 index 0000000..922b0bd --- /dev/null +++ b/doc/src/horizontalpercentbarseries.qdocinc @@ -0,0 +1,8 @@ +\inherits AbstractBarSeries + +The following QML shows how to create a simple horizontal percent bar chart: +\snippet ../demos/qmlchart/qml/qmlchart/View11.qml 1 +\beginfloatleft +\image demos_qmlchart11.png +\endfloat +\clearfloat diff --git a/doc/src/horizontalstackedbarseries.qdocinc b/doc/src/horizontalstackedbarseries.qdocinc new file mode 100644 index 0000000..d7665e2 --- /dev/null +++ b/doc/src/horizontalstackedbarseries.qdocinc @@ -0,0 +1,8 @@ +\inherits AbstractBarSeries + +The following QML shows how to create a simple horizontal stacked bar chart: +\snippet ../demos/qmlchart/qml/qmlchart/View10.qml 1 +\beginfloatleft +\image demos_qmlchart10.png +\endfloat +\clearfloat diff --git a/doc/src/hpiemodelmapper.qdocinc b/doc/src/hpiemodelmapper.qdocinc new file mode 100644 index 0000000..3320bb9 --- /dev/null +++ b/doc/src/hpiemodelmapper.qdocinc @@ -0,0 +1,16 @@ +HPieModelMapper allows you to use your own QAbstractItemModel derived model with data in rows as a data source +for a pie series. It is possible to use both QAbstractItemModel and PieSeries data API to manipulate data. +HPieModelMapper keeps the Pie and the model in sync. + +The following QML example would create a pie series with four slices (assuming the model has +at least five columns). Each slice would contain a label from row 1 and a value from row 2. +\code + HPieModelMapper { + series: pieSeries + model: customModel + labelsRow: 1 + valuesRow: 2 + firstColumn: 1 + columnCount: 4 + } +\endcode diff --git a/doc/src/hxymodelmapper.qdocinc b/doc/src/hxymodelmapper.qdocinc new file mode 100644 index 0000000..612959e --- /dev/null +++ b/doc/src/hxymodelmapper.qdocinc @@ -0,0 +1,3 @@ +HXYModelMapper allows you to use your own QAbstractItemModel derived model with data in rows as a data source +for XYSeries based series. It is possible to use both QAbstractItemModel and XYSeries data API to manipulate data. +HXYModelMapper keeps the series and the model in sync. diff --git a/doc/src/legend.qdocinc b/doc/src/legend.qdocinc new file mode 100644 index 0000000..d2c6ef6 --- /dev/null +++ b/doc/src/legend.qdocinc @@ -0,0 +1,17 @@ +\brief Legend is part of Qt Chart QML API. + +Legend is a graphical object, whics displays legend of the chart. Legend state is updated by ChartView, when +series have been changed. Legend is used via ChartView class. For example: +\code + ChartView { + legend.visible: true + legend.alignment: Qt.AlignBottom + // Add a few series... + } +\endcode + +\image examples_percentbarchart_legend.png + +Please note that there is no QML API available for modifying legend markers, unlike in the Qt API of Charts. +The use case of modifying markers can be implemented for example by creating your own custom legend. For an example +on how to do this, see \l {demos/qmlcustomlegend}{Qml Custom Demo} application. diff --git a/doc/src/lineseries.qdocinc b/doc/src/lineseries.qdocinc new file mode 100644 index 0000000..4e1ba98 --- /dev/null +++ b/doc/src/lineseries.qdocinc @@ -0,0 +1,8 @@ +\inherits XYSeries + +The following QML shows how to create a simple line chart: +\snippet ../demos/qmlchart/qml/qmlchart/View2.qml 1 +\beginfloatleft +\image demos_qmlchart2.png +\endfloat +\clearfloat diff --git a/doc/src/logvalueaxis.qdocinc b/doc/src/logvalueaxis.qdocinc new file mode 100644 index 0000000..d027e78 --- /dev/null +++ b/doc/src/logvalueaxis.qdocinc @@ -0,0 +1,7 @@ +\brief The LogValueAxis element is used for manipulating chart's axes. +\inherits AbstractAxis + +\note If a LogValueAxis is attached to a series with one or more points with +negative or zero values on the associated dimension, the series will not be +plotted at all. This is particularly relevant when XYModelMappers are used, +since empty cells in models typically contain zero values. diff --git a/doc/src/margins.qdocinc b/doc/src/margins.qdocinc new file mode 100644 index 0000000..941b00d --- /dev/null +++ b/doc/src/margins.qdocinc @@ -0,0 +1 @@ +Uncreatable type that is used to define top, bottom, left and right margins. diff --git a/doc/src/persentbarseries.qdocinc b/doc/src/persentbarseries.qdocinc new file mode 100644 index 0000000..ebb65aa --- /dev/null +++ b/doc/src/persentbarseries.qdocinc @@ -0,0 +1,8 @@ +\inherits AbstractBarSeries + +The following QML shows how to create a simple percent bar chart: +\snippet ../demos/qmlchart/qml/qmlchart/View8.qml 1 +\beginfloatleft +\image demos_qmlchart8.png +\endfloat +\clearfloat diff --git a/doc/src/pieseries.qdocinc b/doc/src/pieseries.qdocinc new file mode 100644 index 0000000..256109e --- /dev/null +++ b/doc/src/pieseries.qdocinc @@ -0,0 +1,10 @@ +\inherits AbstractSeries + +The following QML shows how to create a simple pie chart. + +\snippet ../demos/qmlchart/qml/qmlchart/View1.qml 1 + +\beginfloatleft +\image demos_qmlchart1.png +\endfloat +\clearfloat diff --git a/doc/src/pieslice.qdocinc b/doc/src/pieslice.qdocinc new file mode 100644 index 0000000..556bb38 --- /dev/null +++ b/doc/src/pieslice.qdocinc @@ -0,0 +1,12 @@ +PieSlice defines the properties of a single slice in a PieSeries. The element should be used +as a child for a PieSeries. For example: +\snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 2 + +An alternative (dynamic) method for adding slices to a PieSeries is using PieSeries.append +method. +\snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 4 + +In that case you may want to use PieSeries.at or PieSeries.find to access the properties of +an individual PieSlice instance. +\snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 5 +\sa PieSeries diff --git a/doc/src/scatterseries.qdocinc b/doc/src/scatterseries.qdocinc new file mode 100644 index 0000000..3b12d67 --- /dev/null +++ b/doc/src/scatterseries.qdocinc @@ -0,0 +1,9 @@ +\inherits XYSeries + +The following QML shows how to create a chart with two simple scatter series: +\snippet ../demos/qmlchart/qml/qmlchart/View5.qml 1 + +\beginfloatleft +\image demos_qmlchart5.png +\endfloat +\clearfloat diff --git a/doc/src/splineseries.qdocinc b/doc/src/splineseries.qdocinc new file mode 100644 index 0000000..38ab438 --- /dev/null +++ b/doc/src/splineseries.qdocinc @@ -0,0 +1,8 @@ +\inherits XYSeries + +The following QML shows how to create a simple spline chart: +\snippet ../demos/qmlchart/qml/qmlchart/View3.qml 1 +\beginfloatleft +\image demos_qmlchart3.png +\endfloat +\clearfloat diff --git a/doc/src/stackedbarseries.qdocinc b/doc/src/stackedbarseries.qdocinc new file mode 100644 index 0000000..8d94d3d --- /dev/null +++ b/doc/src/stackedbarseries.qdocinc @@ -0,0 +1,8 @@ +\inherits AbstractBarSeries + +The following QML shows how to create a simple stacked bar chart: +\snippet ../demos/qmlchart/qml/qmlchart/View7.qml 1 +\beginfloatleft +\image demos_qmlchart7.png +\endfloat +\clearfloat diff --git a/doc/src/valueaxis.qdocinc b/doc/src/valueaxis.qdocinc new file mode 100644 index 0000000..8b21e7a --- /dev/null +++ b/doc/src/valueaxis.qdocinc @@ -0,0 +1,17 @@ +\inherits AbstractAxis +\brief The ValueAxis element is used for manipulating chart's axes + +ValueAxis can be setup to show axis line with tick marks, grid lines and shades. +Values of axis are drawn to position of ticks + +Example about using ValueAxis: +\code + ChartView { + ValueAxis { + id: xAxis + min: 0 + max: 10 + } + // Add a few series... + } +\endcode diff --git a/doc/src/vbarmodelmapper.qdocinc b/doc/src/vbarmodelmapper.qdocinc new file mode 100644 index 0000000..b6c4b6d --- /dev/null +++ b/doc/src/vbarmodelmapper.qdocinc @@ -0,0 +1,19 @@ +\inherits BarModelMapper + +VBarModelMapper allows you to use your own QAbstractItemModel derived model with data in columns as a data source +for any bar series. It is possible to use both QAbstractItemModel and bar series data API to manipulate data. +VBarModelMapper keeps the series and the model in sync. + +The following QML example would create a bar series with three bar sets (assuming the +model has at least four columns). Each bar set would contain data starting from row 1. The name of a set would be +defined by the horizontal header (of the column). +\code + BarSeries { + VBarModelMapper { + model: myCustomModel // QAbstractItemModel derived implementation + firstBarSetColumn: 1 + lastBarSetColumn: 3 + firstRow: 1 + } + } +\endcode diff --git a/doc/src/vboxplotmodelmapper.qdocinc b/doc/src/vboxplotmodelmapper.qdocinc new file mode 100644 index 0000000..1f61117 --- /dev/null +++ b/doc/src/vboxplotmodelmapper.qdocinc @@ -0,0 +1,18 @@ +VBoxPlotModelMapper allows you to use your own QAbstractItemModel derived model with data in columns as a data source +for any box-and-whiskers series. It is possible to use both QAbstractItemModel and box-and-whiskers series data API to +manipulate data. +VBoxPlotModelMapper keeps the series and the model in sync. + +The following QML example would create a box-and-whiskers series with three box sets (assuming the +model has at least four columns). Each box set would contain data starting from row 1. The name of a set would be +defined by the horizontal header (of the column). +\code + BoxPlotSeries { + VBoxPlotModelMapper { + model: myCustomModel // QAbstractItemModel derived implementation + firstBoxSetColumn: 1 + lastBoxSetColumn: 3 + firstRow: 1 + } + } +\endcode diff --git a/doc/src/vpiemodelmapper.qdocinc b/doc/src/vpiemodelmapper.qdocinc new file mode 100644 index 0000000..b669a1c --- /dev/null +++ b/doc/src/vpiemodelmapper.qdocinc @@ -0,0 +1,16 @@ +VPieModelMapper allows you to use your own QAbstractItemModel derived model with data in columns as a data source +for a pie series. It is possible to use both QAbstractItemModel and PieSeries data API to manipulate data. +VPieModelMapper keeps the Pie and the model in sync. + +The following QML example would create a pie series with four slices (assuming the model has at least five rows). +Each slice would contain a label from column 1 and a value from column 2. +\code + VPieModelMapper { + series: pieSeries + model: customModel + labelsColumn: 1 + valuesColumn: 2 + firstRow: 1 + rowCount: 4 + } +\endcode diff --git a/doc/src/vxymodelmapper.qdocinc b/doc/src/vxymodelmapper.qdocinc new file mode 100644 index 0000000..403f8d5 --- /dev/null +++ b/doc/src/vxymodelmapper.qdocinc @@ -0,0 +1,3 @@ +VXYModelMapper allows you to use your own QAbstractItemModel derived model with data in columns as a data source +for XYSeries based series. It is possible to use both QAbstractItemModel and XYSeries data API to manipulate data. +VXYModelMapper keeps the series and the model in sync. diff --git a/doc/src/xyseries.qdocinc b/doc/src/xyseries.qdocinc new file mode 100644 index 0000000..64f4baa --- /dev/null +++ b/doc/src/xyseries.qdocinc @@ -0,0 +1,4 @@ +\inherits AbstractSeries + +The XYSeries class is a base class for line, spline and scatter series. +The class cannot be instantiated directly. diff --git a/doc/src/demos.qdoc b/doc/src_qt4/demos.qdoc similarity index 100% rename from doc/src/demos.qdoc rename to doc/src_qt4/demos.qdoc diff --git a/doc/src/examples.qdoc b/doc/src_qt4/examples.qdoc similarity index 100% rename from doc/src/examples.qdoc rename to doc/src_qt4/examples.qdoc diff --git a/doc/src/index.qdoc b/doc/src_qt4/index.qdoc similarity index 100% rename from doc/src/index.qdoc rename to doc/src_qt4/index.qdoc diff --git a/doc/src/qml.qdoc b/doc/src_qt4/qml.qdoc similarity index 96% rename from doc/src/qml.qdoc rename to doc/src_qt4/qml.qdoc index 8bc9046..68ab1d7 100644 --- a/doc/src/qml.qdoc +++ b/doc/src_qt4/qml.qdoc @@ -8,14 +8,14 @@ \table \row - \o \br + \li \br Use the following QML to create a simple pie chart: \br \br \snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 1 \snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 2 \snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 3 - \o \inlineimage examples_qmlpiechart.png + \li \inlineimage examples_qmlpiechart.png \endtable \note Since Qt Charts utilizes Qt Graphics View Framework for drawing, it works best @@ -38,7 +38,7 @@
  • PolarChartView
  • AbstractAxis
  • ValueAxis
    • -
  • LogValueAxis
    • +
  • LogValueAxis
  • CategoryAxis
  • CategoryRange
  • BarCategoryAxis
    • @@ -99,6 +99,7 @@
  • BoxSet
  • HBarModelMapper
  • VBarModelMapper
    • +
  • VBoxPlotModelMapper
    • diff --git a/doc/src_qt5/demos.qdoc b/doc/src_qt5/demos.qdoc new file mode 100644 index 0000000..021b8c0 --- /dev/null +++ b/doc/src_qt5/demos.qdoc @@ -0,0 +1,78 @@ +/*! + \page demos.html + \title Qt Charts Demos + \keyword Demos + + \raw HTML +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    AudioCallout
    AudioCallout
    Chart ThemesDynamic Spline Chart
    Chart ThemesDynamic Spline
    Nested Donuts ChartPie Chart Customization
    Nested Donuts ChartPie Chart Customization
    Qml Basic ChartsQml Axes
    Qml Basic ChartsQml Axes
    Qml CustomizationsQml Custom Legend
    Qml CustomizationsQml Custom Legend
    Qml F1 LegendsQml Oscilloscope
    Qml F1 LegendsQml Oscilloscope
    Qml WeatherQml Polar Chart
    Qml WeatherQml Polar Chart
    Qt Quick 2 Basic ChartsQt Quick 2 Oscilloscope
    Qt Quick 2 Basic ChartsQt Quick 2 Oscilloscope
    +
    + \endraw + +*/ diff --git a/doc/src_qt5/examples.qdoc b/doc/src_qt5/examples.qdoc new file mode 100644 index 0000000..f735818 --- /dev/null +++ b/doc/src_qt5/examples.qdoc @@ -0,0 +1,147 @@ +/*! + \page examples.html + \title Qt Charts Examples + \keyword Examples + + \raw HTML +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Area ChartBar Chart
    Area ChartBar Chart
    Bar Chart from ModelBox-and-whiskers Chart
    Bar Chart from ModelBar Chart from Model
    Custom ChartDateTimeAxis Example
    Custom ChartDateTimeAxis Example
    Donut Breakdown ChartDonut Chart
    Donut Breakdown ChartDonut Chart
    Horizontal Bar ChartHorizontal Percent Bar Chart
    Horizontal Bar ChartHorizontal Percent Bar Chart
    Horizontal Stacked Bar ChartLegend
    Horizontal Stacked Bar ChartLegend
    Legend MarkersLine and Barchart
    Legend MarkersLine and Barchart
    Line ChartLogarithmic axis
    Line ChartLogarythmix axis
    Model DataMultiple axes
    Model DataMultiple axes
    Percent Bar ChartPie Chart
    Percent Bar ChartPie Chart
    Pie Chart DrilldownPolar chart
    Pie Chart DrilldownPolar chart
    Scatter chartScatter Interactions
    Scatter chartScatter Interactions
    Spline ChartStacked Bar Chart
    Spline ChartStacked Bar Chart
    Stacked Bar Chart DrilldownTemperature Records
    Stacked Bar Chart DrilldownTemperature Records
    Zoom Line
    Zoom Line
    +
    + \endraw + +*/ diff --git a/doc/src_qt5/index.qdoc b/doc/src_qt5/index.qdoc new file mode 100644 index 0000000..a34e577 --- /dev/null +++ b/doc/src_qt5/index.qdoc @@ -0,0 +1,43 @@ +/*! + \page index.html + \keyword About + + \raw HTML +
    + qt-logo + +

    + 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. +

    +

    + Below are a few basic examples of the different chart types. You can find more applications + from the Examples and Demo sections of the documentation. +

    + + + + + + + + + + + + + + + + + + + + +
    linechartareachart
    scatterchartbarchart
    horizontalbarchartpiechart
    linechartcustomerchart
    +
    + \endraw +*/ diff --git a/doc/src_qt5/qml.qdoc b/doc/src_qt5/qml.qdoc new file mode 100644 index 0000000..850e963 --- /dev/null +++ b/doc/src_qt5/qml.qdoc @@ -0,0 +1,108 @@ +/*! + \page qml.html + \title Qt Charts QML API + \keyword Charts QML API + + The Qt Charts QML API is an intuitive and simple way to show charts in your QML + applications. + + \table + \row + \li \br + Use the following QML to create a simple pie chart: + \br + \br + \snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 1 + \snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 2 + \snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 3 + \li \inlineimage examples_qmlpiechart.png + \endtable + + \note Since Qt Charts utilizes Qt Graphics View Framework for drawing, it works best + with Qt Quick 1, which is based on the same framework. + As of release 1.3.0, Qt Charts is also usable with Qt Quick 2, though the performance + is slightly worse than with Qt Quick 1 due to the additional rendering step that is required. + + \note Qt Quick 1 is supported from Qt 4.7.4 onwards because of the missing + Q_REVISION macro in the earlier Qt releases. Qt Quick 2 is supported with only Qt 5. + + \raw HTML + + + + + + + +
    ChartView and it's properties
    + +
    + + + + + + + +
    XY chart
    + +
    + + + + + + +
    Pie chart
    + +
    + + + + + + +
    Bar chart
    + +
    + \endraw +*/ diff --git a/doc/src_qt5/qmlmodule.qdoc b/doc/src_qt5/qmlmodule.qdoc new file mode 100644 index 0000000..e8476c1 --- /dev/null +++ b/doc/src_qt5/qmlmodule.qdoc @@ -0,0 +1,3 @@ +/*! + \qmlmodule QtCommercial.Chart 1.3 +*/ diff --git a/plugins/declarative/declarativeboxplotseries.cpp b/plugins/declarative/declarativeboxplotseries.cpp index 33973f8..42cd639 100644 --- a/plugins/declarative/declarativeboxplotseries.cpp +++ b/plugins/declarative/declarativeboxplotseries.cpp @@ -25,16 +25,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE +#ifdef QDOC_QT5 +/*! + \qmltype BoxSet + \instantiates QBoxSet + \inqmlmodule QtCommercial.Chart + + \include /doc/src/declarativeboxset.qdocinc +*/ +#else /*! \qmlclass BoxSet QBoxSet - BoxSet represents one box-and-whiskers item. It takes five values to create a graphical representation - of range and three medians. There are two ways to give the values. The first one is with constructor - or with append method. In these the values have to be given in the following order: lower extreme, lower quartile, median, - upper quartile and upper extreme. The second method is to create an empty QBoxSet instance and give the values using - value specific methods. - \sa BoxPlotSeries + \include ../doc/src/declarativeboxset.qdocinc */ +#endif /*! \qmlproperty string BoxSet::values The values on the box-and-whiskers set. @@ -95,43 +100,22 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE */ +#ifdef QDOC_QT5 /*! - \qmlclass BoxPlotSeries QBoxPlotSeries - \inherits QAbstractSeries - - BoxPlotSeries represents a series of data shown as box-and-whiskers bars. The purpose of this class is to act as - a container for single box-and-whiskers items. Each item is drawn to own slot. If chart includes multiple instances of - BoxPlotSeries then box-and-whiskers items with the same index are drawn to same slot. - - The following QML shows how to create a simple box-and-whiskers chart: - \code - import QtQuick 1.0 - import QtCommercial.Chart 1.3 - - ChartView { - title: "Box Plot series" - width: 400 - height: 300 - theme: ChartView.ChartThemeBrownSand - legend.alignment: Qt.AlignBottom + \qmltype BoxPlotSeries + \instantiates QBoxPlotSeries + \inqmlmodule QtCommercial.Chart - BoxPlotSeries { - id: plotSeries - name: "Income" - BoxSet { label: "Jan"; values: [3, 4, 5.1, 6.2, 8.5] } - BoxSet { label: "Feb"; values: [5, 6, 7.5, 8.6, 11.8] } - BoxSet { label: "Mar"; values: [3.2, 5, 5.7, 8, 9.2] } - BoxSet { label: "Apr"; values: [3.8, 5, 6.4, 7, 8] } - BoxSet { label: "May"; values: [4, 5, 5.2, 6, 7] } - } - } - \endcode + \include /doc/src/declarativeboxplotseries.qdocinc +*/ +#else +/*! + \qmlclass BoxPlotSeries QBoxPlotSeries - \beginfloatleft - \image examples_qmlboxplot.png - \endfloat - \clearfloat + \include ../doc/src/declarativeboxplotseries.qdocinc */ +#endif + /*! \qmlmethod BoxPlotSeries::append(string label, VariantList values) Appends a new box-and-whiskers set with \a label and \a values to the series. diff --git a/plugins/declarative/declarativecategoryaxis.cpp b/plugins/declarative/declarativecategoryaxis.cpp index bb2aad9..dad88cc 100644 --- a/plugins/declarative/declarativecategoryaxis.cpp +++ b/plugins/declarative/declarativecategoryaxis.cpp @@ -23,11 +23,20 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE +#ifdef QDOC_QT5 +/*! + \qmltype CategoryRange + \inqmlmodule QtCommercial.Chart + + \include /doc/src/categoryrange.qdocinc +*/ +#else /*! \qmlclass CategoryRange - \brief With CategoryRange you can define a range used by a CategoryAxis. - \sa CategoryAxis + + \include ../doc/src/categoryrange.qdocinc */ +#endif DeclarativeCategoryRange::DeclarativeCategoryRange(QObject *parent) : QObject(parent), diff --git a/plugins/declarative/declarativechart.cpp b/plugins/declarative/declarativechart.cpp index 005fd66..8364f0e 100644 --- a/plugins/declarative/declarativechart.cpp +++ b/plugins/declarative/declarativechart.cpp @@ -52,21 +52,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE +#ifdef QDOC_QT5 /*! - \qmlclass ChartView DeclarativeChart - - ChartView element is the parent that is responsible for showing different chart series types. + \qmltype ChartView + \instantiates DeclarativeChart + \inqmlmodule QtCommercial.Chart - The following QML shows how to create a simple chart with one pie series: - \snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 1 - \snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 2 - \snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 3 + \include /doc/src/chartview.qdocinc +*/ +#else +/*! + \qmlclass ChartView DeclarativeChart - \beginfloatleft - \image examples_qmlpiechart.png - \endfloat - \clearfloat + \include ../doc/src/chartview.qdocinc */ +#endif /*! \qmlproperty Theme ChartView::theme @@ -82,9 +82,9 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \qmlproperty Font ChartView::titleFont - The title font of the chart + The title font of the chart. - See the \l {Font} {QML Font Element} for detailed documentation. + See the Qt documentation for more details of Font. */ /*! diff --git a/plugins/declarative/declarativemargins.cpp b/plugins/declarative/declarativemargins.cpp index b9cc4b0..35fc9e8 100644 --- a/plugins/declarative/declarativemargins.cpp +++ b/plugins/declarative/declarativemargins.cpp @@ -24,10 +24,20 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE +#ifdef QDOC_QT5 +/*! + \qmltype Margins + \inqmlmodule QtCommercial.Chart + + \include /doc/src/margins.qdocinc +*/ +#else /*! \qmlclass Margins - Uncreatable type that is used to define top, bottom, left and right margins. + + \include ../doc/src/margins.qdocinc */ +#endif /*! \qmlproperty int Margins::top diff --git a/plugins/declarative/declarativepolarchart.cpp b/plugins/declarative/declarativepolarchart.cpp index 1fd0c5c..86bd2a1 100644 --- a/plugins/declarative/declarativepolarchart.cpp +++ b/plugins/declarative/declarativepolarchart.cpp @@ -23,30 +23,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE +#ifdef QDOC_QT5 /*! - \qmlclass PolarChartView DeclarativePolarChart - - PolarChartView element is the parent that is responsible for showing different chart series types - in a polar chart. - - Polar charts support line, spline, area, and scatter series, and all axis types - supported by those series. - - \note When setting ticks to an angular ValueAxis, keep in mind that the first and last tick - are co-located at 0/360 degree angle. + \qmltype PolarChartView + \instantiates DeclarativePolarChart + \inqmlmodule QtCommercial.Chart - \note If the angular distance between two consecutive points in a series is more than 180 degrees, - any line connecting the two points becomes meaningless, so choose the axis ranges accordingly - when displaying line, spline, or area series. - - The following QML shows how to create a polar chart with two series: - \snippet ../demos/qmlpolarchart/qml/qmlpolarchart/View1.qml 1 + \include /doc/src/declarativepolarchart.qdocinc +*/ +#else +/*! + \qmlclass PolarChartView DeclarativePolarChart - \beginfloatleft - \image demos_qmlpolarchart1.png - \endfloat - \clearfloat + \include ../doc/src/declarativepolarchart.qdocinc */ +#endif DeclarativePolarChart::DeclarativePolarChart(QDECLARATIVE_ITEM *parent) : DeclarativeChart(QChart::ChartTypePolar, parent) diff --git a/plugins/declarative/declarativexypoint.cpp b/plugins/declarative/declarativexypoint.cpp index d7020f2..d4f96a4 100644 --- a/plugins/declarative/declarativexypoint.cpp +++ b/plugins/declarative/declarativexypoint.cpp @@ -23,12 +23,20 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE +#ifdef QDOC_QT5 +/*! + \qmltype XYPoint + \inqmlmodule QtCommercial.Chart + + \include /doc/src/declarativexypoint.qdocinc +*/ +#else /*! \qmlclass XYPoint QPointF - XYPoint is a convenience element for initializing XY-series with static coordinate data. To - manipulate an XY-series dynamically, use it's data manipulation functions instead. - \sa LineSeries, AreaSeries, ScatterSeries, SplineSeries + + \include ../doc/src/declarativexypoint.qdocinc */ +#endif /*! \qmlproperty real XYPoint::x diff --git a/plugins/declarative/font.qdoc b/plugins/declarative/font.qdoc deleted file mode 100644 index 09728d9..0000000 --- a/plugins/declarative/font.qdoc +++ /dev/null @@ -1,114 +0,0 @@ -/*! - \qmlclass Font QFont - \brief Defines the font used for drawing text. - - Font instantiates the C++ class QFont -*/ - -// NOTE: This is a copy-paste from: -// \src\declarative\graphicsitems\qdeclarativetext.cpp - -/*! - \qmlproperty string Font::family - - Sets the family name of the font. - - The family name is case insensitive and may optionally include a foundry name, e.g. "Helvetica [Cronyx]". - If the family is available from more than one foundry, and the foundry isn't specified, an arbitrary foundry is chosen. - If the family isn't available, a family will be set using the font matching algorithm. -*/ - -/*! - \qmlproperty bool Font::bold - - Sets whether the font weight is bold. -*/ - -/*! - \qmlproperty enumeration Font::weight - - Sets the font's weight. - - The weight can be one of: - \list - \o Font.Light - \o Font.Normal - the default - \o Font.DemiBold - \o Font.Bold - \o Font.Black - \endlist - - \qml - Text { text: "Hello"; font.weight: Font.DemiBold } - \endqml -*/ - -/*! - \qmlproperty bool Font::italic - - Sets on or off the italic style property. -*/ - -/*! - \qmlproperty bool Font::underline - - Sets on or off the underlined property. -*/ - -/*! - \qmlproperty bool Font::strikeout - - Sets on or off the strikeout style. -*/ - -/*! - \qmlproperty real Font::pointSize - - Sets the font size in points. The point size must be greater than zero. -*/ - -/*! - \qmlproperty int Font::pixelSize - - Sets the font size in pixels. - - Using this function makes the font device dependent. - Use \c pointSize to set the size of the font in a device independent manner. -*/ - -/*! - \qmlproperty real Font::letterSpacing - - Sets the letter spacing for the font. - - Letter spacing changes the default spacing between individual letters in the font. - A positive value increases the letter spacing by the corresponding pixels; a negative value decreases the spacing. -*/ - -/*! - \qmlproperty real Font::wordSpacing - - Sets the word spacing for the font. - - Word spacing changes the default spacing between individual words. - A positive value increases the word spacing by a corresponding amount of pixels, - while a negative value decreases the inter-word spacing accordingly. -*/ - -/*! - \qmlproperty enumeration Font::capitalization - - Sets the capitalization for the text. - - \list - \o Font.MixedCase - This is the normal text rendering option where no capitalization change is applied. - \o Font.AllUppercase - Changes the text to uppercasse. - \o Font.AllLowercase - Changes the text to lowercase. - \o Font.SmallCaps - Renders the text small-caps type. - \o Font.Capitalize - This alters the text to be rendered with the first character of each word as an uppercase character. - \endlist - - \qml - Text { text: "Hello"; font.capitalization: Font.AllLowercase } - \endqml -*/ diff --git a/src/areachart/qareaseries.cpp b/src/areachart/qareaseries.cpp index e0be044..c1a05f1 100644 --- a/src/areachart/qareaseries.cpp +++ b/src/areachart/qareaseries.cpp @@ -33,6 +33,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QAreaSeries + \inmodule Qt Charts \brief The QAreaSeries class is used for making area charts. \mainclass @@ -46,16 +47,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE See the \l {AreaChart Example} {area chart example} to learn how to create a simple area chart. \image examples_areachart.png */ +#ifdef QDOC_QT5 +/*! + \qmltype AreaSeries + \instantiates QAreaSeries + \inqmlmodule QtCommercial.Chart + + \include /doc/src/areaseries.qdocinc +*/ +#else /*! \qmlclass AreaSeries QAreaSeries - The following QML shows how to create a simple area chart: - \snippet ../demos/qmlchart/qml/qmlchart/View4.qml 1 - \beginfloatleft - \image demos_qmlchart4.png - \endfloat - \clearfloat + \include ../doc/src/areaseries.qdocinc */ +#endif /*! \property QAreaSeries::upperSeries diff --git a/src/axis/barcategoryaxis/qbarcategoryaxis.cpp b/src/axis/barcategoryaxis/qbarcategoryaxis.cpp index ec67853..364741f 100644 --- a/src/axis/barcategoryaxis/qbarcategoryaxis.cpp +++ b/src/axis/barcategoryaxis/qbarcategoryaxis.cpp @@ -29,6 +29,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QBarCategoryAxis + \inmodule Qt Charts \brief The QBarCategoryAxis class is used for manipulating chart's axis. \mainclass @@ -53,25 +54,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \endcode */ +#ifdef QDOC_QT5 /*! - \qmlclass BarCategoryAxis QBarCategoryAxis - \inherits AbstractAxis - \brief The Axis element is used for manipulating chart's axes. + \qmltype BarCategoryAxis + \instantiates QBarCategoryAxis + \inqmlmodule QtCommercial.Chart - Axis can be setup to show axis line with tick marks, grid lines and shades. - Categories are drawn between ticks. Note that you can use this also with lineseries too. + \include /doc/src/barcategoryaxis.qdocinc +*/ +#else +/*! + \qmlclass BarCategoryAxis QBarCategoryAxis - To access BarCategoryAxis you can use ChartView API. For example: - \code - ChartView { - BarCategoryAxis { - id: categoryAxis - categories: ["Jan", "Feb", "Mar", "Apr", "May", "Jun" ] - } - // Add a few series... - } - \endcode + \include ../doc/src/barcategoryaxis.qdocinc */ +#endif /*! \property QBarCategoryAxis::categories diff --git a/src/axis/categoryaxis/qcategoryaxis.cpp b/src/axis/categoryaxis/qcategoryaxis.cpp index 4921727..8c84831 100644 --- a/src/axis/categoryaxis/qcategoryaxis.cpp +++ b/src/axis/categoryaxis/qcategoryaxis.cpp @@ -31,6 +31,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QCategoryAxis + \inmodule Qt Charts \brief The QCategoryAxis class allows putting a named ranges on the axis. \mainclass @@ -40,7 +41,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Example code on how to use QCategoryAxis: \table \row - \o \br + \li \br \br \code QChartView *chartView = new QChartView; @@ -57,25 +58,25 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE axisY->append("Third", 52); chartView->chart()->setAxisY(axisY, series); \endcode - \o \br + \li \br \inlineimage api_category_axis.png \endtable */ +#ifdef QDOC_QT5 +/*! + \qmltype CategoryAxis + \instantiates QCategoryAxis + \inqmlmodule QtCommercial.Chart + + \include /doc/src/categoryaxis.qdocinc +*/ +#else /*! \qmlclass CategoryAxis QCategoryAxis - \inherits AbstractAxis - \brief CategoryAxis allows putting a named ranges on the axis. - For example: - \table - \row - \o \br - \br - \br - \snippet ../demos/qmlaxes/qml/qmlaxes/View3.qml 1 - \o \inlineimage demos_qmlaxes3.png - \endtable + \include ../doc/src/categoryaxis.qdocinc */ +#endif /*! \property QCategoryAxis::startValue diff --git a/src/axis/datetimeaxis/qdatetimeaxis.cpp b/src/axis/datetimeaxis/qdatetimeaxis.cpp index aed6981..3947344 100644 --- a/src/axis/datetimeaxis/qdatetimeaxis.cpp +++ b/src/axis/datetimeaxis/qdatetimeaxis.cpp @@ -32,6 +32,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QDateTimeAxis + \inmodule Qt Charts \brief The QDateTimeAxis class is used for manipulating chart's axis. \mainclass @@ -73,15 +74,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \endcode */ +#ifdef QDOC_QT5 +/*! + \qmltype DateTimeAxis + \instantiates QDateTimeAxis + \inqmlmodule QtCommercial.Chart + + \include /doc/src/datetimeaxis.qdocinc +*/ +#else /*! \qmlclass DateTimeAxis QDateTimeAxis - \brief The DateTimeAxis element is used for manipulating chart's axes. - \inherits AbstractAxis - The labels can be configured by setting an appropriate DateTime format. - Note that any date before 4714 BCE or after about 1.4 million CE may not be accurately stored. - DateTimeAxis can be setup to show axis line with tick marks, grid lines and shades. + \include ../doc/src/datetimeaxis.qdocinc */ +#endif /*! \property QDateTimeAxis::min diff --git a/src/axis/logvalueaxis/qlogvalueaxis.cpp b/src/axis/logvalueaxis/qlogvalueaxis.cpp index c4f56b7..683f44f 100644 --- a/src/axis/logvalueaxis/qlogvalueaxis.cpp +++ b/src/axis/logvalueaxis/qlogvalueaxis.cpp @@ -31,6 +31,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QLogValueAxis + \inmodule Qt Charts \brief The QLogValueAxis class is used for manipulating chart's axis. \mainclass @@ -40,16 +41,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE since empty cells in models typically contain zero values. */ +#ifdef QDOC_QT5 +/*! + \qmltype LogValueAxis + \instantiates QLogValueAxis + \inqmlmodule QtCommercial.Chart + + \include /doc/src/logvalueaxis.qdocinc +*/ +#else /*! \qmlclass LogValueAxis QLogValueAxis - \brief The LogValueAxis element is used for manipulating chart's axes. - \inherits AbstractAxis - \note If a LogValueAxis is attached to a series with one or more points with - negative or zero values on the associated dimension, the series will not be - plotted at all. This is particularly relevant when XYModelMappers are used, - since empty cells in models typically contain zero values. + \include ../doc/src/logvalueaxis.qdocinc */ +#endif /*! \property QLogValueAxis::min diff --git a/src/axis/qabstractaxis.cpp b/src/axis/qabstractaxis.cpp index e45de77..fd0c733 100644 --- a/src/axis/qabstractaxis.cpp +++ b/src/axis/qabstractaxis.cpp @@ -28,6 +28,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QAbstractAxis + \inmodule Qt Charts \brief The QAbstractAxis class is used for manipulating chart's axis. \mainclass @@ -38,16 +39,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Properties and visibility of various axis elements such as axis line, title, labels, grid lines, and shades can be individually controlled. */ +#ifdef QDOC_QT5 +/*! + \qmltype AbstractAxis + \instantiates QAbstractAxis + \inqmlmodule QtCommercial.Chart + \include /doc/src/abstractaxis.qdocinc +*/ +#else /*! \qmlclass AbstractAxis QAbstractAxis - \brief The AbstractAxis is a base element used for specialized axis elements. - - Each series can be bound to only one horizontal and vertical axis. - Properties and visibility of various axis elements such as axis line, title, labels, grid lines, - and shades can be individually controlled. + \include ../doc/src/abstractaxis.qdocinc */ +#endif /*! \enum QAbstractAxis::AxisType @@ -142,7 +148,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \qmlproperty Font AbstractAxis::labelsFont The font of the axis labels. - See the \l {Font} {QML Font Element} for detailed documentation. + See the Qt documentation for more details of Font. */ /*! diff --git a/src/axis/valueaxis/qvalueaxis.cpp b/src/axis/valueaxis/qvalueaxis.cpp index 26583d3..c3d470d 100644 --- a/src/axis/valueaxis/qvalueaxis.cpp +++ b/src/axis/valueaxis/qvalueaxis.cpp @@ -33,6 +33,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QValueAxis + \inmodule Qt Charts \brief The QValueAxis class is used for manipulating chart's axis. \mainclass @@ -53,27 +54,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE chartView->chart()->setAxisX(axisX, series); \endcode */ +#ifdef QDOC_QT5 +/*! + \qmltype ValueAxis + \instantiates QValueAxis + \inqmlmodule QtCommercial.Chart + \include /doc/src/valueaxis.qdocinc +*/ +#else /*! \qmlclass ValueAxis QValueAxis - \inherits AbstractAxis - \brief The ValueAxis element is used for manipulating chart's axes - - ValueAxis can be setup to show axis line with tick marks, grid lines and shades. - Values of axis are drawn to position of ticks - Example about using ValueAxis: - \code - ChartView { - ValueAxis { - id: xAxis - min: 0 - max: 10 - } - // Add a few series... - } - \endcode + \include ../doc/src/valueaxis.qdocinc */ +#endif /*! \property QValueAxis::min diff --git a/src/barchart/horizontal/bar/qhorizontalbarseries.cpp b/src/barchart/horizontal/bar/qhorizontalbarseries.cpp index 982b95b..c67b3ef 100644 --- a/src/barchart/horizontal/bar/qhorizontalbarseries.cpp +++ b/src/barchart/horizontal/bar/qhorizontalbarseries.cpp @@ -31,6 +31,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QHorizontalBarSeries + \inmodule Qt Charts \brief Series for creating horizontal bar chart. \mainclass @@ -43,17 +44,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \sa QBarSet, QBarSeries, QPercentBarSeries, QAbstractBarSeries, QStackedBarSeries, QHorizontalStackedBarSeries, QHorizontalPercentBarSeries */ +#ifdef QDOC_QT5 +/*! + \qmltype HorizontalBarSeries + \instantiates QHorizontalBarSeries + \inqmlmodule QtCommercial.Chart + + \include /doc/src/horizontalbarseries.qdocinc +*/ +#else /*! \qmlclass HorizontalBarSeries QHorizontalBarSeries - \inherits AbstractBarSeries - - The following QML shows how to create a simple horizontal bar chart: - \snippet ../demos/qmlchart/qml/qmlchart/View9.qml 1 - \beginfloatleft - \image demos_qmlchart9.png - \endfloat - \clearfloat + + \include ../doc/src/horizontalbarseries.qdocinc */ +#endif /*! Constructs empty QHorizontalBarSeries. diff --git a/src/barchart/horizontal/percent/qhorizontalpercentbarseries.cpp b/src/barchart/horizontal/percent/qhorizontalpercentbarseries.cpp index 749de8d..624e627 100644 --- a/src/barchart/horizontal/percent/qhorizontalpercentbarseries.cpp +++ b/src/barchart/horizontal/percent/qhorizontalpercentbarseries.cpp @@ -28,6 +28,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QHorizontalPercentBarSeries + \inmodule Qt Charts \brief Series for creating horizontal percent bar chart. \mainclass @@ -40,17 +41,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \sa QBarSet, QBarSeries, QPercentBarSeries, QAbstractBarSeries, QStackedBarSeries, QHorizontalStackedBarSeries, QHorizontalBarSeries */ +#ifdef QDOC_QT5 +/*! + \qmltype HorizontalPercentBarSeries + \instantiates QHorizontalPercentBarSeries + \inqmlmodule QtCommercial.Chart + + \include /doc/src/horizontalpercentbarseries.qdocinc +*/ +#else /*! \qmlclass HorizontalPercentBarSeries QHorizontalPercentBarSeries - \inherits QAbstractBarSeries - - The following QML shows how to create a simple horizontal percent bar chart: - \snippet ../demos/qmlchart/qml/qmlchart/View11.qml 1 - \beginfloatleft - \image demos_qmlchart11.png - \endfloat - \clearfloat + + \include ../doc/src/horizontalpercentbarseries.qdocinc */ +#endif /*! Constructs empty QHorizontalPercentBarSeries. diff --git a/src/barchart/horizontal/stacked/qhorizontalstackedbarseries.cpp b/src/barchart/horizontal/stacked/qhorizontalstackedbarseries.cpp index 312d447..102a9cb 100644 --- a/src/barchart/horizontal/stacked/qhorizontalstackedbarseries.cpp +++ b/src/barchart/horizontal/stacked/qhorizontalstackedbarseries.cpp @@ -27,6 +27,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QHorizontalStackedBarSeries + \inmodule Qt Charts \brief Series for creating horizontal stacked bar chart. \mainclass @@ -39,17 +40,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \sa QBarSet, QBarSeries, QPercentBarSeries, QAbstractBarSeries, QStackedBarSeries, QHorizontalPercentBarSeries, QHorizontalBarSeries */ +#ifdef QDOC_QT5 +/*! + \qmltype HorizontalStackedBarSeries + \instantiates QHorizontalStackedBarSeries + \inqmlmodule QtCommercial.Chart + + \include /doc/src/horizontalstackedbarseries.qdocinc +*/ +#else /*! \qmlclass HorizontalStackedBarSeries QHorizontalStackedBarSeries - \inherits QAbstractBarSeries - - The following QML shows how to create a simple horizontal stacked bar chart: - \snippet ../demos/qmlchart/qml/qmlchart/View10.qml 1 - \beginfloatleft - \image demos_qmlchart10.png - \endfloat - \clearfloat + + \include ../doc/src/horizontalstackedbarseries.qdocinc */ +#endif /*! Constructs empty QHorizontalStackedBarSeries. diff --git a/src/barchart/qabstractbarseries.cpp b/src/barchart/qabstractbarseries.cpp index 1e7a8a5..01d9dbc 100644 --- a/src/barchart/qabstractbarseries.cpp +++ b/src/barchart/qabstractbarseries.cpp @@ -36,6 +36,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QAbstractBarSeries + \inmodule Qt Charts \brief Series for creating a bar chart. \mainclass @@ -49,18 +50,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \sa QBarSet, QStackedBarSeries, QPercentBarSeries */ +#ifdef QDOC_QT5 /*! - \qmlclass AbstractBarSeries QAbstractBarSeries - \inherits QAbstractSeries + \qmltype AbstractBarSeries + \instantiates QAbstractBarSeries + \inqmlmodule QtCommercial.Chart - The following QML shows how to create a simple bar chart: - \snippet ../demos/qmlchart/qml/qmlchart/View6.qml 1 + \include /doc/src/abstractbarseries.qdocinc +*/ +#else +/*! + \qmlclass AbstractBarSeries QAbstractBarSeries - \beginfloatleft - \image demos_qmlchart6.png - \endfloat - \clearfloat + \include ../doc/src/abstractbarseries.qdocinc */ +#endif /*! \qmlproperty AbstractAxis AbstractBarSeries::axisX diff --git a/src/barchart/qbarset.cpp b/src/barchart/qbarset.cpp index 7d208e5..977c07b 100644 --- a/src/barchart/qbarset.cpp +++ b/src/barchart/qbarset.cpp @@ -27,6 +27,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QBarSet + \inmodule Qt Charts \brief Building block for different bar charts. QBarSet represents one set of bars. Set of bars contains one data value for each category. @@ -38,15 +39,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \sa QAbstractBarSeries, QBarSeries, QStackedBarSeries, QPercentBarSeries */ +#ifdef QDOC_QT5 +/*! + \qmltype BarSet + \instantiates QBarSet + \inqmlmodule QtCommercial.Chart + + \include /doc/src/barset.qdocinc +*/ +#else /*! \qmlclass BarSet QBarSet - BarSet represents one set of bars. Set of bars contains one data value for each category. - First value of set is assumed to belong to first category, second to second category and so on. - If set has fewer values than there are categories, then the missing values are assumed to be - at the end of set. For missing values in middle of a set, numerical value of zero is used. - \sa AbstractBarSeries, BarSeries, StackedBarSeries, PercentBarSeries + \include ../doc/src/barset.qdocinc */ +#endif /*! \property QBarSet::label @@ -81,7 +88,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \qmlproperty Font BarSet::labelFont Defines the font used by the bar set's label. - See the \l {Font} {QML Font Element} for detailed documentation. + See the Qt documentation for more details of Font. */ /*! diff --git a/src/barchart/qhbarmodelmapper.cpp b/src/barchart/qhbarmodelmapper.cpp index ccc8d19..7d1cdbb 100644 --- a/src/barchart/qhbarmodelmapper.cpp +++ b/src/barchart/qhbarmodelmapper.cpp @@ -24,6 +24,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QHBarModelMapper + \inmodule Qt Charts \brief Horizontal model mapper for bar series. \mainclass @@ -33,27 +34,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Adding/removing value from the BarSet causes the the same change in the rest of the BarSets added to the same series. \note Used model has to support adding/removing rows/columns and modifying the data of the cells. */ +#ifdef QDOC_QT5 +/*! + \qmltype HBarModelMapper + \instantiates QHBarModelMapper + \inqmlmodule QtCommercial.Chart + + \include /doc/src/hbarmodelmapper.qdocinc +*/ +#else /*! \qmlclass HBarModelMapper QHBarModelMapper - HBarModelMapper allows you to use your own QAbstractItemModel derived model with data in rows as a data source - for any bar series. It is possible to use both QAbstractItemModel and bar series data API to manipulate data. - HBarModelMapper keeps the series and the model in sync. - - The following QML example would create a bar series with three bar sets (assuming the model has - at least four rows). Each bar set would contain data starting from column 1. The name of a set would be defined by - the vertical header (of the row). - \code - BarSeries { - HBarModelMapper { - model: myCustomModel // QAbstractItemModel derived implementation - firstBarSetRow: 1 - lastBarSetRow: 3 - firstColumn: 1 - } - } - \endcode + \include ../doc/src/hbarmodelmapper.qdocinc */ +#endif /*! \property QHBarModelMapper::series diff --git a/src/barchart/qvbarmodelmapper.cpp b/src/barchart/qvbarmodelmapper.cpp index 4cd98ea..43fd61e 100644 --- a/src/barchart/qvbarmodelmapper.cpp +++ b/src/barchart/qvbarmodelmapper.cpp @@ -24,6 +24,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QVBarModelMapper + \inmodule Qt Charts \brief Vertical model mapper for bar series. \mainclass @@ -33,28 +34,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Adding/removing value from the BarSet causes the the same change in the rest of the BarSets added to the same series. \note Used model has to support adding/removing rows/columns and modifying the data of the cells. */ +#ifdef QDOC_QT5 /*! - \qmlclass VBarModelMapper - \mainclass + \qmltype VBarModelMapper + \instantiates QVBarModelMapper + \inqmlmodule QtCommercial.Chart + + \include /doc/src/vbarmodelmapper.qdocinc +*/ +#else +/*! + \qmlclass VBarModelMapper QVBarModelMapper - VBarModelMapper allows you to use your own QAbstractItemModel derived model with data in columns as a data source - for any bar series. It is possible to use both QAbstractItemModel and bar series data API to manipulate data. - VBarModelMapper keeps the series and the model in sync. - - The following QML example would create a bar series with three bar sets (assuming the - model has at least four columns). Each bar set would contain data starting from row 1. The name of a set would be - defined by the horizontal header (of the column). - \code - BarSeries { - VBarModelMapper { - model: myCustomModel // QAbstractItemModel derived implementation - firstBarSetColumn: 1 - lastBarSetColumn: 3 - firstRow: 1 - } - } - \endcode + \include ../doc/src/vbarmodelmapper.qdocinc */ +#endif /*! \property QVBarModelMapper::series diff --git a/src/barchart/vertical/bar/qbarseries.cpp b/src/barchart/vertical/bar/qbarseries.cpp index 4b9a3fd..1b9aef7 100644 --- a/src/barchart/vertical/bar/qbarseries.cpp +++ b/src/barchart/vertical/bar/qbarseries.cpp @@ -30,6 +30,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QBarSeries + \inmodule Qt Charts \brief Series for creating bar chart. \mainclass @@ -42,17 +43,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \sa QBarSet, QPercentBarSeries, QAbstractBarSeries, QStackedBarSeries */ +#ifdef QDOC_QT5 +/*! + \qmltype BarSeries + \instantiates QBarSeries + \inqmlmodule QtCommercial.Chart + + \include /doc/src/barseries.qdocinc +*/ +#else /*! \qmlclass BarSeries QBarSeries - \inherits AbstractBarSeries - - The following QML shows how to create a simple grouped bar chart: - \snippet ../demos/qmlchart/qml/qmlchart/View6.qml 1 - \beginfloatleft - \image demos_qmlchart6.png - \endfloat - \clearfloat + + \include ../doc/src/barseries.qdocinc */ +#endif /*! Constructs empty QBarSeries. diff --git a/src/barchart/vertical/percent/qpercentbarseries.cpp b/src/barchart/vertical/percent/qpercentbarseries.cpp index 382c26d..18aa52c 100644 --- a/src/barchart/vertical/percent/qpercentbarseries.cpp +++ b/src/barchart/vertical/percent/qpercentbarseries.cpp @@ -29,6 +29,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QPercentBarSeries + \inmodule Qt Charts \brief Series for creating percent bar chart. \mainclass @@ -41,17 +42,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \sa QBarSet, QStackedBarSeries, QAbstractBarSeries */ +#ifdef QDOC_QT5 +/*! + \qmltype PercentBarSeries + \instantiates QPercentBarSeries + \inqmlmodule QtCommercial.Chart + + \include /doc/src/persentbarseries.qdocinc +*/ +#else /*! \qmlclass PercentBarSeries QPercentBarSeries - \inherits QAbstractBarSeries - - The following QML shows how to create a simple percent bar chart: - \snippet ../demos/qmlchart/qml/qmlchart/View8.qml 1 - \beginfloatleft - \image demos_qmlchart8.png - \endfloat - \clearfloat + + \include ../doc/src/persentbarseries.qdocinc */ +#endif /*! Constructs empty QPercentBarSeries. diff --git a/src/barchart/vertical/stacked/qstackedbarseries.cpp b/src/barchart/vertical/stacked/qstackedbarseries.cpp index b36699b..a5a16ea 100644 --- a/src/barchart/vertical/stacked/qstackedbarseries.cpp +++ b/src/barchart/vertical/stacked/qstackedbarseries.cpp @@ -29,6 +29,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QStackedBarSeries + \inmodule Qt Charts \brief Series for creating stacked bar chart. \mainclass @@ -42,17 +43,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \sa QBarSet, QPercentBarSeries, QAbstractBarSeries */ +#ifdef QDOC_QT5 +/*! + \qmltype StackedBarSeries + \instantiates QStackedBarSeries + \inqmlmodule QtCommercial.Chart + + \include /doc/src/stackedbarseries.qdocinc +*/ +#else /*! \qmlclass StackedBarSeries QStackedBarSeries - \inherits AbstractBarSeries - - The following QML shows how to create a simple stacked bar chart: - \snippet ../demos/qmlchart/qml/qmlchart/View7.qml 1 - \beginfloatleft - \image demos_qmlchart7.png - \endfloat - \clearfloat + + \include ../doc/src/stackedbarseries.qdocinc */ +#endif /*! Constructs empty QStackedBarSeries. diff --git a/src/boxplotchart/qboxplotseries.cpp b/src/boxplotchart/qboxplotseries.cpp index 22a3eb7..0ae3065 100644 --- a/src/boxplotchart/qboxplotseries.cpp +++ b/src/boxplotchart/qboxplotseries.cpp @@ -36,6 +36,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QBoxPlotSeries + \inmodule Qt Charts \brief Series for creating box-and-whiskers chart \mainclass diff --git a/src/boxplotchart/qboxset.cpp b/src/boxplotchart/qboxset.cpp index 9ce6d5c..45af714 100644 --- a/src/boxplotchart/qboxset.cpp +++ b/src/boxplotchart/qboxset.cpp @@ -26,6 +26,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QBoxSet + \inmodule Qt Charts \brief Building block for box-and-whiskers chart QBoxSet represents one box-and-whiskers item. It takes five values to create a graphical representation diff --git a/src/boxplotchart/qvboxplotmodelmapper.cpp b/src/boxplotchart/qvboxplotmodelmapper.cpp index 036537e..469f827 100644 --- a/src/boxplotchart/qvboxplotmodelmapper.cpp +++ b/src/boxplotchart/qvboxplotmodelmapper.cpp @@ -24,37 +24,30 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QVBoxPlotModelMapper + \inmodule Qt Charts \brief Vertical model mapper for bar series \mainclass Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series. Vertical model mapper is used to create a connection between QBoxPlotSeries and QAbstractItemModel derived model object. Model mapper maintains equal size of all the QBoxSets. - Note: used model has to support adding/removing rows/columns and modifying the data of the cells. + \note used model has to support adding/removing rows/columns and modifying the data of the cells. */ +#ifdef QDOC_QT5 /*! - \qmlclass VBoxPlotModelMapper - \mainclass + \qmltype VBoxPlotModelMapper + \instantiates QVBoxPlotModelMapper + \inqmlmodule QtCommercial.Chart - VBoxPlotModelMapper allows you to use your own QAbstractItemModel derived model with data in columns as a data source - for any box-and-whiskers series. It is possible to use both QAbstractItemModel and box-and-whiskers series data API to - manipulate data. - VBoxPlotModelMapper keeps the series and the model in sync. + \include /doc/src/vboxplotmodelmapper.qdocinc +*/ +#else +/*! + \qmlclass VBoxPlotModelMapper QVBoxPlotModelMapper - The following QML example would create a box-and-whiskers series with three box sets (assuming the - model has at least four columns). Each box set would contain data starting from row 1. The name of a set would be - defined by the horizontal header (of the column). - \code - BarSeries { - VBarModelMapper { - model: myCustomModel // QAbstractItemModel derived implementation - firstBoxSetColumn: 1 - lastBoxSetColumn: 3 - firstRow: 1 - } - } - \endcode + \include ../doc/src/vboxplotmodelmapper.qdocinc */ +#endif /*! \property QVBoxPlotModelMapper::series @@ -64,7 +57,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE When new series is specified the old series is disconnected (it preserves its data) */ /*! - \qmlproperty AbstractBarSeries VBarModelMapper::series + \qmlproperty AbstractBarSeries VBoxPlotModelMapper::series Defines the AbstractBarSeries based object that is used by the mapper. All the data in the series is discarded when it is set to the mapper. When new series is specified the old series is disconnected (it preserves its data). */ @@ -74,9 +67,9 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \brief Defines the model that is used by the mapper. */ /*! - \qmlproperty SomeModel VBarModelMapper::model + \qmlproperty SomeModel VBoxPlotModelMapper::model The QAbstractItemModel based model that is used by the mapper. You need to implement the model - and expose it to QML. Note: the model has to support adding/removing rows/columns and modifying + and expose it to QML. \note the model has to support adding/removing rows/columns and modifying the data of the cells. */ diff --git a/src/legend/qarealegendmarker.cpp b/src/legend/qarealegendmarker.cpp index 4048c4f..869c032 100644 --- a/src/legend/qarealegendmarker.cpp +++ b/src/legend/qarealegendmarker.cpp @@ -27,12 +27,13 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QAreaLegendMarker + \inmodule Qt Charts \brief QAreaLegendMarker object. \mainclass QAreaLegendMarker is related to QAreaSeries. One QAreaSeries results in one marker. - \sa QLegend QAreaSeries + \sa QLegend, QAreaSeries */ /*! diff --git a/src/legend/qbarlegendmarker.cpp b/src/legend/qbarlegendmarker.cpp index 12dc613..c519d50 100644 --- a/src/legend/qbarlegendmarker.cpp +++ b/src/legend/qbarlegendmarker.cpp @@ -27,12 +27,13 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QBarLegendMarker + \inmodule Qt Charts \brief QBarLegendMarker object. \mainclass QBarLegendMarker is related to QAbstractBarSeries derived classes. With bar series, each marker is related to one QBarSet. - \sa QLegend QAbstractBarSeries QBarSet + \sa QLegend, QAbstractBarSeries, QBarSet */ /*! diff --git a/src/legend/qboxplotlegendmarker.cpp b/src/legend/qboxplotlegendmarker.cpp index 773c435..40bfca7 100644 --- a/src/legend/qboxplotlegendmarker.cpp +++ b/src/legend/qboxplotlegendmarker.cpp @@ -27,12 +27,13 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QBoxPlotLegendMarker + \inmodule Qt Charts \brief QBoxPlotLegendMarker object \mainclass QBoxPlotLegendMarker is related to QBoxPlotSeries classes. - \sa QLegend QBoxPlotSeries + \sa QLegend, QBoxPlotSeries */ /*! diff --git a/src/legend/qlegend.cpp b/src/legend/qlegend.cpp index e5c9549..cbdf05b 100644 --- a/src/legend/qlegend.cpp +++ b/src/legend/qlegend.cpp @@ -38,6 +38,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QLegend + \inmodule Qt Charts \brief Legend object. \mainclass @@ -50,26 +51,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \sa QChart */ +#ifdef QDOC_QT5 /*! - \qmlclass Legend QLegend - \brief Legend is part of Qt Chart QML API. - - Legend is a graphical object, whics displays legend of the chart. Legend state is updated by ChartView, when - series have been changed. Legend is used via ChartView class. For example: - \code - ChartView { - legend.visible: true - legend.alignment: Qt.AlignBottom - // Add a few series... - } - \endcode + \qmltype Legend + \instantiates QLegend + \inqmlmodule QtCommercial.Chart - \image examples_percentbarchart_legend.png + \include /doc/src/legend.qdocinc +*/ +#else +/*! + \qmlclass Legend QLegend - Please note that there is no QML API available for modifying legend markers, unlike in the Qt API of Charts. - The use case of modifying markers can be implemented for example by creating your own custom legend. For an example - on how to do this, see \l {demos/qmlcustomlegend}{Qml Custom Demo} application. + \include ../doc/src/legend.qdocinc */ +#endif /*! \property QLegend::alignment diff --git a/src/legend/qlegendmarker.cpp b/src/legend/qlegendmarker.cpp index 8b464c6..f4a18db 100644 --- a/src/legend/qlegendmarker.cpp +++ b/src/legend/qlegendmarker.cpp @@ -32,6 +32,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QLegendMarker + \inmodule Qt Charts \brief LegendMarker object. \mainclass diff --git a/src/legend/qpielegendmarker.cpp b/src/legend/qpielegendmarker.cpp index b790695..25b4a9b 100644 --- a/src/legend/qpielegendmarker.cpp +++ b/src/legend/qpielegendmarker.cpp @@ -27,12 +27,13 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QPieLegendMarker + \inmodule Qt Charts \brief LegendMarker object. \mainclass QPieLegendMarker is related to QPieSeries. With QPieSeries, each slice of pie is related to one marker in QLegend. - \sa QLegend QPieSeries QPieSlice + \sa QLegend, QPieSeries, QPieSlice */ /*! diff --git a/src/legend/qxylegendmarker.cpp b/src/legend/qxylegendmarker.cpp index 2d81e0b..12c0732 100644 --- a/src/legend/qxylegendmarker.cpp +++ b/src/legend/qxylegendmarker.cpp @@ -27,12 +27,13 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QXYLegendMarker + \inmodule Qt Charts \brief QXYLegendMarker object. \mainclass QXYLegendMarker is related to QXYSeries derived classes. Each marker is related to one series. - \sa QLegend QXYSeries QSplineSeries QScatterSeries QLineSeries + \sa QLegend, QXYSeries, QSplineSeries, QScatterSeries, QLineSeries */ /*! diff --git a/src/linechart/qlineseries.cpp b/src/linechart/qlineseries.cpp index 9d6043d..ef8c3b7 100644 --- a/src/linechart/qlineseries.cpp +++ b/src/linechart/qlineseries.cpp @@ -28,6 +28,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QLineSeries + \inmodule Qt Charts \brief The QLineSeries class is used for making line charts. \mainclass @@ -46,17 +47,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE chart->addSeries(series); \endcode */ +#ifdef QDOC_QT5 +/*! + \qmltype LineSeries + \instantiates QLineSeries + \inqmlmodule QtCommercial.Chart + + \include /doc/src/lineseries.qdocinc +*/ +#else /*! \qmlclass LineSeries QLineSeries - \inherits XYSeries - - The following QML shows how to create a simple line chart: - \snippet ../demos/qmlchart/qml/qmlchart/View2.qml 1 - \beginfloatleft - \image demos_qmlchart2.png - \endfloat - \clearfloat + + \include ../doc/src/lineseries.qdocinc */ +#endif /*! \fn virtual SeriesType QLineSeries::type() const diff --git a/src/piechart/qhpiemodelmapper.cpp b/src/piechart/qhpiemodelmapper.cpp index 9cdb2cf..1cf6558 100644 --- a/src/piechart/qhpiemodelmapper.cpp +++ b/src/piechart/qhpiemodelmapper.cpp @@ -24,6 +24,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QHPieModelMapper + \inmodule Qt Charts \mainclass Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series. @@ -31,26 +32,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE It is possible to use both QAbstractItemModel and QPieSeries model API. QHPieModelMapper makes sure that Pie and the model are kept in sync. \note Used model has to support adding/removing rows/columns and modifying the data of the cells. */ +#ifdef QDOC_QT5 +/*! + \qmltype HPieModelMapper + \instantiates QHPieModelMapper + \inqmlmodule QtCommercial.Chart + + \include /doc/src/hpiemodelmapper.qdocinc +*/ +#else /*! \qmlclass HPieModelMapper QHPieModelMapper - HPieModelMapper allows you to use your own QAbstractItemModel derived model with data in rows as a data source - for a pie series. It is possible to use both QAbstractItemModel and PieSeries data API to manipulate data. - HPieModelMapper keeps the Pie and the model in sync. - - The following QML example would create a pie series with four slices (assuming the model has - at least five columns). Each slice would contain a label from row 1 and a value from row 2. - \code - HPieModelMapper { - series: pieSeries - model: customModel - labelsRow: 1 - valuesRow: 2 - firstColumn: 1 - columnCount: 4 - } - \endcode + \include ../doc/src/hpiemodelmapper.qdocinc */ +#endif /*! \property QHPieModelMapper::series diff --git a/src/piechart/qpieseries.cpp b/src/piechart/qpieseries.cpp index 36711fb..08a17e3 100644 --- a/src/piechart/qpieseries.cpp +++ b/src/piechart/qpieseries.cpp @@ -35,6 +35,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QPieSeries + \inmodule Qt Charts \brief Pie series API for Qt Charts. The pie series defines a pie chart which consists of pie slices which are defined as QPieSlice objects. @@ -51,23 +52,25 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE See the \l {PieChart Example} {pie chart example} or \l {DonutChart Example} {donut chart example} to learn how to use QPieSeries. \table 100% \row - \o \image examples_piechart.png - \o \image examples_donutchart.png + \li \image examples_piechart.png + \li \image examples_donutchart.png \endtable */ +#ifdef QDOC_QT5 /*! - \qmlclass PieSeries QPieSeries - \inherits AbstractSeries - - The following QML shows how to create a simple pie chart. + \qmltype PieSeries + \instantiates QPieSeries + \inqmlmodule QtCommercial.Chart - \snippet ../demos/qmlchart/qml/qmlchart/View1.qml 1 + \include /doc/src/pieseries.qdocinc +*/ +#else +/*! + \qmlclass PieSeries QPieSeries - \beginfloatleft - \image demos_qmlchart1.png - \endfloat - \clearfloat + \include ../doc/src/pieseries.qdocinc */ +#endif /*! \property QPieSeries::horizontalPosition @@ -76,8 +79,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The value is a relative value to the chart rectangle where: \list - \o 0.0 is the absolute left. - \o 1.0 is the absolute right. + \li 0.0 is the absolute left. + \li 1.0 is the absolute right. \endlist Default value is 0.5 (center). \sa verticalPosition @@ -91,8 +94,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The value is a relative value to the chart rectangle where: \list - \o 0.0 is the absolute left. - \o 1.0 is the absolute right. + \li 0.0 is the absolute left. + \li 1.0 is the absolute right. \endlist Default value is 0.5 (center). \sa verticalPosition @@ -105,8 +108,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The value is a relative value to the chart rectangle where: \list - \o 0.0 is the absolute top. - \o 1.0 is the absolute bottom. + \li 0.0 is the absolute top. + \li 1.0 is the absolute bottom. \endlist Default value is 0.5 (center). \sa horizontalPosition @@ -120,8 +123,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The value is a relative value to the chart rectangle where: \list - \o 0.0 is the absolute top. - \o 1.0 is the absolute bottom. + \li 0.0 is the absolute top. + \li 1.0 is the absolute bottom. \endlist Default value is 0.5 (center). \sa horizontalPosition @@ -134,8 +137,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The value is a relative value to the chart rectangle where: \list - \o 0.0 is the minimum size (pie not drawn). - \o 1.0 is the maximum size that can fit the chart. + \li 0.0 is the minimum size (pie not drawn). + \li 1.0 is the maximum size that can fit the chart. \endlist When setting this property the holeSize property is adjusted if necessary, to ensure that the hole size is not greater than the outer size. @@ -151,8 +154,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The value is a relative value to the chart rectangle where: \list - \o 0.0 is the minimum size (pie not drawn). - \o 1.0 is the maximum size that can fit the chart. + \li 0.0 is the minimum size (pie not drawn). + \li 1.0 is the maximum size that can fit the chart. \endlist Default value is 0.7. @@ -165,8 +168,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The value is a relative value to the chart rectangle where: \list - \o 0.0 is the minimum size (full pie drawn, without any hole inside). - \o 1.0 is the maximum size that can fit the chart. (donut has no width) + \li 0.0 is the minimum size (full pie drawn, without any hole inside). + \li 1.0 is the maximum size that can fit the chart. (donut has no width) \endlist The value is never greater then size property. @@ -181,8 +184,8 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE The value is a relative value to the chart rectangle where: \list - \o 0.0 is the minimum size (full pie drawn, without any hole inside). - \o 1.0 is the maximum size that can fit the chart. (donut has no width) + \li 0.0 is the minimum size (full pie drawn, without any hole inside). + \li 1.0 is the maximum size that can fit the chart. (donut has no width) \endlist When setting this property the size property is adjusted if necessary, to ensure that the inner size is not greater than the outer size. diff --git a/src/piechart/qpieslice.cpp b/src/piechart/qpieslice.cpp index f5fe857..2aaa900 100644 --- a/src/piechart/qpieslice.cpp +++ b/src/piechart/qpieslice.cpp @@ -25,6 +25,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QPieSlice + \inmodule Qt Charts \brief Defines a slice in pie series. This object defines the properties of a single slice in a QPieSeries. @@ -38,21 +39,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE To enable user interaction with the pie some basic signals are provided about clicking and hovering. */ +#ifdef QDOC_QT5 /*! - \qmlclass PieSlice QPieSlice - PieSlice defines the properties of a single slice in a PieSeries. The element should be used - as a child for a PieSeries. For example: - \snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 2 + \qmltype PieSlice + \instantiates QPieSlice + \inqmlmodule QtCommercial.Chart - An alternative (dynamic) method for adding slices to a PieSeries is using PieSeries.append - method. - \snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 4 + \include /doc/src/pieslice.qdocinc +*/ +#else +/*! + \qmlclass PieSlice QPieSlice - In that case you may want to use PieSeries.at or PieSeries.find to access the properties of - an individual PieSlice instance. - \snippet ../examples/qmlpiechart/qml/qmlpiechart/main.qml 5 - \sa PieSeries + \include ../doc/src/pieslice.qdocinc */ +#endif /*! \enum QPieSlice::LabelPosition @@ -281,7 +282,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE Defines the font used for slice label. - See the \l {Font} {QML Font Element} for detailed documentation. + See the Qt documentation for more details of Font. \sa labelVisible, labelPosition */ diff --git a/src/piechart/qvpiemodelmapper.cpp b/src/piechart/qvpiemodelmapper.cpp index 38eecd1..c733407 100644 --- a/src/piechart/qvpiemodelmapper.cpp +++ b/src/piechart/qvpiemodelmapper.cpp @@ -24,6 +24,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QVPieModelMapper + \inmodule Qt Charts \mainclass Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series. @@ -31,26 +32,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE It is possible to use both QAbstractItemModel and QPieSeries model API. QVPieModelMapper makes sure that Pie and the model are kept in sync. \note Used model has to support adding/removing rows/columns and modifying the data of the cells. */ +#ifdef QDOC_QT5 +/*! + \qmltype VPieModelMapper + \instantiates QVPieModelMapper + \inqmlmodule QtCommercial.Chart + + \include /doc/src/vpiemodelmapper.qdocinc +*/ +#else /*! \qmlclass VPieModelMapper QVPieModelMapper - VPieModelMapper allows you to use your own QAbstractItemModel derived model with data in columns as a data source - for a pie series. It is possible to use both QAbstractItemModel and PieSeries data API to manipulate data. - VPieModelMapper keeps the Pie and the model in sync. - - The following QML example would create a pie series with four slices (assuming the model has at least five rows). - Each slice would contain a label from column 1 and a value from column 2. - \code - VPieModelMapper { - series: pieSeries - model: customModel - labelsColumn: 1 - valuesColumn: 2 - firstRow: 1 - rowCount: 4 - } - \endcode + \include ../doc/src/vpiemodelmapper.qdocinc */ +#endif /*! \property QVPieModelMapper::series diff --git a/src/qabstractseries.cpp b/src/qabstractseries.cpp index 4afa0a0..5a8bbac 100644 --- a/src/qabstractseries.cpp +++ b/src/qabstractseries.cpp @@ -33,6 +33,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QAbstractSeries + \inmodule Qt Charts \brief Base class for all Qt Chart series. \mainclass @@ -40,11 +41,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE \sa QXYSeries, QLineSeries, QSplineSeries, QScatterSeries, QAreaSeries, QAbstractBarSeries, QStackedBarSeries, QPercentBarSeries, QPieSeries */ +#ifdef QDOC_QT5 /*! - \qmlclass AbstractSeries - AbstractSeries is the base class for all series. - The class cannot be instantiated by the user. + \qmltype AbstractSeries + \instantiates QAbstractSeries + \inqmlmodule QtCommercial.Chart + + \include /doc/src/abstractseries.qdocinc +*/ +#else +/*! + \qmlclass AbstractSeries QAbstractSeries + + \include ../doc/src/abstractseries.qdocinc */ +#endif /*! \enum QAbstractSeries::SeriesType diff --git a/src/qchart.cpp b/src/qchart.cpp index 0c0d2e9..434fe5e 100644 --- a/src/qchart.cpp +++ b/src/qchart.cpp @@ -71,6 +71,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QChart + \inmodule Qt Charts \brief Main chart API for Qt Charts. QChart is a QGraphicsWidget that you can show in a QGraphicsScene. It manages the graphical @@ -436,21 +437,21 @@ QList QChart::axes(Qt::Orientations orientation, QAbstractSerie \table \header - \o Series type - \o X-axis - \o Y-axis + \li Series type + \li X-axis + \li Y-axis \row - \o QXYSeries - \o QValueAxis - \o QValueAxis + \li QXYSeries + \li QValueAxis + \li QValueAxis \row - \o QBarSeries - \o QBarCategoryAxis - \o QValueAxis + \li QBarSeries + \li QBarCategoryAxis + \li QValueAxis \row - \o QPieSeries - \o None - \o None + \li QPieSeries + \li None + \li None \endtable If there are several QXYSeries derived series added to the chart and no series of other types have been added, then only one pair of axes is created. diff --git a/src/qchartview.cpp b/src/qchartview.cpp index fd23b74..86a117f 100644 --- a/src/qchartview.cpp +++ b/src/qchartview.cpp @@ -37,6 +37,7 @@ /*! \class QChartView + \inmodule Qt Charts \brief Standalone charting widget. QChartView is a standalone widget that can display charts. It does not require separate diff --git a/src/qpolarchart.cpp b/src/qpolarchart.cpp index e70ebd6..b62f65e 100644 --- a/src/qpolarchart.cpp +++ b/src/qpolarchart.cpp @@ -34,6 +34,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QPolarChart + \inmodule Qt Charts \brief Polar chart API for Qt Charts. QPolarChart is a specialization of QChart to show a polar chart. diff --git a/src/scatterchart/qscatterseries.cpp b/src/scatterchart/qscatterseries.cpp index c574964..28133bf 100644 --- a/src/scatterchart/qscatterseries.cpp +++ b/src/scatterchart/qscatterseries.cpp @@ -28,6 +28,7 @@ /*! \class QScatterSeries + \inmodule Qt Charts \brief The QScatterSeries class is used for making scatter charts. \mainclass @@ -46,18 +47,21 @@ chart->addSeries(series); \endcode */ +#ifdef QDOC_QT5 /*! - \qmlclass ScatterSeries QScatterSeries - \inherits XYSeries + \qmltype ScatterSeries + \instantiates QScatterSeries + \inqmlmodule QtCommercial.Chart - The following QML shows how to create a chart with two simple scatter series: - \snippet ../demos/qmlchart/qml/qmlchart/View5.qml 1 + \include /doc/src/scatterseries.qdocinc +*/ +#else +/*! + \qmlclass ScatterSeries QScatterSeries - \beginfloatleft - \image demos_qmlchart5.png - \endfloat - \clearfloat + \include ../doc/src/scatterseries.qdocinc */ +#endif /*! \enum QScatterSeries::MarkerShape diff --git a/src/splinechart/qsplineseries.cpp b/src/splinechart/qsplineseries.cpp index 29ab231..ccde385 100644 --- a/src/splinechart/qsplineseries.cpp +++ b/src/splinechart/qsplineseries.cpp @@ -28,6 +28,7 @@ /*! \class QSplineSeries + \inmodule Qt Charts \brief Series type used to store data needed to draw a spline. QSplineSeries stores the data points along with the segment control points needed by QPainterPath to draw spline @@ -44,18 +45,21 @@ chart->addSeries(series); \endcode */ +#ifdef QDOC_QT5 +/*! + \qmltype SplineSeries + \instantiates QSplineSeries + \inqmlmodule QtCommercial.Chart + \include /doc/src/splineseries.qdocinc +*/ +#else /*! \qmlclass SplineSeries QSplineSeries - \inherits XYSeries - - The following QML shows how to create a simple spline chart: - \snippet ../demos/qmlchart/qml/qmlchart/View3.qml 1 - \beginfloatleft - \image demos_qmlchart3.png - \endfloat - \clearfloat + + \include ../doc/src/splineseries.qdocinc */ +#endif /*! \fn QSeriesType QSplineSeries::type() const diff --git a/src/xychart/qhxymodelmapper.cpp b/src/xychart/qhxymodelmapper.cpp index 30201e7..ed06663 100644 --- a/src/xychart/qhxymodelmapper.cpp +++ b/src/xychart/qhxymodelmapper.cpp @@ -24,6 +24,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QHXYModelMapper + \inmodule Qt Charts \mainclass Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series. @@ -31,13 +32,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE It is possible to use both QAbstractItemModel and QXYSeries model API. QXYModelMapper makes sure that QXYSeries and the model are kept in sync. Note: used model has to support adding/removing rows/columns and modifying the data of the cells. */ +#ifdef QDOC_QT5 +/*! + \qmltype HXYModelMapper + \instantiates QHXYModelMapper + \inqmlmodule QtCommercial.Chart + + \include /doc/src/hxymodelmapper.qdocinc +*/ +#else /*! \qmlclass HXYModelMapper QHXYModelMapper - HXYModelMapper allows you to use your own QAbstractItemModel derived model with data in rows as a data source - for XYSeries based series. It is possible to use both QAbstractItemModel and XYSeries data API to manipulate data. - HXYModelMapper keeps the series and the model in sync. + \include ../doc/src/hxymodelmapper.qdocinc */ +#endif /*! \property QHXYModelMapper::series diff --git a/src/xychart/qvxymodelmapper.cpp b/src/xychart/qvxymodelmapper.cpp index af5149e..e21522f 100644 --- a/src/xychart/qvxymodelmapper.cpp +++ b/src/xychart/qvxymodelmapper.cpp @@ -24,6 +24,7 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QVXYModelMapper + \inmodule Qt Charts \mainclass Model mappers allow you to use QAbstractItemModel derived models as a data source for a chart series. @@ -31,13 +32,21 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE It is possible to use both QAbstractItemModel and QXYSeries model API. QXYModelMapper makes sure that QXYSeries and the model are kept in sync. Note: used model has to support adding/removing rows/columns and modifying the data of the cells. */ +#ifdef QDOC_QT5 /*! - \qmlclass VXYModelMapper QHXYModelMapper + \qmltype VXYModelMapper + \instantiates QVXYModelMapper + \inqmlmodule QtCommercial.Chart - VXYModelMapper allows you to use your own QAbstractItemModel derived model with data in columns as a data source - for XYSeries based series. It is possible to use both QAbstractItemModel and XYSeries data API to manipulate data. - VYModelMapper keeps the series and the model in sync. + \include /doc/src/vxymodelmapper.qdocinc */ +#else +/*! + \qmlclass VXYModelMapper QVXYModelMapper + + \include ../doc/src/vxymodelmapper.qdocinc +*/ +#endif /*! \property QVXYModelMapper::series diff --git a/src/xychart/qxyseries.cpp b/src/xychart/qxyseries.cpp index 88d1856..c39c655 100644 --- a/src/xychart/qxyseries.cpp +++ b/src/xychart/qxyseries.cpp @@ -31,15 +31,24 @@ QTCOMMERCIALCHART_BEGIN_NAMESPACE /*! \class QXYSeries + \inmodule Qt Charts \brief The QXYSeries class is a base class for line, spline and scatter series. */ +#ifdef QDOC_QT5 /*! - \qmlclass XYSeries - \inherits AbstractSeries - The XYSeries class is a base class for line, spline and scatter series. + \qmltype XYSeries + \instantiates QXYSeries + \inqmlmodule QtCommercial.Chart - The class cannot be instantiated directly. + \include /doc/src/xyseries.qdocinc */ +#else +/*! + \qmlclass XYSeries QXYSeries + + \include ../doc/src/xyseries.qdocinc +*/ +#endif /*! \qmlproperty AbstractAxis XYSeries::axisX