#include <wx_grid.h>

Inheritance diagram for WX_GRID:

Public Member Functions
	WX_GRID (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxWANTS_CHARS, const wxString &name=wxGridNameStr)

	~WX_GRID () override

void	SetColLabelSize (int aHeight)
	Hide wxGrid's SetColLabelSize() method with one which makes sure the size is tall enough for the system GUI font.

void	SetLabelFont (const wxFont &aFont)
	Hide wxGrid's SetLabelFont() because for some reason on MSW it's a one-shot and subsequent calls to it have no effect.

void	EnableAlternateRowColors (bool aEnable=true)
	Enable alternate row highlighting, where every odd row has a different background color than the even rows.

wxString	GetShownColumnsAsString ()
	Get a tokenized string containing the shown column indexes.

std::bitset< 64 >	GetShownColumns ()

void	ShowHideColumns (const wxString &shownColumns)
	Show/hide the grid columns based on a tokenized string of shown column indexes.

void	SetTable (wxGridTableBase *table, bool aTakeOwnership=false)
	Hide wxGrid's SetTable() method with one which doesn't mess up the grid column widths when setting the table.

void	DestroyTable (wxGridTableBase *aTable)
	Work-around for a bug in wxGrid which crashes when deleting the table if the cell edit control was not closed.

bool	CommitPendingChanges (bool aQuietMode=false)
	Close any open cell edit controls.

bool	CancelPendingChanges ()

void	OnAddRow (const std::function< std::pair< int, int >()> &aAdder)

void	OnDeleteRows (const std::function< void(int row)> &aDeleter)
	Handles a row deletion event.

void	OnDeleteRows (const std::function< bool(int row)> &aFilter, const std::function< void(int row)> &aDeleter)

void	SwapRows (int aRowA, int aRowB)
	These aren't that tricky, but might as well share code.

void	OnMoveRowUp (const std::function< void(int row)> &aMover)

void	OnMoveRowDown (const std::function< void(int row)> &aMover)

void	OnMoveRowUp (const std::function< bool(int row)> &aFilter, const std::function< void(int row)> &aMover)

void	OnMoveRowDown (const std::function< bool(int row)> &aFilter, const std::function< void(int row)> &aMover)

void	SetUnitsProvider (UNITS_PROVIDER *aProvider, int aCol=0)
	Set a EUNITS_PROVIDER to enable use of unit- and eval-based Getters.

void	SetAutoEvalCols (const std::vector< int > &aCols)

void	SetAutoEvalColUnits (int col, EDA_UNITS aUnit, EDA_DATA_TYPE aUnitType)
	Set the unit and unit data type to use for a given column.

void	SetAutoEvalColUnits (int col, EDA_UNITS aUnit)
	Set the unit to use for a given column.

int	GetUnitValue (int aRow, int aCol)
	Apply standard KiCad unit and eval services to a numeric cell.

std::optional< int >	GetOptionalUnitValue (int aRow, int aCol)
	Apply standard KiCad unit and eval services to a numeric cell.

void	SetUnitValue (int aRow, int aCol, int aValue)
	Set a unitized cell's value.

void	SetOptionalUnitValue (int aRow, int aCol, std::optional< int > aValue)
	Set a unitized cell's optional value.

int	GetVisibleWidth (int aCol, bool aHeader=true, bool aContents=true, bool aKeep=false)
	Calculate the specified column based on the actual size of the text on screen.

void	EnsureColLabelsVisible ()
	Ensure the height of the row displaying the column labels is enough, even if labels are multiline texts.

void	ShowEditorOnMouseUp ()
	WxWidgets has a bunch of bugs in its handling of wxGrid mouse events which close cell editors right after opening them.

void	CancelShowEditorOnMouseUp ()

void	ClearRows (bool aUpdateLabels=true)
	wxWidgets recently added an ASSERT which fires if the position is greater than or equal to the number of rows (even if the delete count is 0).

void	OverrideMinSize (double aXPct, double aYPct)
	Grids that have column sizes automatically set to fill the available width don't want to shrink afterwards (because wxGrid reports the aggregate column size as the bestSize.

