diff options
author | Jacques Lucke <jacques@blender.org> | 2021-04-09 11:20:46 +0300 |
---|---|---|
committer | Jacques Lucke <jacques@blender.org> | 2021-04-09 11:20:46 +0300 |
commit | 75491fe1002122f19fc9fe8eae941a406b81706a (patch) | |
tree | 16a05f5b5ccc7087595ce27656aaa60a5f5c118a /source/blender/editors/space_spreadsheet/spreadsheet_column_layout.hh | |
parent | 22574f741c4e4d142c7068316296d24bbfc2a12c (diff) |
Spreadsheet: persistent column storage and data source
A `DataSource` provides columns for the spreadsheet to display.
Every column has a SpreadsheetColumnID as identifier. Columns
are not generated eagerly anymore, instead the main spreadsheet
code can request a column from a data source with an column
identifier. The column identifiers can be stored in DNA and allow us
to store persistent data per column.
On the user level the only thing that changes is that columns are
not shown in alphabetical order anymore. Instead, new columns
are always added on the left. The behavior can be changed,
however I'd prefer not to automate this too much currently. I think
we should just add operators to hide/reorder/resize columns soonish.
Differential Revision: https://developer.blender.org/D10901
Diffstat (limited to 'source/blender/editors/space_spreadsheet/spreadsheet_column_layout.hh')
-rw-r--r-- | source/blender/editors/space_spreadsheet/spreadsheet_column_layout.hh | 115 |
1 files changed, 0 insertions, 115 deletions
diff --git a/source/blender/editors/space_spreadsheet/spreadsheet_column_layout.hh b/source/blender/editors/space_spreadsheet/spreadsheet_column_layout.hh deleted file mode 100644 index 611337df007..00000000000 --- a/source/blender/editors/space_spreadsheet/spreadsheet_column_layout.hh +++ /dev/null @@ -1,115 +0,0 @@ -/* - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software Foundation, - * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. - */ - -#pragma once - -#include <optional> - -#include "spreadsheet_draw.hh" - -struct Object; -struct Collection; - -namespace blender::ed::spreadsheet { - -struct ObjectCellValue { - const Object *object; -}; - -struct CollectionCellValue { - const Collection *collection; -}; - -/** - * This is a small type that can hold the value of a cell in a spreadsheet. This type allows us to - * decouple the drawing of individual cells from the code that generates the data to be displayed. - */ -class CellValue { - public: - /* The implementation just uses a bunch of `std::option` for now. Unfortunately, we cannot use - * `std::variant` yet, due to missing compiler support. This type can really be optimized more, - * but it does not really matter too much currently. */ - - std::optional<int> value_int; - std::optional<float> value_float; - std::optional<bool> value_bool; - std::optional<ObjectCellValue> value_object; - std::optional<CollectionCellValue> value_collection; -}; - -/** - * This represents a column in a spreadsheet. It has a name and provides a value for all the cells - * in the column. - */ -class SpreadsheetColumn { - protected: - std::string name_; - - public: - SpreadsheetColumn(std::string name) : name_(std::move(name)) - { - } - - virtual ~SpreadsheetColumn() = default; - - virtual void get_value(int index, CellValue &r_cell_value) const = 0; - - StringRefNull name() const - { - return name_; - } - - /* The default width of newly created columns, in UI units. */ - float default_width = 0.0f; -}; - -/* Utility class for the function below. */ -template<typename GetValueF> class LambdaSpreadsheetColumn : public SpreadsheetColumn { - private: - GetValueF get_value_; - - public: - LambdaSpreadsheetColumn(std::string name, GetValueF get_value) - : SpreadsheetColumn(std::move(name)), get_value_(std::move(get_value)) - { - } - - void get_value(int index, CellValue &r_cell_value) const final - { - get_value_(index, r_cell_value); - } -}; - -/* Utility function that simplifies creating a spreadsheet column from a lambda function. */ -template<typename GetValueF> -std::unique_ptr<SpreadsheetColumn> spreadsheet_column_from_function(std::string name, - GetValueF get_value) -{ - return std::make_unique<LambdaSpreadsheetColumn<GetValueF>>(std::move(name), - std::move(get_value)); -} - -/* This contains information required to create a spreadsheet drawer from columns. */ -struct SpreadsheetColumnLayout { - Vector<const SpreadsheetColumn *> columns; - Span<int64_t> row_indices; - int tot_rows = 0; -}; - -std::unique_ptr<SpreadsheetDrawer> spreadsheet_drawer_from_column_layout( - const SpreadsheetColumnLayout &column_layout); - -} // namespace blender::ed::spreadsheet |