##// END OF EJS Templates
Changed comma to full stop...
Changed comma to full stop Change-Id: If0023777995c99855fe731568e8c3e8abd5d1ba5 Reviewed-by: Mika Salmela <mika.salmela@digia.com>

File last commit:

r2531:baa389f1ece6
r2535:3c82f10df041
Show More
qboxset.cpp
569 lines | 14.3 KiB | text/x-c | CppLexer
/****************************************************************************
**
** Copyright (C) 2013 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 "qboxset.h"
#include "qboxset_p.h"
#include "charthelpers_p.h"
#include <QDebug> //TODO: remove on release
QTCOMMERCIALCHART_BEGIN_NAMESPACE
/*!
\class QBoxSet
\brief Building block for box-and-whiskers chart
QBoxSet represents one box-and-whiskers item. It takes fives values to create a graphical representation
of range and three medians. There's two type of methods to give the values. The first one is with constructor
or append type of methods (append and operator <<). The values have to be given in order lower extreme,
lower quartile, median, upper quartile and upper extre. Second method is to create an empty QBoxSet instance and
give the values using value specific methods.
\mainclass
\sa QBoxPlotSeries
*/
/*!
\qmlclass BoxSet QBoxSet
BoxSet represents one box-and-whiskers item. It takes fives values to create a graphical representation
of range and three medians. There's two type of methods to give the values. The first one is with constructor
or with append method. In these the values have to be given in order lower extreme, lower quartile, median,
upper quartile and upper extre. Second method is to create an empty QBoxSet instance and
give the values using value specific methods.
\sa BoxPlotSeries
*/
/*!
\qmlproperty string BoxSet::label
Defines the label of the boxSet.
*/
/*!
\qmlproperty int BoxSet::count
The count of values on the box-and-whiskers set
*/
/*!
\property QBoxSet::pen
\brief Defines the pen used by the box-and-whiskers set.
*/
/*!
\property QBoxSet::brush
\brief Defines the brush used by the box-and-whiskers set.
*/
/*!
\property QBoxSet::color
The fill (brush) color of the box-and-whiskers set.
*/
/*!
\qmlproperty color BoxSet::color
Defines the fill (brush) color of the box-and-whiskers set.
*/
/*!
\property QBoxSet::borderColor
The line (pen) color of the box-and-whiskers set.
*/
/*!
\qmlproperty color BoxSet::borderColor
Defines the outline color of the box-and-whiskers set.
*/
/*!
\qmlproperty qreal BoxSet::lowerExtreme
The lower extreme value of the box-and-whiskers set
*/
/*!
\qmlproperty qreal BoxSet::lowerQuartile
The lower quartile value of the box-and-whiskers set
*/
/*!
\qmlproperty qreal BoxSet::median
The median value of the box-and-whiskers set
*/
/*!
\qmlproperty qreal BoxSet::upperQuartile
The upper quartile value of the box-and-whiskers set
*/
/*!
\qmlproperty qreal BoxSet::upperExtreme
The upper extreme value of the box-and-whiskers set
*/
/*!
\fn void QBoxSet::clicked()
The signal is emitted if the user clicks with a mouse on top of box-and-whisker item.
*/
/*!
\qmlsignal BoxSet::onClicked()
This signal is emitted when the user clicks with a mouse on top of box-and-whisker item.
*/
/*!
\fn void QBoxSet::hovered(bool status)
The signal is emitted if mouse is hovered on top of box-and-whisker item.
Parameter \a status is true, if mouse entered on top of item, false if mouse left from top of item.
*/
/*!
\qmlsignal BoxSet::onHovered(bool status)
The signal is emitted if mouse is hovered on top of box-and-whisker item.
Parameter \a status is true, if mouse entered on top of item, false if mouse left from top of item.
*/
/*!
\fn void QBoxSet::penChanged()
This signal is emitted when the pen of the box-and-whisker item has changed.
\sa pen
*/
/*!
\qmlsignal BoxSet::onPenChanged()
This signal is emitted when the pen of the box-and-whisker item has changed.
*/
/*!
\fn void QBoxSet::brushChanged()
This signal is emitted when the brush of the box-and-whisker item has changed.
\sa brush
*/
/*!
\qmlsignal BoxSet::onBrushChanged()
This signal is emitted when the brush of the box-and-whisker item has changed.
*/
/*!
\fn void QBoxSet::colorChanged(QColor)
This signal is emitted when the fill (brush) color of the box-and-whisker item has changed to \a color.
*/
/*!
\qmlsignal BoxSet::onColorChanged(QColor color)
This signal is emitted when the fill (brush) color of the box-and-whisker item has changed to \a color.
*/
/*!
\fn void QBoxSet::valuesAdded(int index, int count)
This signal is emitted when new values have been added to the box-and-whisker item.
Parameter \a index indicates the position of the first inserted value.
Parameter \a count is the number of inserted values.
\sa append(), insert()
*/
/*!
\qmlsignal BoxSet::onValuesAdded(int index, int count)
This signal is emitted when new values have been added to the box-and-whisker item.
Parameter \a index indicates the position of the first inserted value.
Parameter \a count is the number of inserted values.
*/
/*!
\fn void QBoxSet::valueChanged(int index)
This signal is emitted values the value in the box-and-whisker item has been modified.
Parameter \a index indicates the position of the modified value.
\sa at()
*/
/*!
\qmlsignal BoxSet::onValueChanged(int index)
This signal is emitted values the value in the box-and-whisker item has been modified.
Parameter \a index indicates the position of the modified value.
*/
/*!
\fn void QBoxSet::borderColorChanged(QColor)
This signal is emitted when the line (pen) color of the box-and-whisker item has changed to \a color.
*/
/*!
\qmlsignal BoxSet::onBorderColorChanged(QColor color)
This signal is emitted when the line (pen) color of the box-and-whisker item has changed to \a color.
*/
/*!
Constructs QBoxSet with optional \a label and parent of \a parent
*/
QBoxSet::QBoxSet(const QString label, QObject *parent)
: QObject(parent),
d_ptr(new QBoxSetPrivate(label, this))
{
}
/*!
Constructs QBoxSet with given ordered values. \a le for lower extreme, \a lq for lower quartile, \a m for median,
\a uq for upper quartile and \a ue for upper quartile. \a label and \a parent are optional.
*/
QBoxSet::QBoxSet(const qreal le, const qreal lq, const qreal m, const qreal uq, const qreal ue, const QString label, QObject *parent)
: QObject(parent),
d_ptr(new QBoxSetPrivate(label, this))
{
d_ptr->append(le);
d_ptr->append(lq);
d_ptr->append(m);
d_ptr->append(uq);
d_ptr->append(ue);
}
/*!
Destroys the boxset
*/
QBoxSet::~QBoxSet()
{
// NOTE: d_ptr destroyed by QObject
}
/*!
Appends new value \a value to the end of set.
*/
void QBoxSet::append(const qreal value)
{
//int index = d_ptr->m_values.count();
d_ptr->append(value);
emit valuesAdded(d_ptr->m_valuesCount, 1);
}
/*!
Appends a list of reals to set. Works like append with single real value. The \a values in list
are appended to end of boxset
\sa append()
*/
void QBoxSet::append(const QList<qreal> &values)
{
//int index = d_ptr->m_values.count();
d_ptr->append(values);
emit valuesAdded(d_ptr->m_valuesCount, values.count());
}
/*!
Sets new value \a value as the lower extreme for the set.
*/
void QBoxSet::setLowerExtreme(const qreal value)
{
d_ptr->replace(QBoxSetPrivate::PosLowerExtreme, value);
emit d_ptr->restructuredBox();
emit valueChanged(QBoxSetPrivate::PosLowerExtreme);
}
/*!
Returns the lower extreme value of the set.
*/
qreal QBoxSet::lowerExtreme()
{
return d_ptr->m_values[QBoxSetPrivate::PosLowerExtreme];
}
/*!
Sets new value \a value as the lower quartile for the set.
*/
void QBoxSet::setLowerQuartile(const qreal value)
{
d_ptr->replace(QBoxSetPrivate::PosLowerQuartile, value);
emit d_ptr->restructuredBox();
emit valueChanged(QBoxSetPrivate::PosLowerQuartile);
}
/*!
Returns the lower quartile value of the set.
*/
qreal QBoxSet::lowerQuartile()
{
return d_ptr->m_values[QBoxSetPrivate::PosLowerQuartile];
}
/*!
Sets new value \a value as the median for the set.
*/
void QBoxSet::setMedian(const qreal value)
{
d_ptr->replace(QBoxSetPrivate::PosMedian, value);
emit d_ptr->restructuredBox();
emit valueChanged(QBoxSetPrivate::PosMedian);
}
/*!
Returns the median value of the set.
*/
qreal QBoxSet::median()
{
return d_ptr->m_values[QBoxSetPrivate::PosMedian];
}
/*!
Sets new value \a value as the upper quartile for the set.
*/
void QBoxSet::setUpperQuartile(const qreal value)
{
d_ptr->replace(QBoxSetPrivate::PosUpperQuartile, value);
emit d_ptr->restructuredBox();
emit valueChanged(QBoxSetPrivate::PosUpperQuartile);
}
/*!
Returns the upper quartile value of the set.
*/
qreal QBoxSet::upperQuartile()
{
return d_ptr->m_values[QBoxSetPrivate::PosUpperQuartile];
}
/*!
Sets new value \a value as the upper extreme for the set.
*/
void QBoxSet::setUpperExtreme(const qreal value)
{
d_ptr->replace(QBoxSetPrivate::PosUpperExtreme, value);
emit d_ptr->restructuredBox();
emit valueChanged(QBoxSetPrivate::PosUpperExtreme);
}
/*!
Returns the upper extreme value of the set.
*/
qreal QBoxSet::upperExtreme()
{
return d_ptr->m_values[QBoxSetPrivate::PosUpperExtreme];
}
/*!
Sets new \a label for set.
*/
void QBoxSet::setLabel(const QString label)
{
d_ptr->m_label = label;
}
/*!
Returns label of the set.
*/
QString QBoxSet::label() const
{
return d_ptr->m_label;
}
/*!
Convenience operator. Same as append, with real \a value.
\sa append()
*/
QBoxSet &QBoxSet::operator << (const qreal &value)
{
append(value);
return *this;
}
/*!
Inserts new \a value on the \a index position.
The value that is currently at this postion is moved to postion index + 1
*/
void QBoxSet::insert(const int index, const qreal value)
{
d_ptr->insert(index, value);
emit valuesAdded(index, 1);
}
/*!
Sets a new value \a value to set, indexed by \a index
*/
void QBoxSet::replace(const int index, const qreal value)
{
if (index >= 0 && index < 5) {
d_ptr->replace(index, value);
emit valueChanged(index);
}
}
/*!
Returns value of set indexed by \a index.
If the index is out of bounds 0.0 is returned.
*/
qreal QBoxSet::at(const int index) const
{
if (index < 0 || index >= 5)
return 0;
return d_ptr->m_values[index];
}
/*!
Returns value of set indexed by \a index.
If the index is out of bounds 0.0 is returned.
*/
qreal QBoxSet::operator [](const int index) const
{
return at(index);
}
/*!
Returns count of values in set.
*/
int QBoxSet::count() const
{
return d_ptr->m_valuesCount;
}
/*!
Sets pen for set. Boxes of this set are drawn using \a pen
*/
void QBoxSet::setPen(const QPen &pen)
{
if (d_ptr->m_pen != pen) {
d_ptr->m_pen = pen;
emit d_ptr->updatedBox();
emit penChanged();
}
}
/*!
Returns pen of the set.
*/
QPen QBoxSet::pen() const
{
return d_ptr->m_pen;
}
/*!
Sets brush for the set. Boxes of this set are drawn using \a brush
*/
void QBoxSet::setBrush(const QBrush &brush)
{
if (d_ptr->m_brush != brush) {
d_ptr->m_brush = brush;
emit d_ptr->updatedBox();
emit brushChanged();
}
}
/*!
Returns brush of the set.
*/
QBrush QBoxSet::brush() const
{
return d_ptr->m_brush;
}
/*!
Returns the color of the brush of boxset.
*/
QColor QBoxSet::color()
{
return brush().color();
}
/*!
Sets the \a color of brush for this boxset
*/
void QBoxSet::setColor(QColor color)
{
QBrush b = brush();
if ((b.color() != color) || (b.style() == Qt::NoBrush)) {
b.setColor(color);
if (b.style() == Qt::NoBrush) {
// Set tyle to Qt::SolidPattern. (Default is Qt::NoBrush)
// This prevents theme to override color defined in QML side:
// BoxSet { label: "Bob"; color:"red"; values: [1,2,3] }
// The color must be obeyed, since user wanted it.
b.setStyle(Qt::SolidPattern);
}
setBrush(b);
emit colorChanged(color);
}
}
/*!
Returns the color of pen of this boxset
*/
QColor QBoxSet::borderColor()
{
return pen().color();
}
/*!
Sets the color of pen for this boxset
*/
void QBoxSet::setBorderColor(QColor color)
{
QPen p = pen();
if (p.color() != color) {
p.setColor(color);
p.setStyle(Qt::SolidLine);
setPen(p);
emit borderColorChanged(color);
}
}
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
QBoxSetPrivate::QBoxSetPrivate(const QString label, QBoxSet *parent) : QObject(parent),
q_ptr(parent),
m_label(label),
m_valuesCount(5),
m_appendCount(0),
m_pen(QPen(Qt::NoPen)),
m_brush(QBrush(Qt::NoBrush))
{
m_values = new qreal[m_valuesCount];
}
QBoxSetPrivate::~QBoxSetPrivate()
{
}
void QBoxSetPrivate::append(qreal value)
{
if (isValidValue(value) && m_appendCount < m_valuesCount) {
m_values[m_appendCount++] = value;
emit restructuredBox();
}
}
void QBoxSetPrivate::append(QList<qreal> values)
{
for (int i = 0; i < values.count(); i++) {
if (isValidValue(values.at(i)) && m_appendCount < m_valuesCount)
m_values[m_appendCount++] = values.at(i);
}
emit restructuredBox();
}
void QBoxSetPrivate::insert(const int index, const qreal value)
{
if (isValidValue(value)) {
for (int i = 4; i > index; i--)
m_values[i] = m_values[i - 1];
m_values[index] = value;
emit restructuredBox();
}
}
void QBoxSetPrivate::replace(const int index, const qreal value)
{
m_values[index] = value;
emit updatedLayout();
}
qreal QBoxSetPrivate::value(const int index)
{
if (index < 0 || index >= m_valuesCount)
return 0;
return m_values[index];
}
#include "moc_qboxset.cpp"
#include "moc_qboxset_p.cpp"
QTCOMMERCIALCHART_END_NAMESPACE