HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r287:6e151fb989cd

QChart and QChartView now has some description for all the functions

Marek Rosa -

r287:6e151fb989cd

parent child

Context file:

r287:6e151fb989cd

Collapse all files

src/qchart.cpp +13 -1

             */
             /*!
-                Constructs a chart object which is a child of a\a parent.
+                Constructs a chart object which is a child of a\a parent. Parameter \a wFlags is passed to the QGraphicsWidget constructor.
             */
             QChart::QChart(QGraphicsItem *parent, Qt::WindowFlags wFlags) : QGraphicsWidget(parent,wFlags),
                 m_backgroundItem(0),
                 m_dataset->removeAllSeries();
             }
+            /*!
+                Sets the \a brush that is used for painting the background of the chart area.
+            */
             void QChart::setChartBackgroundBrush(const QBrush& brush)
             {
                 createChartBackgroundItem();
                 m_backgroundItem->update();
             }
+            /*!
+                Sets the \a pen that is used for painting the background of the chart area.
+            */
             void QChart::setChartBackgroundPen(const QPen& pen)
             {
                 createChartBackgroundItem();
                 m_dataset->previousDomain();
             }
+            /*!
+                Resets to the default view.
+            */
             void QChart::zoomReset()
             {
                 m_dataset->clearDomains();
                 return m_dataset->axisY();
             }
+            /*!
+                Resizes and updates the chart area using the \a event data
+            */
             void QChart::resizeEvent(QGraphicsSceneResizeEvent *event)
             {

src/qchartview.cpp +25 -3

             #include <QDebug>
             /*!
+                \enum QChartView::RubberBandPolicy
+                This enum describes the different types of rubber bands that can be used for zoom rect selection
+                \value NoRubberBand
+                \value VerticalRubberBand
+                \value HorizonalRubberBand
+                \value RectangleRubberBand
+            */
+            /*!
                 \class QChartView
-                \brief Chart widget
+                \brief Standalone charting widget.
-                QChartView is a standalone widget that can display charts. It does not require QGraphicsScene to work. It manages the graphical
+                QChartView is a standalone widget that can display charts. It does not require separate QGraphicsScene to work. It manages the graphical
                 representation of different types of QChartSeries and other chart related objects like
                 QChartAxis and QChartLegend. If you want to display a chart in your existing QGraphicsScene, you can use the QChart class instead.
             {
             }
+            /*!
+                Resizes and updates the chart area using the \a event data
+            */
             void QChartView::resizeEvent(QResizeEvent *event)
             {
                 m_scene->setSceneRect(0,0,size().width(),size().height());
             /*!
                 If Left mouse button is pressed and the RubberBandPolicy is enabled the \a event is accepted and the rubber band is displayed on the screen allowing the user to select the zoom area.
-                If different mouse button is pressed and/or the RubberBandPolicy is disabled then the \a event is not consumed.
+                If different mouse button is pressed and/or the RubberBandPolicy is disabled then the \a event is passed to QGraphicsView::mousePressEvent() implementation is called.
             */
             void QChartView::mousePressEvent(QMouseEvent *event)
             {
                 }
             }
+            /*!
+                If RubberBand rectange specification has been initiated in pressEvent then \a event data is used to update RubberBand geometry.
+                In other case the defualt QGraphicsView::mouseMoveEvent implementation is called.
+            */
             void QChartView::mouseMoveEvent(QMouseEvent *event)
             {
                 if(m_rubberBand && m_rubberBand->isVisible()) {
                 }
             }
+            /*!
+                Pressing + and - keys performs zoomIn() and zoomOut() respectivly.
+                In other \a event is passed to the QGraphicsView::keyPressEvent() implementation
+            */
             void QChartView::keyPressEvent(QKeyEvent *event)
             {
                 switch (event->key()) {

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