##// END OF EJS Templates
Began documenting the QML api
Tero Ahola -
r1443:08af46f754b9
parent child
Show More
@@ -0,0 +1,14
1 /*!
2 \page qml.html
3 \title QtCommercial Charts QML API
4 \keyword Charts QML API
5
6 Charts QML API is an intuitive and simple way to use QtCommercial Charts in your QML applications.
7
8 \raw HTML
9 <ul>
10 <li><a href="qml-chartview.html">ChartView</a></li>
11 <li><a href="qml-pieseries.html">PieSeries</a></li>
12 </ul>
13 \endraw
14 */
@@ -13,6 +13,7 HTML.postheader = \
13 13 " <li class=\"first\"><a href=\"index.html\">About</a></li>\n" \
14 14 " <li><a href=\"introduction.html\">Getting started</a></li>\n" \
15 15 " <li><a href=\"classes.html\">API Classes</a></li>\n" \
16 " <li><a href=\"qml.html\">QML API</a></li>\n" \
16 17 " <li><a href=\"examples.html\">Examples</a></li>\n" \
17 18 " <li><a href=\"demos.html\">Demos</a></li>\n" \
18 19 " <!-- Breadcrumbs go here -->\n"
@@ -7,9 +7,11 description = Library for creating charts
7 7
8 8 sourcedirs = ../src \
9 9 ../examples \
10 ./src
10 ./src \
11 ../plugins/declarative
11 12 headerdirs = ../src \
12 ../examples
13 ../examples \
14 ../plugins/declarative
13 15 exampledirs = ../ \
14 16 ../src \
15 17 ../examples
@@ -29,6 +29,19
29 29
30 30 QTCOMMERCIALCHART_BEGIN_NAMESPACE
31 31
32 /*!
33 \qmlclass ChartView DeclarativeChart
34
35 ChartView element is the parent that is responsible for showing different chart series types.
36
37 \section1 Example Usage
38
39 \beginfloatleft
40 \image demos_qmlchart1.png
41 \endfloat
42 \clearfloat
43 */
44
32 45 DeclarativeChart::DeclarativeChart(QDeclarativeItem *parent)
33 46 : QDeclarativeItem(parent),
34 47 m_chart(new QChart(this))
@@ -27,6 +27,53
27 27
28 28 QTCOMMERCIALCHART_BEGIN_NAMESPACE
29 29
30 /*!
31 \qmlclass PieSeries DeclarativePieSeries
32
33 \section1 Example Usage
34
35 \beginfloatleft
36 \image demos_qmlchart1.png
37 \endfloat
38 \clearfloat
39
40 The following QML shows how to create a simple pie chart.
41
42 \snippet ../demos/qmlchart/qml/qmlchart/View1.qml 1
43 */
44
45 /*!
46 \qmlproperty real PieSeries::horizontalPosition
47 \brief Defines the horizontal position of the pie.
48
49 The value is a relative value to the chart rectangle where:
50
51 \list
52 \o 0.0 is the absolute left.
53 \o 1.0 is the absolute right.
54 \endlist
55
56 Default value is 0.5 (center).
57
58 \sa verticalPosition
59 */
60
61 /*!
62 \qmlproperty real PieSeries::verticalPosition
63 \brief Defines the vertical position of the pie.
64
65 The value is a relative value to the chart rectangle where:
66
67 \list
68 \o 0.0 is the absolute top.
69 \o 1.0 is the absolute bottom.
70 \endlist
71
72 Default value is 0.5 (center).
73
74 \sa horizontalPosition
75 */
76
30 77 DeclarativePieSeries::DeclarativePieSeries(QObject *parent) :
31 78 QPieSeries(parent)
32 79 {
General Comments 0
You need to be logged in to leave comments. Login now