HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r319:c54c34ca0b57

Updated barchart documentation

sauimone -

r319:c54c34ca0b57

parent child

Context file:

r319:c54c34ca0b57

Collapse all files

example/barchart/main.cpp +9 -4

             #include <QApplication>
             #include <QMainWindow>
             #include <qchartview.h>
             #include <qbarchartseries.h>
             #include <qbarset.h>
             #include <qbarcategory.h>
             QTCOMMERCIALCHART_USE_NAMESPACE
             int main(int argc, char *argv[])
             {
                 QApplication a(argc, argv);
                 QMainWindow window;
+                //! [1]
                 QBarCategory *category = new QBarCategory;
                 *category << "Jan" << "Feb" << "Mar" << "Apr" << "May" << "June" << "Jul" << "Aug" << "Sep" << "Oct" << "Nov" << "Dec";
+                //! [1]
+                //! [2]
                 QBarChartSeries* series= new QBarChartSeries(category);
-                // We use custom set, which connects some signals. Could use QBarSet here if we don't need signals
                 QBarSet *set0 = new QBarSet("Bub");
                 QBarSet *set1 = new QBarSet("Bob");
                 QBarSet *set2 = new QBarSet("Guybrush");
                 QBarSet *set3 = new QBarSet("Larry");
                 QBarSet *set4 = new QBarSet("Zak");
                 // Create some test data to chart
                 *set0 << 1 << 2 << 3 << 4 << 5 << 6 << 7 << 8 << 9 << 10 << 11 << 12;
                 *set1 << 5 << 0 << 0 << 4 << 0 << 7 << 8 << 9 << 9 << 0 << 4 << 2;
                 *set2 << 3 << 5 << 8 << 13 << 8 << 5 << 3 << 2 << 1 << 1 << 3 << 5;
                 *set3 << 5 << 6 << 7 << 3 << 4 << 5 << 8 << 9 << 10 << 5 << 2 << 7;
                 *set4 << 9 << 7 << 5 << 3 << 1 << 2 << 4 << 6 << 8 << 10 << 1 << 6;
                 series->addBarSet(set0);
                 series->addBarSet(set1);
                 series->addBarSet(set2);
                 series->addBarSet(set3);
                 series->addBarSet(set4);
+                //! [2]
-                series->enableToolTip(true);
+                //! [3]
-                series->enableFloatingValues(true);
+                series->enableToolTip();
+                series->enableFloatingValues();
+                //! [3]
                 QChartView* chartView =  new QChartView(&window);
                 chartView->addSeries(series);
                 chartView->setChartTitle("simple stacked barchart");
                 chartView->setChartTheme(QChart::ChartThemeIcy);
                 window.setCentralWidget(chartView);
-                window.resize(400, 300);
+                window.resize(600, 300);
                 window.show();
                 return a.exec();
             }

example/percentbarchart/main.cpp +4 -2

             #include <QApplication>
             #include <QMainWindow>
             #include <QStandardItemModel>
             #include <qpercentbarchartseries.h>
             #include <qbarcategory.h>
             #include <qchartview.h>
             #include <qbarset.h>
             QTCOMMERCIALCHART_USE_NAMESPACE
             int main(int argc, char *argv[])
             {
                 QApplication a(argc, argv);
                 QMainWindow window;
                 QBarCategory *category = new QBarCategory;
                 *category << "Jan" << "Feb" << "Mar" << "Apr" << "May" << "June" << "Jul" << "Aug" << "Sep" << "Oct" << "Nov" << "Dec";
+                //! [1]
                 QPercentBarChartSeries* series = new QPercentBarChartSeries(category);
                 QBarSet *set0 = new QBarSet("Bub");
                 QBarSet *set1 = new QBarSet("Bob");
                 QBarSet *set2 = new QBarSet("Guybrush");
                 QBarSet *set3 = new QBarSet("Larry");
                 QBarSet *set4 = new QBarSet("Zak");
                 // Create some test data to chart
                 *set0 << 1 << 2 << 3 << 4 << 5 << 6 << 7 << 8 << 9 << 10 << 11 << 12;
                 *set1 << 5 << 0 << 0 << 4 << 0 << 7 << 8 << 9 << 9 << 0 << 4 << 2;
                 *set2 << 3 << 5 << 8 << 13 << 8 << 5 << 3 << 2 << 1 << 1 << 3 << 5;
                 *set3 << 5 << 6 << 7 << 3 << 4 << 5 << 8 << 9 << 10 << 5 << 2 << 7;
                 *set4 << 9 << 7 << 5 << 3 << 1 << 2 << 4 << 6 << 8 << 10 << 1 << 6;
                 series->addBarSet(set0);
                 series->addBarSet(set1);
                 series->addBarSet(set2);
                 series->addBarSet(set3);
                 series->addBarSet(set4);
+                //! [1]
-                series->enableToolTip(true);
+                series->enableToolTip();
-                series->enableFloatingValues(true);
+                series->enableFloatingValues();
                 QChartView* chartView =  new QChartView(&window);
                 chartView->addSeries(series);
                 chartView->setChartTitle("simple percent barchart");
                 chartView->setChartTheme(QChart::ChartThemeIcy);
                 window.setCentralWidget(chartView);
                 window.resize(400, 300);
                 window.show();
                 return a.exec();
             }

