##// END OF EJS Templates
Various documentation fixes
Various documentation fixes

File last commit:

r796:4bbe1f66d4b7
r909:61db0e530636
Show More
qlineseries.cpp
105 lines | 2.6 KiB | text/x-c | CppLexer
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc
** All rights reserved.
** For any questions to Digia, please use contact form at http://qt.digia.com
**
** This file is part of the Qt Commercial Charts Add-on.
**
** $QT_BEGIN_LICENSE$
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.
**
** If you have questions regarding the use of this file, please use
** contact form at http://qt.digia.com
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qlineseries.h"
QTCOMMERCIALCHART_BEGIN_NAMESPACE
/*!
\class QLineSeries
\brief The QLineSeries class is used for making line charts.
\mainclass
A line chart is used to show information as a series of data points
connected by straight lines.
\image linechart.png
Creating basic line chart is simple:
\code
QLineSeries* series = new QLineSeries();
series->append(0, 6);
series->append(2, 4);
...
chartView->addSeries(series);
\endcode
*/
/*!
\fn virtual QSeriesType QLineSeries::type() const
\brief Returns type of series.
\sa QSeries, QSeriesType
*/
/*!
\fn bool QLineSeries::pointsVisible() const
\brief Returns if the points are drawn for this series.
\sa setPointsVisible()
*/
/*!
\fn QPen QLineSeries::linePen() const
\brief Returns the pen used to draw line connecting points.
\sa setPen()
*/
/*!
Constructs empty series object which is a child of \a parent.
When series object is added to QChartView or QChart instance ownerships is transfered.
*/
QLineSeries::QLineSeries(QObject *parent) : QXYSeries(parent),
m_pointsVisible(false)
{
}
/*!
Destroys the object. Series added to QChartView or QChart instances are owned by those,
and are deleted when mentioned object are destroyed.
*/
QLineSeries::~QLineSeries()
{
}
/*!
Sets if data points are \a visible and should be drawn on line.
*/
void QLineSeries::setPointsVisible(bool visible)
{
if (m_pointsVisible != visible){
m_pointsVisible = visible;
emit QXYSeries::updated();
}
}
QDebug operator<< (QDebug debug, const QLineSeries series)
{
Q_ASSERT(series.m_x.size() == series.m_y.size());
int size = series.m_x.size();
for (int i=0; i<size; i++) {
debug.nospace() << "(" << series.m_x.at(i) << ','<< series.m_y.at(i) << ") ";
}
return debug.space();
}
QTCOMMERCIALCHART_END_NAMESPACE