HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r492:63a52d07d4c8

fixed example paths in barchart documentation

sauimone -

r492:63a52d07d4c8

parent child

Context file:

r492:63a52d07d4c8

Collapse all files

doc/src/example-barchart.qdoc +7 -7

             /*!
-                \example example/barchart
+                \example examples/barchart
                 \title BarChart Example
                 \subtitle
                 The example shows how to create simple bar chart. Barchart shows the data in sets as separate bars, which are grouped in categories.
             	\image barchart.png
                 First we define categories.
-                \snippet ../example/barchart/main.cpp 1
+                \snippet ../examples/barchart/main.cpp 1
                 Data that barchart visualizes, is defined by QBarSet instances. Here we create some sets and append data
             	we want to visulaize to them.
-                \snippet ../example/barchart/main.cpp 2
+                \snippet ../examples/barchart/main.cpp 2
                 To combine the sets and categories to a chart, we need to create QBarSeries instance. When creating
             	the QBarSeries, the categories must be known. Sets can be added later. For example purposes the sets
             	are added to series here.
-                \snippet ../example/barchart/main.cpp 3
+                \snippet ../examples/barchart/main.cpp 3
                 We want our barchart to behave so, that when mouse is hovered over bar, the name of set which the bar
             	represents is shown as tooltip.
             	Also when we click the bar, floating values for the set are toggled. Floating values are the data values
             	that are drawn on top of bars.
-                \snippet ../example/barchart/main.cpp 4
+                \snippet ../examples/barchart/main.cpp 4
                 Here we create the view and add our series to it. Also we set the title and theme we want our chart to use
-                \snippet ../example/barchart/main.cpp 5
+                \snippet ../examples/barchart/main.cpp 5
                 For barchart, we don't need X-axis to be visible, so it can be disabled.
-                \snippet ../example/barchart/main.cpp 6
+                \snippet ../examples/barchart/main.cpp 6
             */

doc/src/example-percentbarchart.qdoc +7 -7

             /*!
-                \example example/percentbarchart
+                \example examples/percentbarchart
                 \title PercentBarChart Example
                 \subtitle
                 The example shows how to create simple percent bar chart. Percent bar chart shows the data in set as percentage of all sets, per category.
             	\image percentbarchart.png
                 First we define categories.
-                \snippet ../example/percentbarchart/main.cpp 1
+                \snippet ../examples/percentbarchart/main.cpp 1
                 Data that barchart visualizes, is defined by QBarSet instances. Here we create some sets and append data
             	we want to visulaize to them.
-                \snippet ../example/percentbarchart/main.cpp 2
+                \snippet ../examples/percentbarchart/main.cpp 2
                 To combine the sets and categories to a chart, we need to create QBarSeries instance. When creating
             	the QBarSeries, the categories must be known. Sets can be added later. For example purposes the sets
             	are added to series here.
-                \snippet ../example/percentbarchart/main.cpp 3
+                \snippet ../examples/percentbarchart/main.cpp 3
                 We want our barchart to behave so, that when mouse is hovered over bar, the name of set which the bar
             	represents is shown as tooltip.
             	Also when we click the bar, floating values for the set are toggled. Floating values are the data values
             	that are drawn on top of bars.
-                \snippet ../example/percentbarchart/main.cpp 4
+                \snippet ../examples/percentbarchart/main.cpp 4
                 Here we create the view and add our series to it. Also we set the title and theme we want our chart to use
-                \snippet ../example/percentbarchart/main.cpp 5
+                \snippet ../examples/percentbarchart/main.cpp 5
                 For barchart, we don't need X-axis to be visible, so it can be disabled.
-                \snippet ../example/percentbarchart/main.cpp 6
+                \snippet ../examples/percentbarchart/main.cpp 6
             */