example/stackedbarchart/main.cpp +4 -2

             #include <QApplication>
             #include <QMainWindow>
             #include <qchartview.h>
             #include <qstackedbarchartseries.h>
             #include <qbarset.h>
             #include <qbarcategory.h>
             QTCOMMERCIALCHART_USE_NAMESPACE
             int main(int argc, char *argv[])
             {
                 QApplication a(argc, argv);
                 QMainWindow window;
+                //! [1]
                 QBarCategory *category = new QBarCategory;
                 *category << "Jan" << "Feb" << "Mar" << "Apr" << "May" << "June" << "Jul" << "Aug" << "Sep" << "Oct" << "Nov" << "Dec";
                 QStackedBarChartSeries* series = new QStackedBarChartSeries(category);
                 QBarSet *set0 = new QBarSet("Bub");
                 QBarSet *set1 = new QBarSet("Bob");
                 QBarSet *set2 = new QBarSet("Guybrush");
                 QBarSet *set3 = new QBarSet("Larry");
                 QBarSet *set4 = new QBarSet("Zak");
                 // Create some test data to chart
                 *set0 << 1 << 2 << 3 << 4 << 5 << 6 << 7 << 8 << 9 << 10 << 11 << 12;
                 *set1 << 5 << 0 << 0 << 4 << 0 << 7 << 8 << 9 << 9 << 0 << 4 << 2;
                 *set2 << 3 << 5 << 8 << 13 << 8 << 5 << 3 << 2 << 1 << 1 << 3 << 5;
                 *set3 << 5 << 6 << 7 << 3 << 4 << 5 << 8 << 9 << 10 << 5 << 2 << 7;
                 *set4 << 9 << 7 << 5 << 3 << 1 << 2 << 4 << 6 << 8 << 10 << 1 << 6;
                 series->addBarSet(set0);
                 series->addBarSet(set1);
                 series->addBarSet(set2);
                 series->addBarSet(set3);
                 series->addBarSet(set4);
-                series->enableToolTip(true);
+                series->enableToolTip();
-                series->enableFloatingValues(true);
+                series->enableFloatingValues();
+                //! [1]
                 QChartView* chartView =  new QChartView(&window);
                 chartView->addSeries(series);
                 chartView->setChartTitle("simple stacked barchart");
                 chartView->setChartTheme(QChart::ChartThemeIcy);
                 window.setCentralWidget(chartView);
                 window.resize(400, 300);
                 window.show();
                 return a.exec();
             }

src/barchart/qbarcategory.cpp +5 0

             #include "qbarcategory.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 \class QBarCategory
                 \brief part of QtCommercial chart API.
                 QBarCategory is a container for labels of various bar charts. Before the
                 bar chart can be constructed, the categories must be defined. This is done by
                 creating a QBarCategory class and appending the labels of categories to it.
                 The QBarCategory is then given to bar chart series class.
+                \mainclass
+                Example on how to create a category:
+                \snippet ../example/barchart/main.cpp 1
                 \sa QBarChartSeries, QStackedBarChartSeries, QPercentBarChartSeries
             */
             /*!
                 Constructs the category container
             */
             QBarCategory::QBarCategory()
             {
             }
             /*!
                 Appends the \a label in the category.
             */
             QBarCategory& QBarCategory::operator << (const QString &label)
             {
                 mList.append(label);
                 return *this;
             }
             /*!
                 Retrurns number of labels in category
             */
             int QBarCategory::count()
             {
                 return mList.count();
             }
             /*!
                 Retruns the label of category defined by index \a category
             */
             QString QBarCategory::label(int category)
             {
                 return mList.at(category);
             }
             // TODO?:
             //#include "moc_qbarcategory.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

src/barchart/qbarchartseries.cpp +27 -16

             #include <QDebug>
             #include "qbarchartseries.h"
             #include "qbarcategory.h"
             #include "qbarset.h"
             #include "barchartmodel_p.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 \class QBarChartSeries
                 \brief part of QtCommercial chart API.
                 QBarChartSeries represents a series of data shown as bars. One QBarChartSeries can contain multible
                 QBarSet data sets. QBarChartSeries groups the data from sets to categories, which are defined
                 by QBarCategory class.
+                \mainclass
+                Example on how to add sets to bar chart:
+                \snippet ../example/barchart/main.cpp 2
+                Example on how to enable tooltip and floating values:
+                \snippet ../example/barchart/main.cpp 3
                 \sa QBarCategory, QBarSet, QStackedBarChartSeries, QPercentBarChartSeries
             */
             /*!
                 \fn virtual QChartSeriesType QBarChartSeries::type() const
                 \brief Returns type of series.
                 \sa QChartSeries, QChartSeriesType
             */
             /*!
                 \fn void QBarChartSeries::changed(int index)
-                \brief INTERNAL \a index
+                \brief \internal \a index
             */
             /*!
                 \fn void QBarChartSeries::floatingValuesEnabled(bool enabled)
-                \brief INTERNAL \a enabled
+                \brief \internal \a enabled
             */
             /*!
                 \fn void QBarChartSeries::toolTipEnabled(bool enabled)
-                \brief INTERNAL \a enabled
+                \brief \internal \a enabled
             */
             /*!
                 \fn void QBarChartSeries::separatorsEnabled(bool enabled)
-                \brief INTERNAL \a enabled
+                \brief \internal \a enabled
             */
             /*!
                 \fn void QBarChartSeries::showToolTip(QPoint pos, QString tip)
-                \brief INTERNAL \a pos \a tip
+                \brief \internal \a pos \a tip
             */
             /*!
                 Constructs empty QBarChartSeries. Parameter \a category defines the categories for chart.
-                QBarChartSeries is QObject which is a child of a\a parent.
+                QBarChartSeries is QObject which is a child of a \a parent.
             */
             QBarChartSeries::QBarChartSeries(QBarCategory *category, QObject *parent)
                 : QChartSeries(parent)
                 ,mModel(new BarChartModel(category, this))
             {
             }
             /*!
                 Adds a set of bars to series. Takes ownership of \a set
             */
             void QBarChartSeries::addBarSet(QBarSet *set)
             {
                 mModel->addBarSet(set);
             }
             /*!
                 Removes a set of bars from series. Releases ownership of \a set. Doesnt delete \a set.
             */
             void QBarChartSeries::removeBarSet(QBarSet *set)
             {
                 mModel->removeBarSet(set);
             }
             /*!
                 Returns number of sets in series.
             */
             int QBarChartSeries::countSets()
             {
                 return mModel->countSets();
             }
             /*!
                 Simple iterator for set. Returns pointer to next set in series.
-                Returns first set, if \a getFirst is true. If series is empty, returns 0.
+                Returns first set, if parameter \a getFirst is true.
+                If series is empty, returns 0.
+                Returns 0 after last set.
             */
             QBarSet* QBarChartSeries::nextSet(bool getFirst)
             {
                 return mModel->nextSet(getFirst);
             }
             /*!
                 Returns set indexed by \a index. Doesn't check for index bounds.
                 Assumes that \a index is between 0 and number of sets. Use countSets() to get valid index bound.
                 \sa countSets()
             */
             QBarSet* QBarChartSeries::setAt(int index)
             {
                 return mModel->setAt(index);
             }
             /*!
                 Returns legend of series. Legend is a list of set names in series.
             */
             QList<QString> QBarChartSeries::legend()
             {
                 return mModel->legend();
             }
             /*!
-                INTERNAL \a category
+                \internal \a category
             */
             QString QBarChartSeries::label(int category)
             {
                 return mModel->label(category);
             }
             /*!
                 Enables or disables floating values depending on parameter \a enabled.
                 Floating values are bar values, that are displayed on top of each bar.
                 Calling without parameter \a enabled, enables the floating values
             */
             void QBarChartSeries::enableFloatingValues(bool enabled)
             {
                 if (enabled) {
                     for (int i=0; i<mModel->countSets(); i++) {
                         QBarSet *set = mModel->setAt(i);
                         connect(set,SIGNAL(clicked()),set,SIGNAL(toggleFloatingValues()));
                     }
                 } else {
                     for (int i=0; i<mModel->countSets(); i++) {
                         QBarSet *set = mModel->setAt(i);
                         disconnect(set,SIGNAL(clicked()),set,SIGNAL(toggleFloatingValues()));
                     }
                 }
             }
             /*!
                 Enables or disables tooltip depending on parameter \a enabled.
                 Tooltip shows the name of set, when mouse is hovering on top of bar.
                 Calling without parameter \a enabled, enables the tooltip
             */
             void QBarChartSeries::enableToolTip(bool enabled)
             {
                 if (enabled) {
                     for (int i=0; i<mModel->countSets(); i++) {
                         QBarSet *set = mModel->setAt(i);
                         connect(set,SIGNAL(showToolTip(QPoint,QString)),this,SIGNAL(showToolTip(QPoint,QString)));
                     }
                 } else {
                     for (int i=0; i<mModel->countSets(); i++) {
                         QBarSet *set = mModel->setAt(i);
                         disconnect(set,SIGNAL(showToolTip(QPoint,QString)),this,SIGNAL(showToolTip(QPoint,QString)));
                     }
                 }
             }
             /*!
                 Enables or disables separators depending on parameter \a enabled.
                 Separators are visual elements that are drawn between categories.
                 Calling without parameter \a enabled, enables the separators
             */
             void QBarChartSeries::enableSeparators(bool enabled)
             {
                 emit separatorsEnabled(enabled);
             }
             /*!
-                INTERNAL
+                \internal
             */
             int QBarChartSeries::countCategories()
             {
                 return mModel->countCategories();
             }
             /*!
-                INTERNAL
+                \internal
             */
             qreal QBarChartSeries::min()
             {
                 return mModel->min();
             }
             /*!
-                INTERNAL
+                \internal
             */
             qreal QBarChartSeries::max()
             {
                 return mModel->max();
             }
             /*!
-                INTERNAL \a set \a category
+                \internal \a set \a category
             */
             qreal QBarChartSeries::valueAt(int set, int category)
             {
                 return mModel->valueAt(set,category);
             }
             /*!
-                INTERNAL \a set \a category
+                \internal \a set \a category
             */
             qreal QBarChartSeries::percentageAt(int set, int category)
             {
                 return mModel->percentageAt(set,category);
             }
             /*!
-                INTERNAL \a category
+                \internal \a category
             */
             qreal QBarChartSeries::categorySum(int category)
             {
                 return mModel->categorySum(category);
             }
             /*!
-                INTERNAL
+                \internal
             */
             qreal QBarChartSeries::maxCategorySum()
             {
                 return mModel->maxCategorySum();
             }
             /*!
-                INTERNAL
+                \internal
             */
             BarChartModel& QBarChartSeries::model()
             {
                 return *mModel;
             }
             #include "moc_qbarchartseries.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

