summaryrefslogtreecommitdiffstats
path: root/src/datavis3d/data/qbardataproxy.h
blob: e28f8ff0ce28930e9a63382e07074bab65694b3f (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
/****************************************************************************
**
** 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 QtDataVis3D 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
**
****************************************************************************/

#ifndef QBARDATAPROXY_H
#define QBARDATAPROXY_H

#include <QtDataVis3D/qabstractdataproxy.h>
#include <QtDataVis3D/qbardataitem.h>
#include <QVector>

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 that might be added in the future such as color of
    // individual bar requires allocating additional data object for the bar.

    // 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;
    const QBarDataArray *array() const;
    const QBarDataRow *rowAt(int rowIndex) const;
    const QBarDataItem *itemAt(int rowIndex, int columnIndex) const;

    // The data array is a list of vectors (rows) of QBarDataItem instances.
    // Each row can contain different amount of items or even be null.

    // QBarDataProxy takes ownership of all QBarDataRows passed to it, whether directly or
    // in a QBarDataArray container.
    // QBarDataRow pointers should not be used to modify data further after they have been passed to
    // the proxy, as such modifications will not trigger proper signals.

    // Clears the existing array and takes ownership of the new array.
    // Passing null array clears all data.
    void resetArray(QBarDataArray *newArray);

    // Change existing rows
    void setRow(int rowIndex, QBarDataRow *row);
    void setRows(int rowIndex, const QBarDataArray &rows);

    // Setting a column is comparatively inefficient as it changes all rows.
    // Can resize rows that are shorter than columnIndex.
    // TODO void setColumn(int columnIndex, const QBarDataRow &column);
    // TODO void setColumns(int columnIndex, const QBarDataArray &columns);

    // Change single item
    void setItem(int rowIndex, int columnIndex, const QBarDataItem &item);
    // Change block of items
    // TODO setItems(int rowIndex, int columnIndex, QBarDataArray *items);

    int addRow(QBarDataRow *row); // returns the index of added row
    int addRows(const QBarDataArray &rows); // returns the index of first added row
    // TODO int addColumn(const QBarDataRow &column); // returns the index of the added column
    // TODO int addColumns(const QBarDataArray &columns); // returns the index of the first added column

    // If rowIndex is equal to array size, rows are added to end of the array.
    void insertRow(int rowIndex, QBarDataRow *row);
    void insertRows(int rowIndex, const QBarDataArray &rows);
    // TODO void insertColumn(int columnIndex, const QBarDataRow &column);
    // TODO void insertColumns(int columnIndex, const QBarDataArray &columns);

    // Attempting to remove rows past the end of the array does nothing.
    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);
    // Index is the current array size if rows were removed from the end of the array
    void rowsRemoved(int startIndex, int count);
    void rowsInserted(int startIndex, int count);
    // TODO void columnsChanged(int startIndex, int count);
    // TODO void columnsAdded(int startIndex, int count);
    // TODO void columnsRemoved(int startIndex, int count);
    // TODO void columnsInserted(int startIndex, int count);
    void itemChanged(int rowIndex, int columnIndex); // TODO remove once itemsChanged is added?
    // TODO void itemsChanged(int rowIndex, int columnIndex, int rowCount, int columnCount);

protected:
    QBarDataProxyPrivate *dptr();
    const QBarDataProxyPrivate *dptrc() const;

private:
    Q_DISABLE_COPY(QBarDataProxy)

    friend class Bars3dController;
};

QT_DATAVIS3D_END_NAMESPACE

#endif // QBARDATAPROXY_H