doc/src/example-stackedbarchart-drilldown.qdoc +7 -7

             /*!
-                \example example/stackedbarchartdrilldown
+                \example examples/stackedbarchartdrilldown
                 \title StackedBarChart Drilldown Example
                 \subtitle
                 The example shows how to implement drilldown using stacked barchart. In drilldown example we create stacked barchart, which shows the harvest of various chili peppers during season. In season view the harvest is grouped by month. To drill down to weekly view, user clicks selected month with right mouse button. On weekly view, the harvest of clicked month is shown by week. For example purposes each month is 4 weeks long :)
             	Season view looks like this:
             	\image stackedbarchart_drilldown_season.png
             	Right mouse button clicked on august, shows the harvest from august:
             	\image stackedbarchart_drilldown_august.png
                 Here we define a drilldown series, which adds mapping for categories to other drilldown series.
             	Purpose of drilldown series is to contain knowledge of the drilldown structure. The mapDrilldownSeries function maps the category to given series. We can ask the mapping for category with drilldownSeries(QString category) function.
-                \snippet ../example/stackedbarchartdrilldown/main.cpp 1
+                \snippet ../examples/stackedbarchartdrilldown/main.cpp 1
                 To enable drilldown we create own view, which implements handler for right click. All QBarSeries derived classes send out rightClicked(QBarSet*, QString) signal when series is clicked with right mouse button. The parameters QBarSet and QString contain the pointer to clicked bar set and name of category, where click occured.
             	In our DrilldownChart we implement handler, which selects the drilldown chart with the category.
-                \snippet ../example/stackedbarchartdrilldown/main.cpp 2
+                \snippet ../examples/stackedbarchartdrilldown/main.cpp 2
                 Here we define data, which we use to construct the chart.
-                \snippet ../example/stackedbarchartdrilldown/main.cpp 3
+                \snippet ../examples/stackedbarchartdrilldown/main.cpp 3
                 To create the drilldown structure, we first create our top level series, which we call seasonSeries. For each month in seasonSeries we create a drilldown series, called weeklySeries which contains more detailed data for that month.
             	In weeklySeries, we use the drilldown handler to bring us back to seasonSeries. To do this we add mapping to the series. The seasonSeries is mapped to weeklySeries for each month. Every weeklySeries is mapped back to the seasonSeries.
             	To make mapping work, we connect the rightClicked signals from our series to the drilldownChart.
-                \snippet ../example/stackedbarchartdrilldown/main.cpp 4
+                \snippet ../examples/stackedbarchartdrilldown/main.cpp 4
                 When we have our drilldown structure ready, we can add the data to it. Here we generate random crop for each plant in each week. The monthly crop is calculated from weekly crops. To enable floating values, we connect the clicked signal to toggle the value of corresponding set.
-                \snippet ../example/stackedbarchartdrilldown/main.cpp 5
+                \snippet ../examples/stackedbarchartdrilldown/main.cpp 5
             	Here we set the chart to show top level series initially.
-                \snippet ../example/stackedbarchartdrilldown/main.cpp 6
+                \snippet ../examples/stackedbarchartdrilldown/main.cpp 6
             */

doc/src/example-stackedbarchart.qdoc +6 -6

             /*!
                 \example example/stackedbarchart
                 \title StackedBarChart Example
                 \subtitle
                 The example shows how to create simple stacked bar chart. Stacked bar chart shows the data in sets as bars that are stacked on top of each other. The stacking is done per category.
             	\image stackedbarchart.png
                 First we define categories.
-                \snippet ../example/stackedbarchart/main.cpp 1
+                \snippet ../examples/stackedbarchart/main.cpp 1
                 Data that barchart visualizes, is defined by QBarSet instances. Here we create some sets and append data
             	we want to visulaize to them.
-                \snippet ../example/stackedbarchart/main.cpp 2
+                \snippet ../examples/stackedbarchart/main.cpp 2
                 To combine the sets and categories to a chart, we need to create QBarSeries instance. When creating
             	the QBarSeries, the categories must be known. Sets can be added later. For example purposes the sets
             	are added to series here.
-                \snippet ../example/stackedbarchart/main.cpp 3
+                \snippet ../examples/stackedbarchart/main.cpp 3
                 We want our barchart to behave so, that when mouse is hovered over bar, the name of set which the bar
             	represents is shown as tooltip.
             	Also when we click the bar, floating values for the set are toggled. Floating values are the data values
             	that are drawn on top of bars.
-                \snippet ../example/stackedbarchart/main.cpp 4
+                \snippet ../examples/stackedbarchart/main.cpp 4
                 Here we create the view and add our series to it. Also we set the title and theme we want our chart to use
-                \snippet ../example/stackedbarchart/main.cpp 5
+                \snippet ../examples/stackedbarchart/main.cpp 5
                 For barchart, we don't need X-axis to be visible, so it can be disabled.
-                \snippet ../example/stackedbarchart/main.cpp 6
+                \snippet ../examples/stackedbarchart/main.cpp 6
             */