void	SetMinVisibleRows (wxWindow *aDialog, int aMinRows)
	Floor this grid at aMinRows visible rows and grow aDialog so it opens tall enough to show every current row.

wxSize	DoGetBestSize () const override

void	SetupColumnAutosizer (int aFlexibleCol)
	Set autosize behaviour using wxFormBuilder column widths as minimums, with a single specified growable column.

void	SetGridWidthsDirty ()

ROW_ICON_PROVIDER *	GetRowIconProvider () const

void	RecomputeGridWidths ()

Static Public Member Functions
static void	CellEditorSetMargins (wxTextEntryBase *aEntry)
	A helper function to set OS-specific margins for text-based cell editors.

static void	CellEditorTransformSizeRect (wxRect &aRect)
	A helper function to tweak sizes of text-based cell editors depending on OS.

static int	CapHeightToVisibleRows (int aMinHeight, int aHeaderHeight, const std::vector< int > &aRowHeights, int aMaxRows)
	Height of aMaxRows data rows plus the column-label header, never more than aMinHeight.

Protected Member Functions
void	DrawColLabel (wxDC &dc, int col) override
	A re-implementation of wxGrid::DrawColLabel which left-aligns the first column and draws flat borders.

void	DrawRowLabel (wxDC &dc, int row) override
	A re-implementation of wxGrid::DrawRowLabel which draws flat borders.

void	DrawCornerLabel (wxDC &dc) override
	A re-implementation of wxGrid::DrawCornerLabel which draws flat borders.

void	onGridColMove (wxGridEvent &aEvent)

void	onGridCellSelect (wxGridEvent &aEvent)

void	onCellEditorShown (wxGridEvent &aEvent)

void	onCellEditorHidden (wxGridEvent &aEvent)

void	onDPIChanged (wxDPIChangedEvent &event)

UNITS_PROVIDER *	getUnitsProvider (int aCol) const

std::pair< EDA_UNITS, EDA_DATA_TYPE >	getColumnUnits (int aCol) const
	Returns the units and data type associated with a given column.

Protected Attributes
bool	m_weOwnTable

std::map< int, UNITS_PROVIDER * >	m_unitsProviders

std::unique_ptr< NUMERIC_EVALUATOR >	m_eval

std::vector< int >	m_autoEvalCols

std::unordered_map< int, std::pair< EDA_UNITS, EDA_DATA_TYPE > >	m_autoEvalColsUnits

std::map< std::pair< int, int >, std::pair< wxString, wxString > >	m_evalBeforeAfter

std::optional< wxSize >	m_minSizeOverride

std::map< int, int >	m_autosizedCols

int	m_flexibleCol

bool	m_gridWidthsDirty = true

int	m_gridWidth = 0

ROW_ICON_PROVIDER *	m_rowIconProvider

Private Member Functions
void	onSizeEvent (wxSizeEvent &aEvent)

Detailed Description

Definition at line 104 of file wx_grid.h.

Constructor & Destructor Documentation

◆ WX_GRID()

WX_GRID::WX_GRID	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = wxWANTS_CHARS,
		const wxString &	name = wxGridNameStr )

Definition at line 250 of file wx_grid.cpp.

References KIUI::c_IndicatorSizeDIP, KIUI::GetControlFont(), m_rowIconProvider, m_weOwnTable, name, onCellEditorHidden(), onCellEditorShown(), onDPIChanged(), and SetLabelFont().

◆ ~WX_GRID()

WX_GRID::~WX_GRID ( )

override

Definition at line 272 of file wx_grid.cpp.

References DestroyTable(), m_rowIconProvider, m_weOwnTable, onCellEditorHidden(), onCellEditorShown(), and onDPIChanged().

Member Function Documentation

◆ CancelPendingChanges()

bool WX_GRID::CancelPendingChanges ( )

Definition at line 686 of file wx_grid.cpp.

References editor.

◆ CancelShowEditorOnMouseUp()

void WX_GRID::CancelShowEditorOnMouseUp ( )

inline

