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

                 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");
                 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->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

                 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");
                 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);

example/stackedbarchart/main.cpp +4 -2

                 QApplication a(argc, argv);
                 QMainWindow window;
+                //! [1]
                 QBarCategory *category = new QBarCategory;
                 *category << "Jan" << "Feb" << "Mar" << "Apr" << "May" << "June" << "Jul" << "Aug" << "Sep" << "Oct" << "Nov" << "Dec";
                 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);

src/barchart/qbarcategory.cpp +5 0

                 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
             */

src/barchart/qbarchartseries.cpp +27 -16

                 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 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)
             /*!
                 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)
             {
             }
             /*!
-                INTERNAL \a category
+                \internal \a category
             */
             QString QBarChartSeries::label(int category)
             {
             }
             /*!
-                INTERNAL
+                \internal
             */
             int QBarChartSeries::countCategories()
             {
             }
             /*!
-                INTERNAL
+                \internal
             */
             qreal QBarChartSeries::min()
             {
             }
             /*!
-                INTERNAL
+                \internal
             */
             qreal QBarChartSeries::max()
             {
             }
             /*!
-                INTERNAL \a set \a category
+                \internal \a set \a category
             */
             qreal QBarChartSeries::valueAt(int set, int category)
             {
             }
             /*!
-                INTERNAL \a set \a category
+                \internal \a set \a category
             */
             qreal QBarChartSeries::percentageAt(int set, int category)
             {
             }
             /*!
-                INTERNAL \a category
+                \internal \a category
             */
             qreal QBarChartSeries::categorySum(int category)
             {
             }
             /*!
-                INTERNAL
+                \internal
             */
             qreal QBarChartSeries::maxCategorySum()
             {
             }
             /*!
-                INTERNAL
+                \internal
             */
             BarChartModel& QBarChartSeries::model()
             {

src/barchart/qbarset.cpp +5 -5

             */
             /*!
                 \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
             */
             }
             /*!
-                INTERNAL
+                \internal
             */
             void QBarSet::barClicked()
             {
             }
             /*!
-                INTERNAL \a pos
+                \internal \a pos
             */
             void QBarSet::barHoverEntered(QPoint pos)
             {
             }
             /*!
-                INTERNAL
+                \internal
             */
             void QBarSet::barHoverLeaved()
             {

src/barchart/qpercentbarchartseries.cpp +6 -1

                 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
             */
             /*!
                 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)

src/barchart/qstackedbarchartseries.cpp +6 -1

                 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
             */
             /*!
                 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)

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