##// END OF EJS Templates
Add doc for QSeries title stuff
Jani Honkonen -
r414:4e7addfef3f4
parent child
Show More
@@ -1,57 +1,71
1 #include "qseries.h"
1 #include "qseries.h"
2
2
3 /*!
3 /*!
4 \class QSeries
4 \class QSeries
5 \brief Base class for all QtCommercial Chart series.
5 \brief Base class for all QtCommercial Chart series.
6 \mainclass
6 \mainclass
7
7
8 Usually you use the series type specific inherited classes instead of the base class.
8 Usually you use the series type specific inherited classes instead of the base class.
9 \sa QScatterSeries
9 \sa QScatterSeries
10 */
10 */
11
11
12 /*!
12 /*!
13 \enum QSeries::QSeriesType
13 \enum QSeries::QSeriesType
14
14
15 The type of the series object.
15 The type of the series object.
16
16
17 \value SeriesTypeLine
17 \value SeriesTypeLine
18 \value SeriesTypeArea
18 \value SeriesTypeArea
19 \value SeriesTypeBar
19 \value SeriesTypeBar
20 \value SeriesTypeStackedBar
20 \value SeriesTypeStackedBar
21 \value SeriesTypePercentBar
21 \value SeriesTypePercentBar
22 \value SeriesTypePie
22 \value SeriesTypePie
23 \value SeriesTypeScatter
23 \value SeriesTypeScatter
24 \value SeriesTypeSpline
24 \value SeriesTypeSpline
25 */
25 */
26
26
27 /*!
27 /*!
28 \fn QSeries::QSeries(QObject *parent)
28 \fn QSeries::QSeries(QObject *parent)
29 \brief Constructs ChartSeries object with \a parent.
29 \brief Constructs ChartSeries object with \a parent.
30 */
30 */
31
31
32 /*!
32 /*!
33 \fn QSeries::~QSeries()
33 \fn QSeries::~QSeries()
34 \brief Virtual destructor for the chart series.
34 \brief Virtual destructor for the chart series.
35 */
35 */
36
36
37 /*!
37 /*!
38 \fn QSeriesType QSeries::type() const
38 \fn QSeriesType QSeries::type() const
39 \brief The type of the series.
39 \brief The type of the series.
40 */
40 */
41
41
42 /*!
42 /*!
43 \fn bool QSeries::setModel(QAbstractItemModel *model)
43 \fn bool QSeries::setModel(QAbstractItemModel *model)
44 \brief Use the \a model to provide data for the series. The model overrides possible user data
44 \brief Use the \a model to provide data for the series. The model overrides possible user data
45 set with QChartSeries type specific data setters. For example if you call both
45 set with QChartSeries type specific data setters. For example if you call both
46 QScatterSeries::addData() and QScatterSeries::setModel, only the data provided by the model is
46 QScatterSeries::addData() and QScatterSeries::setModel, only the data provided by the model is
47 used by the series. Returns true if the model is valid for the series.
47 used by the series. Returns true if the model is valid for the series.
48 */
48 */
49
49
50 /*!
50 /*!
51 \fn QList<QSeries::Legend> QSeries::legend()
51 \fn QList<QSeries::Legend> QSeries::legend()
52 \brief Returns the legend of the series. If series is empty, empty list is returned.
52 \brief Returns the legend of the series. If series is empty, empty list is returned.
53 */
53 */
54
54
55 /*!
56 \fn void QSeries::setTitle(QString title)
57 \brief Sets a \a title for the series.
58
59 This is not used directly by the chart itself. It is up to the user to use this as for example
60 chart title.
61 \sa QChart::setChartTitle()
62 */
63
64 /*!
65 \fn QString QSeries::title()
66 \brief Returns the title of the series.
67 */
68
55 QTCOMMERCIALCHART_BEGIN_NAMESPACE
69 QTCOMMERCIALCHART_BEGIN_NAMESPACE
56 #include "moc_qseries.cpp"
70 #include "moc_qseries.cpp"
57 QTCOMMERCIALCHART_END_NAMESPACE
71 QTCOMMERCIALCHART_END_NAMESPACE
General Comments 0
You need to be logged in to leave comments. Login now