src/barchart/qbarset.cpp +3 -1

             #include "qbarset.h"
             #include <QDebug>
             #include <QToolTip>
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 \class QBarSet
                 \brief part of QtCommercial chart API.
                 QBarSet 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.
                 \mainclass
                 \sa QBarSeries, QStackedBarSeries, QPercentBarSeries
             */
             /*!
                 \fn void QBarSet::clicked(QString category)
                 \brief signals that set has been clicked
                 Parameter \a category describes on which category was clicked
             */
             /*!
                 \fn void QBarSet::rightClicked(QString category)
                 \brief signals that set has been clicked with right mouse button
                 Parameter \a category describes on which category was clicked
             */
             /*!
                 \fn void QBarSet::hoverEnter(QPoint pos)
                 \brief signals that mouse has entered over the set at position \a pos.
             */
             /*!
                 \fn void QBarSet::hoverLeave()
                 \brief signals that mouse has left from the set.
             */
             /*!
                 \fn void QBarSet::toggleFloatingValues()
                 \brief \internal
             */
             /*!
                 \fn void QBarSet::showToolTip(QPoint pos, QString tip)
                 \brief \internal \a pos \a tip
             */
             /*!
                 Constructs QBarSet with a name of \a name and with parent of \a parent
             */
             QBarSet::QBarSet(QString name, QObject *parent)
                 : QObject(parent)
                 ,mName(name)
             {
             }
             /*!
                 Sets new \a name for set.
             */
             void QBarSet::setName(QString name)
             {
                 mName = name;
             }
             /*!
                 Returns name of the set.
             */
             QString QBarSet::name()
             {
                 return mName;
             }
             /*!
                 Appends new value \a value to the end of set.
             */
             QBarSet& QBarSet::operator << (const qreal &value)
             {
                 mValues.append(value);
                 return *this;
             }
             /*!
                 Returns count of values in set.
             */
             int QBarSet::count()
             {
                 return mValues.count();
             }
             /*!
                 Returns value of set indexed by \a index
             */
             qreal QBarSet::valueAt(int index)
             {
                 return mValues.at(index);
             }
             /*!
                 Sets a new value \a value to set, indexed by \a index
             */
             void QBarSet::setValue(int index, qreal value)
             {
                 mValues.replace(index,value);
             }
+            /*!
+                Returns total sum of all values in barset.
+            */
             qreal QBarSet::total()
             {
                 qreal total(0);
                 for (int i=0; i<mValues.count(); i++) {
                     total += mValues.at(i);
                 }
                 return total;
             }
             /*!
                 Sets pen for set. Bars of this set are drawn using \a pen
             */
             void QBarSet::setPen(const QPen pen)
             {
                 mPen = pen;
             }
             /*!
                 Returns pen of the set.
             */
             QPen QBarSet::pen() const
             {
                 return mPen;
             }
             /*!
                 Sets brush for the set. Bars of this set are drawn using \a brush
             */
             void QBarSet::setBrush(const QBrush brush)
             {
                 mBrush = brush;
             }
             /*!
                 Returns brush of the set.
             */
             QBrush QBarSet::brush() const
             {
                 return mBrush;
             }
             /*!
                 \internal \a pos
             */
             void QBarSet::barHoverEnterEvent(QPoint pos)
             {
                 emit showToolTip(pos, mName);
                 emit hoverEnter(pos);
             }
             /*!
                 \internal
             */
             void QBarSet::barHoverLeaveEvent()
             {
                 // Emit signal to user of charts
                 emit hoverLeave();
             }
             #include "moc_qbarset.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages