##// END OF EJS Templates
changed barseries to abstractbarseries in documentation
sauimone -
r1590:3b61da5c2fc6
parent child
Show More
@@ -48,7 +48,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
48 48 \sa QBarSet, QStackedBarSeries, QPercentBarSeries
49 49 */
50 50 /*!
51 \qmlclass BarSeries QAbstractBarSeries
51 \qmlclass AbstractBarSeries QAbstractBarSeries
52 52 \inherits QAbstractSeries
53 53
54 54 The following QML shows how to create a simple bar chart:
@@ -69,7 +69,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
69 69 \sa QGroupedBarSeries
70 70 */
71 71 /*!
72 \qmlproperty real BarSeries::barWidth
72 \qmlproperty real AbstractBarSeries::barWidth
73 73 The width of the bars of the series. The unit of width is the unit of x-axis. The minimum width for bars
74 74 is zero and negative values are treated as zero. Setting the width to zero means that width of the bar on screen
75 75 is one pixel no matter what the scale of x-axis is. Bars wider than zero are scaled with x-axis.
@@ -81,7 +81,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
81 81 Holds the number of sets in series.
82 82 */
83 83 /*!
84 \qmlproperty int BarSeries::count
84 \qmlproperty int AbstractBarSeries::count
85 85 Holds the number of sets in series.
86 86 */
87 87
@@ -90,7 +90,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
90 90 Defines the visibility of the labels in series
91 91 */
92 92 /*!
93 \qmlproperty bool BarSeries::labelsVisible
93 \qmlproperty bool AbstractBarSeries::labelsVisible
94 94 Defines the visibility of the labels in series
95 95 */
96 96
@@ -100,7 +100,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
100 100 Clicked bar inside set is indexed by \a index
101 101 */
102 102 /*!
103 \qmlsignal BarSeries::onClicked(int index, BarSet barset)
103 \qmlsignal AbstractBarSeries::onClicked(int index, BarSet barset)
104 104 The signal is emitted if the user clicks with a mouse on top of BarSet.
105 105 Clicked bar inside set is indexed by \a index
106 106 */
@@ -113,7 +113,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
113 113 Parameter \a status is true, if mouse entered on top of series, false if mouse left from top of series.
114 114 */
115 115 /*!
116 \qmlsignal BarSeries::onHovered(bool status, BarSet barset)
116 \qmlsignal AbstractBarSeries::onHovered(bool status, BarSet barset)
117 117
118 118 The signal is emitted if mouse is hovered on top of series.
119 119 Parameter \a barset is the pointer of barset, where hover happened.
@@ -125,7 +125,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
125 125 This signal is emitted when barset count has been changed, for example by append or remove.
126 126 */
127 127 /*!
128 \qmlsignal BarSeries::onCountChanged()
128 \qmlsignal AbstractBarSeries::onCountChanged()
129 129 This signal is emitted when barset count has been changed, for example by append or remove.
130 130 */
131 131
@@ -141,7 +141,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
141 141 \sa append(), insert()
142 142 */
143 143 /*!
144 \qmlsignal BarSeries::onAdded(BarSet barset)
144 \qmlsignal AbstractBarSeries::onAdded(BarSet barset)
145 145 Emitted when \a barset has been added to the series.
146 146 */
147 147
@@ -151,17 +151,17 QTCOMMERCIALCHART_BEGIN_NAMESPACE
151 151 \sa remove()
152 152 */
153 153 /*!
154 \qmlsignal BarSeries::onRemoved(BarSet barset)
154 \qmlsignal AbstractBarSeries::onRemoved(BarSet barset)
155 155 Emitted when \a barset has been removed from the series.
156 156 */
157 157
158 158 /*!
159 \qmlmethod BarSet BarSeries::at(int index)
159 \qmlmethod BarSet AbstractBarSeries::at(int index)
160 160 Returns bar set at \a index. Returns null if the index is not valid.
161 161 */
162 162
163 163 /*!
164 \qmlmethod BarSet BarSeries::append(string label, VariantList values)
164 \qmlmethod BarSet AbstractBarSeries::append(string label, VariantList values)
165 165 Adds a new bar set with \a label and \a values to \a index. Values can be a list of reals or a list of XYPoints.
166 166 For example:
167 167 \code
@@ -171,20 +171,20 QTCOMMERCIALCHART_BEGIN_NAMESPACE
171 171 */
172 172
173 173 /*!
174 \qmlmethod BarSet BarSeries::insert(int index, string label, VariantList values)
174 \qmlmethod BarSet AbstractBarSeries::insert(int index, string label, VariantList values)
175 175 Inserts a new bar set with \a label and \a values to \a index. Values can be a list of reals or a list of XYPoints.
176 176 If index is zero or smaller, the new barset is prepended. If the index is count or bigger, the new barset is
177 177 appended.
178 \sa BarSeries::append()
178 \sa AbstractBarSeries::append()
179 179 */
180 180
181 181 /*!
182 \qmlmethod bool BarSeries::remove(BarSet barset)
182 \qmlmethod bool AbstractBarSeries::remove(BarSet barset)
183 183 Removes the barset from the series. Returns true if successfull, false otherwise.
184 184 */
185 185
186 186 /*!
187 \qmlmethod BarSeries::clear()
187 \qmlmethod AbstractBarSeries::clear()
188 188 Removes all barsets from the series.
189 189 */
190 190
@@ -198,7 +198,7 QAbstractBarSeries::QAbstractBarSeries(QObject *parent) :
198 198 }
199 199
200 200 /*!
201 Destructs barseries and owned barsets.
201 Destructs abstractbarseries and owned barsets.
202 202 */
203 203 QAbstractBarSeries::~QAbstractBarSeries()
204 204 {
@@ -18,8 +18,8
18 18 **
19 19 ****************************************************************************/
20 20
21 #ifndef BARSERIES_H
22 #define BARSERIES_H
21 #ifndef ABSTRACTBARSERIES_H
22 #define ABSTRACTBARSERIES_H
23 23
24 24 #include <qabstractseries.h>
25 25 #include <QStringList>
@@ -81,4 +81,4 protected:
81 81
82 82 QTCOMMERCIALCHART_END_NAMESPACE
83 83
84 #endif // BARSERIES_H
84 #endif // ABSTRACTBARSERIES_H
@@ -43,7 +43,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
43 43 First value of set is assumed to belong to first category, second to second category and so on.
44 44 If set has fewer values than there are categories, then the missing values are assumed to be
45 45 at the end of set. For missing values in middle of a set, numerical value of zero is used.
46 \sa BarSeries, GroupedBarSeries, StackedBarSeries, PercentBarSeries
46 \sa AbstractBarSeries, GroupedBarSeries, StackedBarSeries, PercentBarSeries
47 47 */
48 48
49 49 /*!
@@ -45,7 +45,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
45 45 */
46 46 /*!
47 47 \qmlclass GroupedBarSeries QGroupedBarSeries
48 \inherits BarSeries
48 \inherits AbstractBarSeries
49 49
50 50 The following QML shows how to create a simple grouped bar chart:
51 51 \snippet ../demos/qmlchart/qml/qmlchart/View8.qml 1
@@ -63,8 +63,8 QTCOMMERCIALCHART_BEGIN_NAMESPACE
63 63 When new series is specified the old series is disconnected (it preserves its data)
64 64 */
65 65 /*!
66 \qmlproperty BarSeries HBarModelMapper::series
67 Defines the BarSeries based object that is used by the mapper. All the data in the series is discarded when it is
66 \qmlproperty AbstractBarSeries HBarModelMapper::series
67 Defines the AbstractBarSeries based object that is used by the mapper. All the data in the series is discarded when it is
68 68 set to the mapper. When new series is specified the old series is disconnected (it preserves its data).
69 69 */
70 70
@@ -46,7 +46,7 QTCOMMERCIALCHART_BEGIN_NAMESPACE
46 46
47 47 /*!
48 48 \qmlclass StackedBarSeries QStackedBarSeries
49 \inherits BarSeries
49 \inherits AbstractBarSeries
50 50
51 51 The following QML shows how to create a simple stacked bar chart:
52 52 \snippet ../demos/qmlchart/qml/qmlchart/View8.qml 1
@@ -64,8 +64,8 QTCOMMERCIALCHART_BEGIN_NAMESPACE
64 64 When new series is specified the old series is disconnected (it preserves its data)
65 65 */
66 66 /*!
67 \qmlproperty BarSeries VBarModelMapper::series
68 Defines the BarSeries based object that is used by the mapper. All the data in the series is discarded when it is
67 \qmlproperty AbstractBarSeries VBarModelMapper::series
68 Defines the AbstractBarSeries based object that is used by the mapper. All the data in the series is discarded when it is
69 69 set to the mapper. When new series is specified the old series is disconnected (it preserves its data).
70 70 */
71 71
General Comments 0
You need to be logged in to leave comments. Login now