blob: 76c7131e268ca91ae1d055ccafb848d4b7500fc0 (
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
|
/* SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
#include "BLI_function_ref.hh"
#include "spreadsheet_column.hh"
#include "spreadsheet_column_values.hh"
namespace blender::ed::spreadsheet {
/**
* This class is subclassed to implement different data sources for the spreadsheet. A data source
* provides the information that should be displayed. It is not concerned with how data is laid
* out in the spreadsheet editor exactly.
*/
class DataSource {
public:
virtual ~DataSource();
/**
* Calls the callback with all the column ids that should be displayed as long as the user does
* not manually add or remove columns. The column id can be stack allocated. Therefore, the
* callback should not keep a reference to it (and copy it instead).
*
* The `is_extra` argument indicates that this column is special and should be drawn as the first
* column. (This can be made a bit more generic in the future when necessary.)
*/
virtual void foreach_default_column_ids(
FunctionRef<void(const SpreadsheetColumnID &, bool is_extra)> fn) const
{
UNUSED_VARS(fn);
}
/**
* Returns the column values the given column id. If no data exists for this id, null is
* returned.
*/
virtual std::unique_ptr<ColumnValues> get_column_values(
const SpreadsheetColumnID &column_id) const
{
UNUSED_VARS(column_id);
return {};
}
/**
* Returns true if the data source has the ability to limit visible rows
* by user interface selection status.
*/
virtual bool has_selection_filter() const
{
return false;
}
/**
* Returns the number of rows in columns returned by #get_column_values.
*/
virtual int tot_rows() const
{
return 0;
}
};
} // namespace blender::ed::spreadsheet
|