Definition at line 266 of file wx_grid.h.

◆ CapHeightToVisibleRows()

int WX_GRID::CapHeightToVisibleRows	(	int	aMinHeight,
		int	aHeaderHeight,
		const std::vector< int > &	aRowHeights,
		int	aMaxRows )

static

Height of aMaxRows data rows plus the column-label header, never more than aMinHeight.

Kept a pure function so the row-floor policy is testable without a live grid.

Parameters

aMinHeight	the full-content height; the result never exceeds it.
aHeaderHeight	the height of the column-label header.
aRowHeights	the height of each data row.
aMaxRows	the row cap, or a negative value to return aMinHeight unchanged.

Definition at line 90 of file wx_grid.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and SetMinVisibleRows().

◆ CellEditorSetMargins()

void WX_GRID::CellEditorSetMargins ( wxTextEntryBase * aEntry )

static

A helper function to set OS-specific margins for text-based cell editors.

Definition at line 75 of file wx_grid.cpp.

Referenced by GRID_CELL_FPID_EDITOR::Create(), GRID_CELL_PATH_EDITOR::Create(), GRID_CELL_RUN_FUNCTION_EDITOR::Create(), GRID_CELL_SYMBOL_ID_EDITOR::Create(), and GRID_CELL_URL_EDITOR::Create().

◆ CellEditorTransformSizeRect()

void WX_GRID::CellEditorTransformSizeRect ( wxRect & aRect )

static

A helper function to tweak sizes of text-based cell editors depending on OS.

Definition at line 82 of file wx_grid.cpp.

Referenced by GRID_CELL_STC_EDITOR::SetSize(), GRID_CELL_TEXT_BUTTON::SetSize(), and GRID_CELL_TEXT_EDITOR::SetSize().

◆ ClearRows()

void WX_GRID::ClearRows ( bool aUpdateLabels = true )

inline

wxWidgets recently added an ASSERT which fires if the position is greater than or equal to the number of rows (even if the delete count is 0).

Needless to say, this makes using DeleteRows for clearing a lot more cumbersome so we add a helper here.

Definition at line 273 of file wx_grid.h.

◆ CommitPendingChanges()

bool WX_GRID::CommitPendingChanges ( bool aQuietMode = false )

Close any open cell edit controls.

Parameters

aQuietMode if true don't send events (ie: for row/col delete operations).

Returns: false if validation failed.

Definition at line 714 of file wx_grid.cpp.

References editor.

Referenced by LIB_TABLE_GRID_TRICKS::DeleteRowHandler(), DestroyTable(), OnAddRow(), OnDeleteRows(), onGridColMove(), OnMoveRowDown(), and OnMoveRowUp().

◆ DestroyTable()

void WX_GRID::DestroyTable ( wxGridTableBase * aTable )

Work-around for a bug in wxGrid which crashes when deleting the table if the cell edit control was not closed.

Definition at line 535 of file wx_grid.cpp.

References CommitPendingChanges(), onGridCellSelect(), and onGridColMove().

Referenced by ~WX_GRID().

◆ DoGetBestSize()

wxSize WX_GRID::DoGetBestSize ( ) const

inlineoverride

Definition at line 323 of file wx_grid.h.

References m_minSizeOverride.

Referenced by OverrideMinSize().

◆ DrawColLabel()

void WX_GRID::DrawColLabel	(	wxDC &	dc,
		int	col )

overrideprotected

A re-implementation of wxGrid::DrawColLabel which left-aligns the first column and draws flat borders.

Definition at line 617 of file wx_grid.cpp.

References WX_GRID_COLUMN_HEADER_RENDERER::DrawBorder(), and MIN_GRIDCELL_MARGIN.

◆ DrawCornerLabel()

void WX_GRID::DrawCornerLabel ( wxDC & dc )

overrideprotected

A re-implementation of wxGrid::DrawCornerLabel which draws flat borders.

Definition at line 597 of file wx_grid.cpp.

References WX_GRID_CORNER_HEADER_RENDERER::DrawBorder().

◆ DrawRowLabel()

