##// END OF EJS Templates
Documentation updates...
Documentation updates Brought the documentation up to date and fixed a bunch of typos. Task-number: QTRD-1951 Change-Id: Id9274e911c314cea6ec8968433cf3c962baf5815 Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com>

File last commit:

r2494:232715f311f8
r2494:232715f311f8
Show More
qabstractseries.cpp
308 lines | 7.5 KiB | text/x-c | CppLexer
/ src / qabstractseries.cpp
Jani Honkonen
Add license headers
r794 /****************************************************************************
**
Miikka Heikkinen
Fixed the copyright year 2012 -> 2013
r2432 ** Copyright (C) 2013 Digia Plc
Jani Honkonen
Add license headers
r794 ** 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$
**
****************************************************************************/
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 #include "qabstractseries.h"
#include "qabstractseries_p.h"
Michal Klocek
Adds if series deleted , remove series from chart
r1062 #include "chartdataset_p.h"
Michal Klocek
Refactors internals...
r2273 #include "qchart.h"
#include "qchart_p.h"
#include "chartitem_p.h"
Marek Rosa
Domains added
r2275 #include "xydomain_p.h"
#include "xlogydomain_p.h"
#include "logxydomain_p.h"
#include "logxlogydomain_p.h"
Michal Klocek
Adds big fat pimpl to series classes...
r938
QTCOMMERCIALCHART_BEGIN_NAMESPACE
sauimone
Refactored series creation.
r62
Tero Ahola
qdoc for QChartSeries
r309 /*!
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 \class QAbstractSeries
Tero Ahola
qdoc for QChartSeries
r309 \brief Base class for all QtCommercial Chart series.
\mainclass
Tero Ahola
Documenting QChartSeries continues
r310
Usually you use the series type specific inherited classes instead of the base class.
sauimone
renamed barseries files to abstractbarseries
r1586 \sa QXYSeries, QLineSeries, QSplineSeries, QScatterSeries, QAreaSeries, QAbstractBarSeries, QStackedBarSeries,
Tero Ahola
Updated documentation, warnings from legend and area left
r973 QPercentBarSeries, QPieSeries
Tero Ahola
qdoc for QChartSeries
r309 */
Tero Ahola
QML methods of series: several fixes and documentation
r1521 /*!
\qmlclass AbstractSeries
AbstractSeries is the base class for all series.
The class cannot be instantiated by the user.
*/
Tero Ahola
qdoc for QChartSeries
r309
/*!
Michal Klocek
Fixes to API , QSeriesType -> SeriesType , add missing getters
r1107 \enum QAbstractSeries::SeriesType
Tero Ahola
qdoc for QChartSeries
r309
The type of the series object.
\value SeriesTypeLine
\value SeriesTypeArea
\value SeriesTypeBar
\value SeriesTypeStackedBar
\value SeriesTypePercentBar
\value SeriesTypePie
\value SeriesTypeScatter
\value SeriesTypeSpline
sauimone
horizontal barchart doc update
r1709 \value SeriesTypeHorizontalBar
\value SeriesTypeHorizontalStackedBar
\value SeriesTypeHorizontalPercentBar
Tero Ahola
qdoc for QChartSeries
r309 */
/*!
Tero Ahola
Minor modifications to properties of abstract, area and bar series
r1462 \property QAbstractSeries::type
The type of the series.
Tero Ahola
qdoc for QChartSeries
r309 */
Tero Ahola
QML methods of series: several fixes and documentation
r1521 /*!
\qmlproperty ChartView.SeriesType AbstractSeries::type
The type of the series.
*/
Tero Ahola
qdoc for QChartSeries
r309
Marek Rosa
Docs updated
r908 /*!
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 \property QAbstractSeries::name
Tero Ahola
QML methods of series: several fixes and documentation
r1521 \brief name of the series property. The name is shown in legend for QXYSeries.
*/
/*!
\qmlproperty string AbstractSeries::name
Name of the series. The name is shown in legend for QXYSeries.
Marek Rosa
Docs updated
r908 */
Jani Honkonen
QAbstractSeries doc update
r1337 /*!
\fn void QAbstractSeries::nameChanged()
This signal is emitted when the series name changes.
Tero Ahola
QML methods of series: several fixes and documentation
r1521 */
/*!
sauimone
qml abstract series doc fix
r1658 \qmlsignal AbstractSeries::onNameChanged()
Tero Ahola
QML methods of series: several fixes and documentation
r1521 This signal is emitted when the series name changes.
Jani Honkonen
QAbstractSeries doc update
r1337 */
Jani Honkonen
Add doc for QSeries title stuff
r414 /*!
Tero Ahola
Documentation for QAbstractSeries
r1343 \property QAbstractSeries::visible
\brief whether the series is visible or not; true by default.
*/
sauimone
qml abstract series doc fix
r1658 /*!
Tero Ahola
QML ChartView signals seriesAdded and seriesRemoved
r2068 \qmlproperty bool AbstractSeries::visible
sauimone
qml abstract series doc fix
r1658 Visibility of the series. True by default.
*/
Jani Honkonen
Add doc for QSeries title stuff
r414
Tero Ahola
Documentation for QAbstractSeries
r1343 /*!
\fn void QAbstractSeries::visibleChanged()
Emitted when the series visibility changes.
Jani Honkonen
Add doc for QSeries title stuff
r414 */
sauimone
qml abstract series doc fix
r1658 /*!
\qmlsignal AbstractSeries::onVisibleChanged()
Emitted when the series visibility changes.
*/
Tero Ahola
QML ChartView signals seriesAdded and seriesRemoved
r2068
/*!
\property QAbstractSeries::opacity
\brief The opacity of the series.
By default the opacity is 1.0. The valid values range from 0.0 (transparent) to 1.0 (opaque).
*/
/*!
\qmlproperty real AbstractSeries::opacity
The opacity of the series. By default the opacity is 1.0.
The valid values range from 0.0 (transparent) to 1.0 (opaque).
*/
/*!
\fn void QAbstractSeries::opacityChanged()
Emitted when the opacity of the series changes.
*/
/*!
\qmlsignal AbstractSeries::onOpacityChanged()
Emitted when the opacity of the series changes.
*/
Jani Honkonen
Add doc for QSeries title stuff
r414 /*!
Tero Ahola
Updated documentation, warnings from legend and area left
r973 \internal
Miikka Heikkinen
Documentation updates...
r2494 \brief Constructs QAbstractSeries object with \a parent.
Jani Honkonen
Add doc for QSeries title stuff
r414 */
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 QAbstractSeries::QAbstractSeries(QAbstractSeriesPrivate &d, QObject *parent) :
Tero Ahola
Updated documentation, warnings from legend and area left
r973 QObject(parent),
d_ptr(&d)
Michal Klocek
Adds big fat pimpl to series classes...
r938 {
}
Tero Ahola
Updated documentation, warnings from legend and area left
r973 /*!
\brief Virtual destructor for the chart series.
*/
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 QAbstractSeries::~QAbstractSeries()
Michal Klocek
Adds big fat pimpl to series classes...
r938 {
Michal Klocek
Refactors internals...
r2273 if (d_ptr->m_chart)
Miikka Heikkinen
Documentation updates...
r2494 qFatal("Series still bound to a chart when destroyed!");
Michal Klocek
Adds big fat pimpl to series classes...
r938 }
Jani Honkonen
more coding style fixes for src-folder...
r2104 void QAbstractSeries::setName(const QString &name)
Michal Klocek
Adds big fat pimpl to series classes...
r938 {
Tero Ahola
Fixed a bug with legend not updating series labels
r1328 if (name != d_ptr->m_name) {
d_ptr->m_name = name;
Tero Ahola
Visible property to abstract series
r1342 emit nameChanged();
Tero Ahola
Fixed a bug with legend not updating series labels
r1328 }
Michal Klocek
Adds big fat pimpl to series classes...
r938 }
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 QString QAbstractSeries::name() const
Michal Klocek
Adds big fat pimpl to series classes...
r938 {
return d_ptr->m_name;
}
Tero Ahola
Visible property to abstract series
r1342 void QAbstractSeries::setVisible(bool visible)
{
if (visible != d_ptr->m_visible) {
d_ptr->m_visible = visible;
emit visibleChanged();
}
}
bool QAbstractSeries::isVisible() const
{
return d_ptr->m_visible;
}
Tero Ahola
Added opacity property to QAbstractSeries
r2067 qreal QAbstractSeries::opacity() const
{
return d_ptr->m_opacity;
}
void QAbstractSeries::setOpacity(qreal opacity)
{
if (opacity != d_ptr->m_opacity) {
d_ptr->m_opacity = opacity;
emit opacityChanged();
}
}
Jani Honkonen
Implemented QAbstractSeries::chart()...
r1314 /*!
\brief Returns the chart where series belongs to.
Set automatically when the series is added to the chart
and unset when the series is removed from the chart.
*/
Jani Honkonen
more coding style fixes for src-folder...
r2104 QChart *QAbstractSeries::chart() const
Jani Honkonen
Implemented QAbstractSeries::chart()...
r1314 {
return d_ptr->m_chart;
}
Marek Rosa
Various docs fixes
r1638 /*!
\brief Sets the visibility of the series to true
\sa setVisible(), isVisible()
*/
Michal Klocek
Changes to qchart qabstractseries API
r1553 void QAbstractSeries::show()
{
setVisible(true);
}
Marek Rosa
Various docs fixes
r1638 /*!
\brief Sets the visibility of the series to false
\sa setVisible(), isVisible()
*/
Michal Klocek
Changes to qchart qabstractseries API
r1553 void QAbstractSeries::hide()
{
setVisible(false);
}
Tero Ahola
Documented QAbstractSeries axis handling
r2363 /*!
Attach \a axis to the series.
\return true if the axis was attached successfully, false otherwise.
\sa QChart::addAxis(), QChart::createDefaultAxes()
*/
Michal Klocek
Refactors internals...
r2273 bool QAbstractSeries::attachAxis(QAbstractAxis* axis)
{
if(d_ptr->m_chart) {
Tero Ahola
Documented QAbstractSeries axis handling
r2363 return d_ptr->m_chart->d_ptr->m_dataset->attachAxis(this, axis);
Michal Klocek
Refactors internals...
r2273 } else {
qWarning()<<"Series not in the chart. Please addSeries to chart first.";
return false;
}
}
Tero Ahola
Documented QAbstractSeries axis handling
r2363 /*!
Detach \a axis from the series.
\return true if the axis was detached successfully, false otherwise.
\sa QChart::removeAxis()
*/
Michal Klocek
Refactors internals...
r2273 bool QAbstractSeries::detachAxis(QAbstractAxis* axis)
{
if(d_ptr->m_chart) {
Tero Ahola
Documented QAbstractSeries axis handling
r2363 return d_ptr->m_chart->d_ptr->m_dataset->detachAxis(this, axis);
Michal Klocek
Refactors internals...
r2273 }
else {
qWarning()<<"Series not in the chart. Please addSeries to chart first.";
return false;
}
}
Tero Ahola
Documented QAbstractSeries axis handling
r2363 /*!
Returns the list of axes attached to the series. Usually there is an x-axis and a y-axis attached to a series, except
in case of a QPieSeries, which does not have any axes attached.
\sa attachAxis(), detachAxis()
*/
Michal Klocek
Refactors internals...
r2273 QList<QAbstractAxis*> QAbstractSeries::attachedAxes()
{
return d_ptr->m_axes;
}
Michal Klocek
Adds big fat pimpl to series classes...
r938 ///////////////////////////////////////////////////////////////////////////////////////////////////
Jani Honkonen
more coding style fixes for src-folder...
r2104 QAbstractSeriesPrivate::QAbstractSeriesPrivate(QAbstractSeries *q)
Jani Honkonen
astyle and manual coding style fixes for src-folder
r2097 : q_ptr(q),
m_chart(0),
Michal Klocek
Refactors internals...
r2273 m_item(0),
Marek Rosa
Domains added
r2275 m_domain(new XYDomain()),
Jani Honkonen
astyle and manual coding style fixes for src-folder
r2097 m_visible(true),
m_opacity(1.0)
Michal Klocek
Adds big fat pimpl to series classes...
r938 {
}
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 QAbstractSeriesPrivate::~QAbstractSeriesPrivate()
Michal Klocek
Adds big fat pimpl to series classes...
r938 {
}
Michal Klocek
Domain not sharable again
r2285 void QAbstractSeriesPrivate::setDomain(AbstractDomain* domain)
Michal Klocek
Refactors internals...
r2273 {
Michal Klocek
Domain not sharable again
r2285 Q_ASSERT(domain);
if(m_domain.data()!=domain) {
Michal Klocek
Refactors internals...
r2273 if(!m_item.isNull()) QObject::disconnect(m_domain.data(), SIGNAL(updated()), m_item.data(), SLOT(handleDomainUpdated()));
Michal Klocek
Domain not sharable again
r2285 m_domain.reset(domain);
Michal Klocek
Refactors internals...
r2273 if(!m_item.isNull()) {
QObject::connect(m_domain.data(), SIGNAL(updated()),m_item.data(), SLOT(handleDomainUpdated()));
m_item->handleDomainUpdated();
}
}
}
void QAbstractSeriesPrivate::initializeGraphics(QGraphicsItem* parent)
{
Q_ASSERT(!m_item.isNull());
Q_UNUSED(parent);
QObject::connect(m_domain.data(), SIGNAL(updated()),m_item.data(), SLOT(handleDomainUpdated()));
}
void QAbstractSeriesPrivate::initializeAnimations(QChart::AnimationOptions options)
{
Q_UNUSED(options);
}
Tero Ahola
Renamed QSeries to QAbstractSeries
r988 #include "moc_qabstractseries.cpp"
#include "moc_qabstractseries_p.cpp"
Michal Klocek
Adds big fat pimpl to series classes...
r938
QTCOMMERCIALCHART_END_NAMESPACE