HG_REPOSITORIES/LPP/INSTRUMENTATION/USERS/JEANDET/qtcharts Commit - r480:89946aa027f9

minor. some docs fix

Michal Klocek -

r480:89946aa027f9

parent child

Context file:

r480:89946aa027f9

Collapse all files

doc/src/examples.qdoc 0 -1

             /*!
                 \page examples.html
                 \title Examples
                 \keyword Examples
                 \raw HTML
                     <table cellpadding="2" cellspacing="1" border="0" width="100%" class="indextable">
                     <tr>
                     <th class="titleheader" width="33%">
                     List of examples
                     </th>
                     </tr>
                     <tr>
                     <td valign="top">
                     <ul>
                         <li><a href="example-areachart.html">Area Chart example</a></li>
                         <li><a href="example-barchart.html">Bar Chart example</a></li>
                         <li><a href="example-stackedbarchart.html">Stacked Bar Chart example</a></li>
                         <li><a href="example-percentbarchart.html">Percent Bar Chart example</a></li>
                         <li><a href="example-scatterchart.html">Scatter Chart example</a></li>
                         <li><a href="example-stackedbarchartdrilldown.html">Stacked Bar Chart Drilldown example</a></li>
                         <li><a href="example-linechart.html">Line Chart example</a></li>
                         <li><a href="example-piechart.html">Pie Chart example</a></li>
-                        <li><a href="example-gdpbarchart.html">GDP Chart example</a></li>
                         <li><a href="example-splinechart.html">Spline Chart example</a></li>
                     </ul>
                     </td>
                     </tr>
                     </table>
                 \endraw
             */