src/barchart/qbarset.cpp +5 -5

             #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.
                 \sa QBarCategory, QBarChartSeries, QStackedBarChartSeries, QPercentBarChartSeries
             */
             /*!
                 \fn void QBarSet::clicked()
                 \brief signals that set has been 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
+                \brief \internal
             */
             /*!
                 \fn void QBarSet::showToolTip(QPoint pos, QString tip)
-                \brief INTERNAL \a pos \a 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);
             }
             /*!
                 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.
             */
             const 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.
             */
             const QBrush& QBarSet::brush() const
             {
                 return mBrush;
             }
             /*!
-                INTERNAL
+                \internal
             */
             void QBarSet::barClicked()
             {
             //    qDebug() << "QBarset::barClicked" << this;
                 // Some bar of this set has been clicked
                 // TODO: What happens then?
                 emit clicked();     // Notify that set has been clicked
             }
             /*!
-                INTERNAL \a pos
+                \internal \a pos
             */
             void QBarSet::barHoverEntered(QPoint pos)
             {
                 emit showToolTip(pos, mName);
                 emit hoverEnter(pos);
             }
             /*!
-                INTERNAL
+                \internal
             */
             void QBarSet::barHoverLeaved()
             {
             //    qDebug() << "QBarset::barHoverLeaved" << this;
             //    if (mToolTipEnabled) {
                     // TODO: do what?
             //    }
                 // Emit signal to user of charts
                 emit hoverLeave();
             }
             #include "moc_qbarset.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

src/barchart/qpercentbarchartseries.cpp +6 -1

             #include "qpercentbarchartseries.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 \class QPercentBarChartSeries
                 \brief part of QtCommercial chart API.
                 QPercentBarChartSeries represents a series of data shown as bars. Each bar of QBarSet is shown as percentage
                 of all bars in category. One QPercentBarChartSeries can contain multible QBarSet data sets.
                 QBarChartSeries groups the data from sets to categories, which are defined by QBarCategory class.
+                \mainclass
+                Example on using QPercentBarChartSeries
+                \snippet ../example/percentbarchart/main.cpp 1
                 \sa QBarCategory, QBarSet, QStackedBarChartSeries, QBarChartSeries
             */
             /*!
                 \fn virtual QChartSeriesType QPercentBarChartSeries::type() const
                 \brief Returns type of series.
                 \sa QChartSeries, QChartSeriesType
             */
             /*!
                 Constructs empty QPercentBarChartSeries. Parameter \a category defines the categories for chart.
-                QPercentBarChartSeries is QObject which is a child of a\a parent.
+                QPercentBarChartSeries is QObject which is a child of a \a parent.
             */
             QPercentBarChartSeries::QPercentBarChartSeries(QBarCategory *category, QObject *parent)
                 : QBarChartSeries(category, parent)
             {
             }
             #include "moc_qpercentbarchartseries.cpp"
             QTCOMMERCIALCHART_END_NAMESPACE

src/barchart/qstackedbarchartseries.cpp +6 -1

             #include "qstackedbarchartseries.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 \class QStackedBarChartSeries
                 \brief part of QtCommercial chart API.
                 QStackedBarChartSeries represents a series of data shown as bars. All bars in same category are
                 stacked on top of each other. One QStackedBarChartSeries can contain multible QBarSet data sets.
                 QStackedBarChartSeries groups the data from sets to categories, which are defined by QBarCategory class.
+                \mainclass
+                Example on using QStackedBarChartSeries
+                \snippet ../example/stackedbarchart/main.cpp 1
                 \sa QBarCategory, QBarSet, QPercentBarChartSeries, QBarChartSeries
             */
             /*!
                 \fn virtual QChartSeriesType QStackedBarChartSeries::type() const
                 \brief Returns type of series.
                 \sa QChartSeries, QChartSeriesType
             */
             /*!
                 Constructs empty QStackedBarChartSeries. Parameter \a category defines the categories for chart.
-                QStackedBarChartSeries is QObject which is a child of a\a parent.
+                QStackedBarChartSeries is QObject which is a child of a \a parent.
             */
             QStackedBarChartSeries::QStackedBarChartSeries(QBarCategory *category, QObject *parent)
                 : QBarChartSeries(category, parent)
             {
             }
             #include "moc_qstackedbarchartseries.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