void WX_GRID::DrawRowLabel	(	wxDC &	dc,
		int	row )

overrideprotected

A re-implementation of wxGrid::DrawRowLabel which draws flat borders.

Definition at line 655 of file wx_grid.cpp.

References WX_GRID_ROW_HEADER_RENDERER::DrawBorder(), and MIN_GRIDCELL_MARGIN.

◆ EnableAlternateRowColors()

void WX_GRID::EnableAlternateRowColors ( bool aEnable = true )

Enable alternate row highlighting, where every odd row has a different background color than the even rows.

Parameters

aEnable flag to specify to enable alternate row striping in the grid.

Definition at line 382 of file wx_grid.cpp.

References table.

Referenced by SetTable().

◆ EnsureColLabelsVisible()

void WX_GRID::EnsureColLabelsVisible ( )

Ensure the height of the row displaying the column labels is enough, even if labels are multiline texts.

Definition at line 1070 of file wx_grid.cpp.

References SetColLabelSize().

Referenced by GetVisibleWidth().

◆ getColumnUnits()

std::pair< EDA_UNITS, EDA_DATA_TYPE > WX_GRID::getColumnUnits ( int aCol ) const

protected

Returns the units and data type associated with a given column.

Definition at line 1098 of file wx_grid.cpp.

References DISTANCE, getUnitsProvider(), UNITS_PROVIDER::GetUserUnits(), and m_autoEvalColsUnits.

Referenced by GetOptionalUnitValue(), GetUnitValue(), and onCellEditorHidden().

◆ GetOptionalUnitValue()

std::optional< int > WX_GRID::GetOptionalUnitValue	(	int	aRow,
		int	aCol )

Apply standard KiCad unit and eval services to a numeric cell.

Parameters

aRow	the cell row index to fetch.
aCol	the cell column index to fetch.

Returns: the value held by the cell in internal units.

Definition at line 979 of file wx_grid.cpp.

References alg::contains(), getColumnUnits(), getUnitsProvider(), m_autoEvalCols, m_eval, UNITS_PROVIDER::NullUiString, and UNITS_PROVIDER::OptionalValueFromString().

◆ GetRowIconProvider()

ROW_ICON_PROVIDER * WX_GRID::GetRowIconProvider ( ) const

inline

Definition at line 339 of file wx_grid.h.

References m_rowIconProvider.

◆ GetShownColumns()

std::bitset< 64 > WX_GRID::GetShownColumns ( )

Definition at line 568 of file wx_grid.cpp.

◆ GetShownColumnsAsString()

wxString WX_GRID::GetShownColumnsAsString ( )

Get a tokenized string containing the shown column indexes.

Tokens are separated by spaces.

Definition at line 549 of file wx_grid.cpp.

◆ getUnitsProvider()

UNITS_PROVIDER * WX_GRID::getUnitsProvider ( int aCol ) const

inlineprotected

Definition at line 367 of file wx_grid.h.

References m_unitsProviders.

Referenced by getColumnUnits(), GetOptionalUnitValue(), GetUnitValue(), onCellEditorHidden(), SetOptionalUnitValue(), and SetUnitValue().

◆ GetUnitValue()

int WX_GRID::GetUnitValue	(	int	aRow,
		int	aCol )

Apply standard KiCad unit and eval services to a numeric cell.

Parameters

aRow	the cell row index to fetch.
aCol	the cell column index to fetch.
aIsOptional	if true, indicates to the unit provider the value is optional.

Returns: the value held by the cell in internal units.

Definition at line 961 of file wx_grid.cpp.

References alg::contains(), getColumnUnits(), getUnitsProvider(), m_autoEvalCols, m_eval, and UNITS_PROVIDER::ValueFromString().

◆ GetVisibleWidth()

int WX_GRID::GetVisibleWidth	(	int	aCol,
		bool	aHeader = true,
		bool	aContents = true,
		bool	aKeep = false )

Calculate the specified column based on the actual size of the text on screen.

Parameters