src/qchartview.cpp +1 -1

             #include "qchartview.h"
             #include "qchart.h"
             #include "qchartaxis.h"
             #include <QGraphicsView>
             #include <QGraphicsScene>
             #include <QRubberBand>
             #include <QResizeEvent>
             #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 Standalone charting widget.
                 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.
                 \sa QChart
             */
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 Constructs a chartView object which is a child of a\a parent.
             */
             QChartView::QChartView(QWidget *parent) :
             QGraphicsView(parent),
             m_scene(new QGraphicsScene(this)),
             m_chart(new QChart()),
             m_rubberBand(0),
             m_verticalRubberBand(false),
             m_horizonalRubberBand(false)
             {
                 setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
                 setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
                 setScene(m_scene);
                 m_chart->setMargin(50);
                 m_scene->addItem(m_chart);
                 setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
             }
             /*!
                 Destroys the object and it's children, like QChartSeries and QChartAxis object added to it.
             */
             QChartView::~QChartView()
             {
             }
             /*!
                 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());
                 m_chart->resize(size());
                 QWidget::resizeEvent(event);
             }
             /*!
                 Adds the \a series and optional \a axisY onto the chart and takes the ownership of the objects.
                 If auto scaling is enabled, re-scales the axes the series is bound to (both the x axis and
                 the y axis).
                 \sa removeSeries(), removeAllSeries()
             */
             void QChartView::addSeries(QSeries* series,QChartAxis *axisY)
             {
                 m_chart->addSeries(series,axisY);
             }
             /*!
                 Removes the \a series specified in a perameter from the QChartView.
                 It releses its ownership of the specified QChartSeries object.
                 It does not delete the pointed QChartSeries data object
                 \sa addSeries(), removeAllSeries()
             */
             void QChartView::removeSeries(QSeries* series)
             {
                 m_chart->removeSeries(series);
             }
             /*!
                 Removes all the QChartSeries that have been added to the QChartView
                 It also deletes the pointed QChartSeries data objects
                 \sa addSeries(), removeSeries()
             */
             void QChartView::removeAllSeries()
             {
                 m_chart->removeAllSeries();
             }
             /*!
                 Zooms in the view by a factor of 2
             */
             void QChartView::zoomIn()
             {
                 m_chart->zoomIn();
             }
             /*!
                 Zooms in the view to a maximum level at which \a rect is still fully visible.
             */
             void QChartView::zoomIn(const QRect& rect)
             {
                 m_chart->zoomIn(rect);
             }
             /*!
                 Restores the view zoom level to the previous one.
             */
             void QChartView::zoomOut()
             {
                 m_chart->zoomOut();
             }
             /*!
                 Returns the chart margin, which is the distance between the widget edge and the part of the chart where the actual data can be displayed.
             */
             int QChartView::margin() const
             {
                 return m_chart->margin();
             }
             /*!
                 Sets the chart \a title. A description text that is rendered above the chart.
             */
             void QChartView::setChartTitle(const QString& title)
             {
                 m_chart->setChartTitle(title);
             }
             /*!
-                Gets the chart \a title. A description text that is rendered above the chart.
+                Returns the chart's title. A description text that is rendered above the chart.
             */
             QString QChartView::chartTitle() const
             {
                 return m_chart->chartTitle();
             }
             /*!
                 Sets the \a font that is used for rendering the description text that is rendered above the chart.
             */
             void QChartView::setChartTitleFont(const QFont& font)
             {
                 m_chart->setChartTitleFont(font);
             }
             /*!
                 Sets the \a brush that is used for painting the background of the chart area of the QChartView widget.
             */
             void QChartView::setChartBackgroundBrush(const QBrush& brush)
             {
                 m_chart->setChartBackgroundBrush(brush);
             }
             /*!
                 Sets the \a pen that is used for painting the background of the chart area of the QChartView widget.
             */
             void QChartView::setChartBackgroundPen(const QPen& pen)
             {
                 m_chart->setChartBackgroundPen(pen);
             }
             /*!
                 Sets the RubberBandPlicy to \a policy. Selected policy determines the way zooming is performed.
             */
             void QChartView::setRubberBandPolicy(const RubberBandPolicy policy)
             {
                 switch(policy) {
                     case VerticalRubberBand:
                     m_verticalRubberBand = true;
                     m_horizonalRubberBand = false;
                     break;
                     case HorizonalRubberBand:
                     m_verticalRubberBand = false;
                     m_horizonalRubberBand = true;
                     break;
                     case RectangleRubberBand:
                     m_verticalRubberBand = true;
                     m_horizonalRubberBand = true;
                     break;
                     case NoRubberBand:
                     default:
                     delete m_rubberBand;
                     m_rubberBand=0;
                     m_horizonalRubberBand = false;
                     m_verticalRubberBand = false;
                     return;
                 }
                 if(!m_rubberBand) {
                     m_rubberBand = new QRubberBand(QRubberBand::Rectangle, this);
                     m_rubberBand->setEnabled(true);
                 }
             }
             /*!
                 Returns the RubberBandPolicy that is currently being used by the widget.
             */
             QChartView::RubberBandPolicy QChartView::rubberBandPolicy() const
             {
                 if(m_horizonalRubberBand && m_verticalRubberBand) return RectangleRubberBand;
                 if(m_horizonalRubberBand) return HorizonalRubberBand;
                 if(m_verticalRubberBand) return VerticalRubberBand;
                 return NoRubberBand;
             }
             /*!
                 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 passed to QGraphicsView::mousePressEvent() implementation.
             */
             void QChartView::mousePressEvent(QMouseEvent *event)
             {
                 if(m_rubberBand && m_rubberBand->isEnabled() && event->button() == Qt::LeftButton) {
                     int margin = m_chart->margin();
                     QRect rect(margin, margin, width() - 2 * margin, height() - 2 * margin);
                     if (rect.contains(event->pos())) {
                         m_rubberBandOrigin = event->pos();
                         m_rubberBand->setGeometry(QRect(m_rubberBandOrigin, QSize()));
                         m_rubberBand->show();
                         event->accept();
                     }
                 }
                 else {
                     QGraphicsView::mousePressEvent(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()) {
                     int margin = m_chart->margin();
                     QRect rect(margin, margin, width() - 2 * margin, height() - 2 * margin);
                     int width = event->pos().x() - m_rubberBandOrigin.x();
                     int height = event->pos().y() - m_rubberBandOrigin.y();
                     if(!m_verticalRubberBand) {
                         m_rubberBandOrigin.setY(rect.top());
                         height = rect.height();
                     }
                     if(!m_horizonalRubberBand) {
                         m_rubberBandOrigin.setX(rect.left());
                         width= rect.width();
                     }
                     m_rubberBand->setGeometry(QRect(m_rubberBandOrigin.x(),m_rubberBandOrigin.y(), width,height).normalized());
                 }
                 else {
                     QGraphicsView::mouseMoveEvent(event);
                 }
             }
             /*!
                 If left mouse button is release and RubberBand is enabled then \a event is accepted and the view is zoomed in to rect specified by RubberBand
                 If it is the right mouse button \a event then RubberBand is dissmissed and zoom is canceled.
             */
             void QChartView::mouseReleaseEvent(QMouseEvent *event)
             {
                 if(m_rubberBand) {
                     if (event->button() == Qt::LeftButton && m_rubberBand->isVisible()) {
                         m_rubberBand->hide();
                         QRect rect = m_rubberBand->geometry();
                         m_chart->zoomIn(rect);
                         event->accept();
                     }
                     if(event->button()==Qt::RightButton)
                     m_chart->zoomReset();
                 }
                 else {
                     QGraphicsView::mouseReleaseEvent(event);
                 }
             }
             /*!
                 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()) {
                     case Qt::Key_Plus:
                     zoomIn();
                     break;
                     case Qt::Key_Minus:
                     zoomOut();
                     break;
                     default:
                     QGraphicsView::keyPressEvent(event);
                     break;
                 }
             }
             /*!
                 Sets the \a theme used by the chart for rendering the graphical representation of the data
                 \sa QChart::ChartTheme, chartTheme()
             */
             void QChartView::setChartTheme(QChart::ChartTheme theme)
             {
                 m_chart->setChartTheme(theme);
             }
             /*!
                 Returns the theme enum used by the chart.
                 \sa setChartTheme()
             */
             QChart::ChartTheme QChartView::chartTheme() const
             {
                 return m_chart->chartTheme();
             }
             /*!
                 Returns the pointer to the x axis object of the chart
             */
             QChartAxis* QChartView::axisX() const
             {
                 return m_chart->axisX();
             }
             /*!
                 Returns the pointer to the y axis object of the chart
             */
             QChartAxis* QChartView::axisY() const
             {
                 return m_chart->axisY();
             }
             /*!
                 Sets animation \a options for the chart
             */
             void QChartView::setAnimationOptions(QChart::AnimationOptions options)
             {
                 m_chart->setAnimationOptions(options);
             }
             /*!
                 Returns animation options for the chart
             */
             QChart::AnimationOptions QChartView::animationOptions() const
             {
                 return m_chart->animationOptions();
             }
             QTCOMMERCIALCHART_END_NAMESPACE

src/xychart/qxyseries.cpp +9 -3

             #include "qxyseries.h"
             QTCOMMERCIALCHART_BEGIN_NAMESPACE
             /*!
                 \class QXYSeries
                 \brief The QXYSeries class is a base class for line, spline and scatter series.
             */
             /*!
                 \fn virtual QSeriesType QXYSeries::type() const
                 \brief Returns type of series.
                 \sa QSeries, QSeriesType
             */
             /*!
                \fn QPen QXYSeries::pen() const
-               \brief  Returns the pen used to draw points for this series.
+               \brief  Returns pen used to draw points for series.
                 \sa setPen()
             */
             /*!
+               \fn QBrush QXYSeries::brush() const
+               \brief  Returns brush used to draw points for series.
+                \sa setBrush()
+            */
+            /*!
                 \fn void QXYSeries::pointReplaced(int index)
                 \brief \internal \a index
             */
             /*!
                 \fn void QXYSeries::pointAdded(int index)
                 \brief \internal \a index
             */
             /*!
                 \fn void QXYSeries::pointRemoved(int index)
                 \brief \internal \a index
             */
             /*!
                 \fn void QXYSeries::updated()
                 \brief \internal
             */
             /*!
                 Constructs empty series object which is a child of \a parent.
                 When series object is added to QChartView or QChart instance ownerships is transfered.
             */
             QXYSeries::QXYSeries(QObject* parent):QSeries(parent)
             {
             }
             /*!
                 Destroys the object. Series added to QChartView or QChart instances are owned by those,
                 and are deleted when mentioned object are destroyed.
             */
             QXYSeries::~QXYSeries()
             {
             }
             /*!
                 Adds data point \a x \a y to the series. Points are connected with lines on the chart.
              */
             void QXYSeries::add(qreal x,qreal y)
             {
                 Q_ASSERT(m_x.size() == m_y.size());
                 m_x<<x;
                 m_y<<y;
                 emit pointAdded(m_x.size()-1);
             }
             /*!
                This is an overloaded function.
                Adds data \a point to the series. Points are connected with lines on the chart.
              */
             void QXYSeries::add(const QPointF& point)
             {
                 add(point.x(),point.y());
             }
             /*!
               Modifies \a y value for given \a x a value.
             */
             void QXYSeries::replace(qreal x,qreal y)
             {
                 int index = m_x.indexOf(x);
                 m_x[index]=x;
                 m_y[index]=y;
                 emit pointReplaced(index);
             }
             /*!
               This is an overloaded function.
               Replaces current y value of for given \a point x value with \a point y value.
             */
             void QXYSeries::replace(const QPointF& point)
             {
                replace(point.x(),point.y());
             }
             /*!
               Removes current \a x and y value.
             */
             void QXYSeries::remove(qreal x)
             {
                 int index = m_x.indexOf(x);
                 emit pointRemoved(index);
                 m_x.remove(index);
                 m_y.remove(index);
             }
             /*!
               Removes current \a point x value. Note \a point y value is ignored.
             */
             void QXYSeries::remove(const QPointF& point)
             {
                 remove(point.x());
             }
             /*!
               Clears all the data.
             */
             void QXYSeries::clear()
             {
                 m_x.clear();
                 m_y.clear();
             }
             /*!
                 \internal \a pos
             */
             qreal QXYSeries::x(int pos) const
             {
                return m_x.at(pos);
             }
             /*!
                 \internal \a pos
             */
             qreal QXYSeries::y(int pos) const
             {
                return m_y.at(pos);
             }
             /*!
                 Returns number of data points within series.
             */
             int QXYSeries::count() const
             {
             	Q_ASSERT(m_x.size() == m_y.size());
             	return m_x.size();
             }
             /*!
-                Sets \a pen used for points on the chart.
+                Sets \a pen used for drawing points on the chart.
             */
             void QXYSeries::setPen(const QPen& pen)
             {
                 if(pen!=m_pen){
                     m_pen=pen;
                     emit updated();
                 }
             }
             /*!
-                Sets \a brush used for points on the chart.
+                Sets \a brush used for drawing points on the chart.
             */
             void QXYSeries::setBrush(const QBrush& brush)
             {
                 if(brush!=m_brush){
                     m_brush=brush;
                     emit updated();
                 }
             }
             /*!
                 Stream operator for adding a data \a point to the series.
                 \sa add()
             */
             QXYSeries& QXYSeries::operator<< (const QPointF &point)
             {
                 add(point);
                 return *this;
             }
             #include "moc_qxyseries.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