summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/axis/q3dcategoryaxis.cpp
blob: 57c545c81fb6f92ac2d41f3ca080fb6677ebae28 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/****************************************************************************
**
** 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 QtDataVisualization module.
**
** Licensees holding valid Qt Enterprise licenses may use this file in
** accordance with the Qt Enterprise 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
**
****************************************************************************/

#include "q3dcategoryaxis.h"
#include "q3dcategoryaxis_p.h"
#include "bars3dcontroller_p.h"
#include "qbardataproxy.h"

QT_DATAVISUALIZATION_BEGIN_NAMESPACE

/*!
 * \class Q3DCategoryAxis
 * \inmodule QtDataVisualization
 * \brief The Q3DCategoryAxis class is used for manipulating an axis of a graph.
 * \since 1.0.0
 *
 * Q3DCategoryAxis provides an axis that can be given labels. The axis is divided into equal-sized
 * categories based on \l {Q3DBars::setDataWindow()}{data window} size.
 *
 * Grid lines are drawn between categories, if visible. Labels are drawn to positions of categories
 * if provided.
 */

/*!
 * \qmltype CategoryAxis3D
 * \instantiates Q3DCategoryAxis
 * \inherits AbstractAxis3D
 *
 * This type provides an axis that can be given labels.
 */

/*!
 * \qmlproperty list CategoryAxis3D::categoryLabels
 * Defines labels for axis applied to categories. If there are fewer labels than categories, the
 * remaining ones do not have a label. If category labels are not explicitly defined, labels are
 * generated from the data row and column labels.
 */

/*!
 * Constructs Q3DCategoryAxis with \a parent.
 */
Q3DCategoryAxis::Q3DCategoryAxis(QObject *parent) :
    Q3DAbstractAxis(new Q3DCategoryAxisPrivate(this), parent)
{
}

/*!
 * Destroys Q3DCategoryAxis.
 */
Q3DCategoryAxis::~Q3DCategoryAxis()
{
}

/*!
 * \property Q3DCategoryAxis::categoryLabels
 *
 * Defines labels for axis applied to categories. If there are fewer labels than categories, the
 * remaining ones do not have a label. If category labels are not explicitly defined, labels are
 * generated from the data row and column labels.
 *
 * \note CategoryLabels actually reads/writes the Q3DAbstractAxis::labels property,
 * which is read only there. Since subclass cannot have property with same name,
 * this partially duplicate property is necessary.
 */
QStringList Q3DCategoryAxis::categoryLabels() const
{
    return labels();
}

void Q3DCategoryAxis::setCategoryLabels(const QStringList &labels)
{
    dptr()->m_labelsExplicitlySet = !labels.isEmpty();
    bool labelsFromData = false;

    // Get labels from data proxy if axis is attached to a bar controller and an active axis there
    if (labels.isEmpty()) {
        Bars3DController *controller = qobject_cast<Bars3DController *>(parent());
        if (controller) {
            if (controller->axisX() == this) {
                controller->handleDataRowLabelsChanged();
                labelsFromData = true;
            } else if (controller->axisZ() == this) {
                controller->handleDataColumnLabelsChanged();
                labelsFromData = true;
            }
        }
    }

    if (!labelsFromData && d_ptr->m_labels != labels) {
        d_ptr->m_labels = labels;
        emit labelsChanged();
    }
}

/*!
 * \internal
 */
Q3DCategoryAxisPrivate *Q3DCategoryAxis::dptr()
{
    return static_cast<Q3DCategoryAxisPrivate *>(d_ptr.data());
}

Q3DCategoryAxisPrivate::Q3DCategoryAxisPrivate(Q3DCategoryAxis *q)
    : Q3DAbstractAxisPrivate(q, Q3DAbstractAxis::AxisTypeCategory),
      m_labelsExplicitlySet(false)
{
}

Q3DCategoryAxisPrivate::~Q3DCategoryAxisPrivate()
{
}

/*!
 * \internal
 * Controller uses this function to set labels from data proxy as category labels.
 * If the labels have been explicitly set by user, data proxy labels are not used.
 */
void Q3DCategoryAxisPrivate::setDataLabels(const QStringList &labels)
{
    if (!m_labelsExplicitlySet && m_labels != labels) {
        m_labels = labels;
        emit qptr()->labelsChanged();
    }
}

Q3DCategoryAxis *Q3DCategoryAxisPrivate::qptr()
{
    return static_cast<Q3DCategoryAxis *>(q_ptr);
}

QT_DATAVISUALIZATION_END_NAMESPACE