aCol	is the index of the column to resize. Specify -1 for the row labels.
aHeader	is the header in the width calculation.
aContents	is the full contents of the column.
aKeep	is the current size as a minimum value.

Returns: The maximum value of all calculated widths.

Definition at line 1030 of file wx_grid.cpp.

References EnsureColLabelsVisible().

Referenced by PANEL_SETUP_TRACKS_AND_VIAS::PANEL_SETUP_TRACKS_AND_VIAS().

◆ OnAddRow()

void WX_GRID::OnAddRow ( const std::function< std::pair< int, int >()> & aAdder )

Definition at line 766 of file wx_grid.cpp.

References CommitPendingChanges().

Referenced by LIB_TABLE_GRID_TRICKS::AppendRowHandler(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::onAddGroup().

◆ onCellEditorHidden()

void WX_GRID::onCellEditorHidden ( wxGridEvent & aEvent )

protected

Definition at line 453 of file wx_grid.cpp.

References alg::contains(), getColumnUnits(), getUnitsProvider(), m_autoEvalCols, m_eval, m_evalBeforeAfter, UNITS_PROVIDER::NullUiString, UNITS_PROVIDER::OptionalValueFromString(), UNITS_PROVIDER::StringFromOptionalValue(), UNITS_PROVIDER::StringFromValue(), and UNITS_PROVIDER::ValueFromString().

Referenced by WX_GRID(), and ~WX_GRID().

◆ onCellEditorShown()

void WX_GRID::onCellEditorShown ( wxGridEvent & aEvent )

protected

Definition at line 438 of file wx_grid.cpp.

References alg::contains(), m_autoEvalCols, and m_evalBeforeAfter.

Referenced by WX_GRID(), and ~WX_GRID().

◆ OnDeleteRows() [1/2]

void WX_GRID::OnDeleteRows	(	const std::function< bool(int row)> &	aFilter,
		const std::function< void(int row)> &	aDeleter )

Definition at line 797 of file wx_grid.cpp.

References CommitPendingChanges().

◆ OnDeleteRows() [2/2]

void WX_GRID::OnDeleteRows ( const std::function< void(int row)> & aDeleter )

Handles a row deletion event.

This is a bit tricky due to the potential for stale selections, so we code it only once here.

Definition at line 786 of file wx_grid.cpp.

References OnDeleteRows().

Referenced by OnDeleteRows(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::onRemoveGroup().

◆ onDPIChanged()

void WX_GRID::onDPIChanged ( wxDPIChangedEvent & event )

protected

Definition at line 285 of file wx_grid.cpp.

Referenced by WX_GRID(), and ~WX_GRID().

◆ onGridCellSelect()

void WX_GRID::onGridCellSelect ( wxGridEvent & aEvent )

protected

Definition at line 400 of file wx_grid.cpp.

Referenced by DestroyTable(), and SetTable().

◆ onGridColMove()

void WX_GRID::onGridColMove ( wxGridEvent & aEvent )

protected

Definition at line 1023 of file wx_grid.cpp.

References CommitPendingChanges().

Referenced by DestroyTable(), and SetTable().

◆ OnMoveRowDown() [1/2]

void WX_GRID::OnMoveRowDown	(	const std::function< bool(int row)> &	aFilter,
		const std::function< void(int row)> &	aMover )

Definition at line 917 of file wx_grid.cpp.

References CommitPendingChanges().

◆ OnMoveRowDown() [2/2]

void WX_GRID::OnMoveRowDown ( const std::function< void(int row)> & aMover )

Definition at line 906 of file wx_grid.cpp.

References OnMoveRowDown().

Referenced by LIB_TABLE_GRID_TRICKS::MoveDownHandler(), and OnMoveRowDown().

◆ OnMoveRowUp() [1/2]

void WX_GRID::OnMoveRowUp	(	const std::function< bool(int row)> &	aFilter,
		const std::function< void(int row)> &	aMover )

Definition at line 884 of file wx_grid.cpp.

References CommitPendingChanges().

◆ OnMoveRowUp() [2/2]

void WX_GRID::OnMoveRowUp ( const std::function< void(int row)> & aMover )

Definition at line 873 of file wx_grid.cpp.

References OnMoveRowUp().

Referenced by LIB_TABLE_GRID_TRICKS::MoveUpHandler(), and OnMoveRowUp().

◆ onSizeEvent()

void WX_GRID::onSizeEvent ( wxSizeEvent & aEvent )

private

Definition at line 1185 of file wx_grid.cpp.

References m_gridWidth, and m_gridWidthsDirty.

Referenced by SetupColumnAutosizer().

◆ OverrideMinSize()

void WX_GRID::OverrideMinSize	(	double	aXPct,
		double	aYPct )

inline

Grids that have column sizes automatically set to fill the available width don't want to shrink afterwards (because wxGrid reports the aggregate column size as the bestSize.

Parameters

aXPct	fraction of the best width to advertise as the minimum.
aYPct	fraction of the best height to advertise as the minimum.

Definition at line 296 of file wx_grid.h.

References DoGetBestSize(), KiROUND(), and m_minSizeOverride.

◆ RecomputeGridWidths()

void WX_GRID::RecomputeGridWidths ( )

Definition at line 1143 of file wx_grid.cpp.

References m_autosizedCols, m_flexibleCol, m_gridWidth, and m_gridWidthsDirty.

Referenced by SetupColumnAutosizer().

◆ SetAutoEvalCols()

void WX_GRID::SetAutoEvalCols ( const std::vector< int > & aCols )

inline

Definition at line 199 of file wx_grid.h.

References m_autoEvalCols.

◆ SetAutoEvalColUnits() [1/2]

void WX_GRID::SetAutoEvalColUnits	(	int	col,
		EDA_UNITS	aUnit )

Set the unit to use for a given column.

The unit data type is inferred from the unit type

Definition at line 954 of file wx_grid.cpp.

References UNITS_PROVIDER::GetTypeFromUnits(), and SetAutoEvalColUnits().

◆ SetAutoEvalColUnits() [2/2]

void WX_GRID::SetAutoEvalColUnits	(	int	col,
		EDA_UNITS	aUnit,
		EDA_DATA_TYPE	aUnitType )

Set the unit and unit data type to use for a given column.

Definition at line 948 of file wx_grid.cpp.

References m_autoEvalColsUnits.

Referenced by SetAutoEvalColUnits().

◆ SetColLabelSize()

void WX_GRID::SetColLabelSize ( int aHeight )

Hide wxGrid's SetColLabelSize() method with one which makes sure the size is tall enough for the system GUI font.

Parameters

height

Definition at line 326 of file wx_grid.cpp.

References MIN_GRIDCELL_MARGIN.

Referenced by EnsureColLabelsVisible().

◆ SetGridWidthsDirty()

void WX_GRID::SetGridWidthsDirty ( )

inline

Definition at line 337 of file wx_grid.h.

References m_gridWidthsDirty.

◆ SetLabelFont()

void WX_GRID::SetLabelFont ( const wxFont & aFont )

Hide wxGrid's SetLabelFont() because for some reason on MSW it's a one-shot and subsequent calls to it have no effect.

Definition at line 341 of file wx_grid.cpp.

References KIUI::GetControlFont().

Referenced by WX_GRID().

◆ SetMinVisibleRows()

void WX_GRID::SetMinVisibleRows	(	wxWindow *	aDialog,
		int	aMinRows )

Floor this grid at aMinRows visible rows and grow aDialog so it opens tall enough to show every current row.

The small floor keeps the dialog shrinkable (the grid scrolls past it) while the grow shows all the data when there is room; DIALOG_SHIM::Show() then clamps the grown size to the monitor work area. Call after the rows are populated, e.g. at the end of TransferDataToWindow.

Definition at line 106 of file wx_grid.cpp.

References CapHeightToVisibleRows().

◆ SetOptionalUnitValue()

void WX_GRID::SetOptionalUnitValue	(	int	aRow,
		int	aCol,
		std::optional< int >	aValue )

Set a unitized cell's optional value.

Definition at line 1010 of file wx_grid.cpp.

References DISTANCE, getUnitsProvider(), and m_autoEvalColsUnits.

◆ SetTable()

void WX_GRID::SetTable	(	wxGridTableBase *	table,
		bool	aTakeOwnership = false )

Hide wxGrid's SetTable() method with one which doesn't mess up the grid column widths when setting the table.

Definition at line 347 of file wx_grid.cpp.

References EnableAlternateRowColors(), m_weOwnTable, MIN_GRIDCELL_MARGIN, onGridCellSelect(), onGridColMove(), and Pgm().

◆ SetUnitsProvider()

void WX_GRID::SetUnitsProvider	(	UNITS_PROVIDER *	aProvider,
		int	aCol = 0 )

Set a EUNITS_PROVIDER to enable use of unit- and eval-based Getters.

Parameters

aProvider

Definition at line 939 of file wx_grid.cpp.

References UNITS_PROVIDER::GetUserUnits(), m_eval, and m_unitsProviders.

◆ SetUnitValue()

void WX_GRID::SetUnitValue	(	int	aRow,
		int	aCol,
		int	aValue )

Set a unitized cell's value.

Definition at line 997 of file wx_grid.cpp.

References DISTANCE, getUnitsProvider(), and m_autoEvalColsUnits.

◆ SetupColumnAutosizer()

void WX_GRID::SetupColumnAutosizer ( int aFlexibleCol )

Set autosize behaviour using wxFormBuilder column widths as minimums, with a single specified growable column.

Definition at line 1108 of file wx_grid.cpp.

References m_autosizedCols, m_flexibleCol, m_gridWidthsDirty, onSizeEvent(), and RecomputeGridWidths().

Referenced by FIELDS_GRID_TABLE::initGrid().

◆ ShowEditorOnMouseUp()

void WX_GRID::ShowEditorOnMouseUp ( )

inline

WxWidgets has a bunch of bugs in its handling of wxGrid mouse events which close cell editors right after opening them.

Helpfully, it already has a bunch of work-arounds in place (such as the SetInSetFocus() hack), including one to make slow clicks work. We re-purpose this hack to work-around the bugs when we want to open an editor.

Definition at line 265 of file wx_grid.h.

◆ ShowHideColumns()

void WX_GRID::ShowHideColumns ( const wxString & shownColumns )

Show/hide the grid columns based on a tokenized string of shown column indexes.

Definition at line 579 of file wx_grid.cpp.

◆ SwapRows()

void WX_GRID::SwapRows	(	int	aRowA,
		int	aRowB )

These aren't that tricky, but might as well share code.

Definition at line 862 of file wx_grid.cpp.

Member Data Documentation

◆ m_autoEvalCols

std::vector<int> WX_GRID::m_autoEvalCols

protected

Definition at line 388 of file wx_grid.h.

Referenced by GetOptionalUnitValue(), GetUnitValue(), onCellEditorHidden(), onCellEditorShown(), and SetAutoEvalCols().

◆ m_autoEvalColsUnits

std::unordered_map<int, std::pair<EDA_UNITS, EDA_DATA_TYPE> > WX_GRID::m_autoEvalColsUnits

protected

Definition at line 389 of file wx_grid.h.

Referenced by getColumnUnits(), SetAutoEvalColUnits(), SetOptionalUnitValue(), and SetUnitValue().

◆ m_autosizedCols

std::map<int, int> WX_GRID::m_autosizedCols

protected

Definition at line 394 of file wx_grid.h.

Referenced by RecomputeGridWidths(), and SetupColumnAutosizer().

◆ m_eval

std::unique_ptr<NUMERIC_EVALUATOR> WX_GRID::m_eval

protected

Definition at line 387 of file wx_grid.h.

Referenced by GetOptionalUnitValue(), GetUnitValue(), onCellEditorHidden(), and SetUnitsProvider().

◆ m_evalBeforeAfter

std::map< std::pair<int, int>, std::pair<wxString, wxString> > WX_GRID::m_evalBeforeAfter

protected

Definition at line 390 of file wx_grid.h.

Referenced by onCellEditorHidden(), and onCellEditorShown().

◆ m_flexibleCol

int WX_GRID::m_flexibleCol

protected

Definition at line 395 of file wx_grid.h.

Referenced by RecomputeGridWidths(), and SetupColumnAutosizer().

◆ m_gridWidth

int WX_GRID::m_gridWidth = 0

protected

Definition at line 398 of file wx_grid.h.

Referenced by onSizeEvent(), and RecomputeGridWidths().

◆ m_gridWidthsDirty

bool WX_GRID::m_gridWidthsDirty = true

protected

Definition at line 397 of file wx_grid.h.

Referenced by onSizeEvent(), RecomputeGridWidths(), SetGridWidthsDirty(), and SetupColumnAutosizer().

◆ m_minSizeOverride

std::optional<wxSize> WX_GRID::m_minSizeOverride

protected

Definition at line 392 of file wx_grid.h.

Referenced by DoGetBestSize(), and OverrideMinSize().

◆ m_rowIconProvider

ROW_ICON_PROVIDER* WX_GRID::m_rowIconProvider

protected

Definition at line 404 of file wx_grid.h.

Referenced by GetRowIconProvider(), WX_GRID(), and ~WX_GRID().

◆ m_unitsProviders

std::map<int, UNITS_PROVIDER*> WX_GRID::m_unitsProviders

protected

Definition at line 386 of file wx_grid.h.

Referenced by getUnitsProvider(), and SetUnitsProvider().

◆ m_weOwnTable

bool WX_GRID::m_weOwnTable

protected

Definition at line 384 of file wx_grid.h.

Referenced by SetTable(), WX_GRID(), and ~WX_GRID().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WX_GRID()

◆ ~WX_GRID()

Member Function Documentation

◆ CancelPendingChanges()

◆ CancelShowEditorOnMouseUp()

◆ CapHeightToVisibleRows()

◆ CellEditorSetMargins()

◆ CellEditorTransformSizeRect()

◆ ClearRows()

◆ CommitPendingChanges()

◆ DestroyTable()

◆ DoGetBestSize()

◆ DrawColLabel()

◆ DrawCornerLabel()

◆ DrawRowLabel()

◆ EnableAlternateRowColors()

◆ EnsureColLabelsVisible()

◆ getColumnUnits()

◆ GetOptionalUnitValue()

◆ GetRowIconProvider()

◆ GetShownColumns()

◆ GetShownColumnsAsString()

◆ getUnitsProvider()

◆ GetUnitValue()

◆ GetVisibleWidth()

◆ OnAddRow()

◆ onCellEditorHidden()

◆ onCellEditorShown()

◆ OnDeleteRows() [1/2]

◆ OnDeleteRows() [2/2]

◆ onDPIChanged()

◆ onGridCellSelect()

◆ onGridColMove()

◆ OnMoveRowDown() [1/2]

◆ OnMoveRowDown() [2/2]

◆ OnMoveRowUp() [1/2]

◆ OnMoveRowUp() [2/2]

◆ onSizeEvent()

◆ OverrideMinSize()

◆ RecomputeGridWidths()

◆ SetAutoEvalCols()

◆ SetAutoEvalColUnits() [1/2]

◆ SetAutoEvalColUnits() [2/2]

◆ SetColLabelSize()

◆ SetGridWidthsDirty()

◆ SetLabelFont()

◆ SetMinVisibleRows()

◆ SetOptionalUnitValue()

◆ SetTable()

◆ SetUnitsProvider()

◆ SetUnitValue()

◆ SetupColumnAutosizer()

◆ ShowEditorOnMouseUp()

◆ ShowHideColumns()

◆ SwapRows()

Member Data Documentation

◆ m_autoEvalCols

◆ m_autoEvalColsUnits

◆ m_autosizedCols

◆ m_eval

◆ m_evalBeforeAfter

◆ m_flexibleCol

◆ m_gridWidth

◆ m_gridWidthsDirty

◆ m_minSizeOverride

◆ m_rowIconProvider

◆ m_unitsProviders

◆ m_weOwnTable