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
|
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtDataVis3D module.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QBARDATAPROXY_H
#define QBARDATAPROXY_H
#include "qabstractdataproxy.h"
#include "qbardataitem.h"
QT_DATAVIS3D_BEGIN_NAMESPACE
typedef QVector<QBarDataItem> QBarDataRow;
typedef QList<QBarDataRow *> QBarDataArray;
class QBarDataProxyPrivate;
class QT_DATAVIS3D_EXPORT QBarDataProxy : public QAbstractDataProxy
{
Q_OBJECT
public:
explicit QBarDataProxy();
explicit QBarDataProxy(QBarDataProxyPrivate *d);
virtual ~QBarDataProxy();
// BarDataProxy is optimized for adding, inserting, and removing rows of data.
// Adding a column essentially means modifying every row, which is comparatively very inefficient.
// Proxy is also optimized to use cases where the only defining characteristic of an individual
// bar is its value. Modifying other data such as color or label format of individual bar
// requires allocating additional data object for the bar.
// If data is accessed from same thread that sets it, access doesn't need to be protected with mutex.
// Row and item pointers are guaranteed to be valid only until next call that modifies data.
// Array pointer is guaranteed to be valid for lifetime of proxy.
int rowCount();
const QBarDataArray *array() const;
const QBarDataRow *rowAt(int rowIndex) const;
const QBarDataItem *itemAt(int rowIndex, int columnIndex) const; // Row and column in said row need to exist or this crashes
// The data array is a list of list (rows) of QBarDataItem instances.
// Each row can contain different amount of items.
// All array/item manipulation functions are internally protected by data mutex.
// TODO: Should we remove internal mutexing and require user to mutex also on data manipulations?
// TODO: Upside would be enabling user to mix data setters and getters within same mutex scope.
// TODO: Downside would be signal emissions from inside the mutex scope, which has potential for deadlock.
// TODO Should data manipulation/access methods be protected rather than public to enforce subclassing use of proxy?
// TODO Leaving them public gives user more options.
// QBarDataProxy takes ownership of all QBarDataArrays, QBarDataRows, and QBarDataItems passed to it.
// The pointers passed to it are not guaranteed to be valid after the calls.
// Clears the existing array and sets it data to new array.
void resetArray(QBarDataArray *newArray);
void setRow(int rowIndex, QBarDataRow *row);
// TODO? void setColumn(int columnIndex, QBarDataRow *column);
// TODO void setItem(int rowIndex, int columnIndex, QBarDataItem *item);
int addRow(QBarDataRow *row); // returns the index of added row
int addRows(QBarDataArray *rows); // returns the index of first added row
// TODO? int addColumns(QBarDataArray *columns); // returns the index of first added column
void insertRow(int rowIndex, QBarDataRow *row);
void insertRows(int rowIndex, QBarDataArray *rows);
// TODO? void insertColumns(int columnIndex, QBarDataArray *columns);
// TODO void removeRows(int rowIndex, int removeCount);
// TODO? void removeColumns(int columnIndex, int removeCount);
signals:
void arrayReset();
void rowsAdded(int startIndex, int count);
void rowsChanged(int startIndex, int count);
void rowsRemoved(int startIndex, int count); // Index may be over current array size if removed from end
void rowsInserted(int startIndex, int count);
protected:
QBarDataProxyPrivate *dptr();
const QBarDataProxyPrivate *dptrc() const;
private:
Q_DISABLE_COPY(QBarDataProxy)
friend class Bars3dController;
};
QT_DATAVIS3D_END_NAMESPACE
#endif // QBARDATAPROXY_H
|
