#include <spreadsheet_column_values.hh>

Public Member Functions
	ColumnValues (std::string name, GVArray data, const ColumnValueDisplayHint display_hint=ColumnValueDisplayHint::None)
virtual	~ColumnValues ()=default
eSpreadsheetColumnValueType	type () const
StringRefNull	name () const
int	size () const
const GVArray &	data () const
ColumnValueDisplayHint	display_hint () const
float	fit_column_width_px (const std::optional< int64_t > &max_sample_size=std::nullopt) const
float	fit_column_values_width_px (const std::optional< int64_t > &max_sample_size=std::nullopt) const

Protected Attributes
std::string	name_
GVArray	data_
ColumnValueDisplayHint	display_hint_

Detailed Description

This represents a column in a spreadsheet. It has a name and provides a value for all the cells in the column.

Definition at line 25 of file spreadsheet_column_values.hh.

Constructor & Destructor Documentation

◆ ColumnValues()

blender::ed::spreadsheet::ColumnValues::ColumnValues	(	std::string	name,
		GVArray	data,
		const ColumnValueDisplayHint	display_hint = ColumnValueDisplayHint::None )

inline

Definition at line 33 of file spreadsheet_column_values.hh.

References BLI_assert, data(), data_, display_hint(), display_hint_, name(), name_, and blender::ed::spreadsheet::None.

◆ ~ColumnValues()

virtual blender::ed::spreadsheet::ColumnValues::~ColumnValues ( )

virtualdefault

Member Function Documentation

◆ data()

const GVArray & blender::ed::spreadsheet::ColumnValues::data ( ) const

inline

Definition at line 59 of file spreadsheet_column_values.hh.

References data_.

Referenced by blender::ed::spreadsheet::apply_row_filter(), ColumnValues(), and blender::ed::spreadsheet::SpreadsheetLayoutDrawer::draw_content_cell().

◆ display_hint()

ColumnValueDisplayHint blender::ed::spreadsheet::ColumnValues::display_hint ( ) const

inline

Definition at line 64 of file spreadsheet_column_values.hh.

References display_hint_.

Referenced by ColumnValues(), and blender::ed::spreadsheet::SpreadsheetLayoutDrawer::draw_content_cell_value().

◆ fit_column_values_width_px()

float blender::ed::spreadsheet::ColumnValues::fit_column_values_width_px ( const std::optional< int64_t > & max_sample_size = std::nullopt ) const

Same as above, but only takes the values into account (ignoring the name).

Definition at line 575 of file spreadsheet_layout.cc.

Referenced by fit_column_width_px().

◆ fit_column_width_px()

float blender::ed::spreadsheet::ColumnValues::fit_column_width_px ( const std::optional< int64_t > & max_sample_size = std::nullopt ) const

Get a good column width for the column name and values.

Parameters

max_sample_size If provided, only a subset of the column values are inspected to determine the width. This is useful when there are lots of rows to avoid unnecessarily long computations in drawing code. If provided, there is also an enforced minimum width to avoid very narrow columns when the sampled values all happen to be very short.

Definition at line 742 of file spreadsheet_layout.cc.

References BLF_default(), BLF_size(), BLF_width(), fit_column_values_width_px(), name_, SPREADSHEET_WIDTH_UNIT, UI_DEFAULT_TEXT_POINTS, and UI_SCALE_FAC.

Referenced by blender::ed::spreadsheet::spreadsheet_main_region_draw().