Contains everything completly generic to fields tables data models, as well as column functionality that doesn't touch the internal fields data store. More...

#include <fields_table_data_model.h>

Inheritance diagram for FIELDS_TABLE_DATA_MODEL_BASE:

Public Member Functions
	FIELDS_TABLE_DATA_MODEL_BASE ()

	~FIELDS_TABLE_DATA_MODEL_BASE () override

bool	IsEdited ()

virtual void	AddColumn (const wxString &aFieldName, const wxString &aLabel, bool aAddedByUser)=0

void	MoveColumn (int aCol, int aNewPos)

void	RemoveColumn (int aCol)

void	RenameColumn (int aCol, const wxString &newName)

int	GetNumberCols () override

void	SetColLabelValue (int aCol, const wxString &aLabel) override

wxString	GetColLabelValue (int aCol) override

wxString	GetColFieldName (int aCol)

int	GetColDataWidth (int aCol)

int	GetFieldNameCol (const wxString &aFieldName) const

std::vector< BOM_FIELD >	GetFieldsOrdered ()

void	SetFieldsOrder (const std::vector< wxString > &aNewOrder)

bool	IsEmptyCell (int aRow, int aCol) override

bool	ColIsReference (int aCol) const

bool	ColIsQuantity (int aCol) const

bool	ColIsItemNumber (int aCol) const

bool	ColIsValue (int aCol) const

bool	ColIsFootprint (int aCol) const

bool	ColIsAttribute (int aCol) const

bool	ColIsItemProperty (int aCol) const

bool	ColIsComputed (int aCol) const

virtual bool	ColIsItemIdentifier (int aCol) const
	Reference for symbol/fields tables, lib_id for lib tables.

virtual bool	ColIsReadOnly (int aCol) const

bool	HasRowLabelExpanders () const override
	Show grouping controls in the row headers instead of row numbers.

virtual bool	IsCellReadOnly (int aRow, int aCol)

void	SetSorting (int aCol, bool aAscending)

int	GetSortCol ()

bool	GetSortAsc ()

void	EnableRebuilds ()

void	DisableRebuilds ()

virtual void	RebuildRows ()=0

void	SetFilter (const wxString &aFilter)

const wxString &	GetFilter ()

void	SetFilterScope (BOM_FILTER_SCOPE aScope)

BOM_FILTER_SCOPE	GetFilterScope () const

void	SetSelectionItems (const std::unordered_set< KIID_PATH > &aItems)

void	ClearSelectionItems ()

void	SetGroupingEnabled (bool aGroup)

bool	GetGroupingEnabled ()

void	SetIncludeExcludedFromBOM (bool aInclude)

bool	GetIncludeExcludedFromBOM ()

void	SetExcludeDNP (bool aExclude)

bool	GetExcludeDNP ()

void	SetGroupColumn (int aCol, bool aGroup)

bool	GetGroupColumn (int aCol)

void	SetShowColumn (int aCol, bool aShow)

bool	GetShowColumn (int aCol)

void	ApplyBomPreset (const BOM_PRESET &aPreset)

BOM_PRESET	GetBomSettings ()

wxString	Export (const BOM_FMT_PRESET &aSettings)

virtual wxString	GetResolvedValue (int aRow, int aCol)=0

virtual wxString	GetExportValue (int aRow, int aCol, const wxString &aRefDelimiter, const wxString &aRefRangeDelimiter)=0

virtual void	ClearCell (int aRow, int aCol)=0

bool	CanClearCell (int aRow, int aCol)

bool	CanCopyCellFromVariant (int aRow, int aCol)

virtual void	CopyCellFromVariant (int aRow, int aCol, const wxString &aVariantName)=0
	Copy each item's raw source value into the displayed variant, retaining staged edits.

virtual bool	IsCellClear (int aRow, int aCol)=0

virtual bool	IsCellEdited (int aRow, int aCol)=0

bool	IsRowEdited (int aRow)
	Return true if any cell in the row has been edited.

virtual void	RevertRow (int aRow)=0

virtual std::vector< KIID_PATH >	GetRowItemKeys (int aRow) const =0
	Return the stable data-store keys of every item represented by a row.

virtual void	SetCurrentVariant (const wxString &aVariantName)=0
	Select the displayed variant, retaining un-applied edits in every variant.

const wxString &	GetCurrentVariant () const

void	RenameStoredVariant (const wxString &aOldName, const wxString &aNewName)

void	DeleteStoredVariant (const wxString &aName)

void	SetVariantNames (const std::vector< wxString > &aVariantNames)

const std::vector< wxString > &	GetVariantNames () const

bool	HasUndoStateSerialization () const override
	Optional identity-based serialization for the host dialog's Ctrl+Z/Ctrl+Y.

wxString	SerializeUndoState () const override

void	RestoreUndoState (const wxString &aState) override

virtual void	ExpandCollapseRow (int aRow)=0

void	SetColAttr (wxGridCellAttr *aAttr, int aCol) override

wxGridCellAttr *	GetAttr (int aRow, int aCol, wxGridCellAttr::wxAttrKind aKind) override

virtual ROW_STATE	GetRowState (int aRow) const

void	Clear () override

Static Public Attributes
static const wxString	QUANTITY_VARIABLE = wxS( "${QUANTITY}" )

static const wxString	ITEM_NUMBER_VARIABLE = wxS( "${ITEM_NUMBER}" )

Protected Member Functions
virtual bool	fieldIsAttribute (const wxString &aFieldName) const

virtual bool	fieldIsItemProperty (const wxString &aFieldName) const

virtual bool	fieldSupportsVariants (const wxString &aFieldName) const

wxString	fieldVariant (const wxString &aFieldName, const wxString &aVariantName) const

void	updateEditedState ()

virtual wxString	getAttributeResolvedValue (const wxString &aFieldName, bool aValue) const

bool	cellUsesResolvedTextRenderer (int aRow, int aCol)

void	applyResolvedTextRenderer (wxGridCellAttr *aAttr, bool aApplyTint)

bool	cellUsesUrlEditor (int aRow, int aCol)

wxGridCellAttr *	cloneUrlEditorAttr ()

wxGridCellAttr *	applyCellDecorations (wxGridCellAttr *aAttr, int aRow, int aCol)

wxGridCellAttr *	applyFieldPresenceRenderer (wxGridCellAttr *aAttr, int aRow, int aCol)

void	commitPendingGridChanges ()

wxGridCellAttr *	enhanceAttr (wxGridCellAttr *aInputAttr, int aRow, int aCol, wxGridCellAttr::wxAttrKind aKind)

Protected Attributes
wxGridCellRenderer *	m_stripedRenderer

wxGridCellRenderer *	m_resolvedTextRenderer

bool	m_edited

int	m_sortColumn

bool	m_sortAscending

wxString	m_filter

BOM_FILTER_SCOPE	m_filterScope

bool	m_groupingEnabled

bool	m_excludeDNP

bool	m_includeExcluded

bool	m_rebuildsEnabled

std::unordered_set< KIID_PATH >	m_selectionItems
	Items included by the user selection scope.

wxString	m_currentVariant
	Current variant name for highlighting.

std::vector< wxString >	m_variantNames
	Variant names for multi-variant DNP filtering.

std::vector< DATA_MODEL_COL >	m_cols

std::map< KIID_PATH, std::map< wxString, FIELD_STORE_VALUE > >	m_dataStore

std::map< int, wxGridCellAttr * >	m_colAttrs

Detailed Description

Contains everything completly generic to fields tables data models, as well as column functionality that doesn't touch the internal fields data store.

Definition at line 146 of file fields_table_data_model.h.

Constructor & Destructor Documentation

◆ FIELDS_TABLE_DATA_MODEL_BASE()

FIELDS_TABLE_DATA_MODEL_BASE::FIELDS_TABLE_DATA_MODEL_BASE ( )

Definition at line 80 of file fields_table_data_model.cpp.

References m_edited, m_excludeDNP, m_filterScope, m_groupingEnabled, m_includeExcluded, m_rebuildsEnabled, m_resolvedTextRenderer, m_sortAscending, m_sortColumn, m_stripedRenderer, and REFERENCE.

◆ ~FIELDS_TABLE_DATA_MODEL_BASE()

FIELDS_TABLE_DATA_MODEL_BASE::~FIELDS_TABLE_DATA_MODEL_BASE ( )

override

Definition at line 95 of file fields_table_data_model.cpp.

References m_resolvedTextRenderer, and m_stripedRenderer.

Member Function Documentation

◆ AddColumn()

virtual void FIELDS_TABLE_DATA_MODEL_BASE::AddColumn	(	const wxString &	aFieldName,
		const wxString &	aLabel,
		bool	aAddedByUser )

pure virtual

Implemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Referenced by DIALOG_FIELDS_TABLE::AddField(), and ApplyBomPreset().

◆ ApplyBomPreset()

void FIELDS_TABLE_DATA_MODEL_BASE::ApplyBomPreset ( const BOM_PRESET & aPreset )

◆ applyCellDecorations()

wxGridCellAttr * FIELDS_TABLE_DATA_MODEL_BASE::applyCellDecorations	(	wxGridCellAttr *	aAttr,
		int	aRow,
		int	aCol )

protected

Definition at line 188 of file fields_table_data_model.cpp.

◆ applyFieldPresenceRenderer()

wxGridCellAttr * FIELDS_TABLE_DATA_MODEL_BASE::applyFieldPresenceRenderer	(	wxGridCellAttr *	aAttr,
		int	aRow,
		int	aCol )

protected

Definition at line 164 of file fields_table_data_model.cpp.

◆ applyResolvedTextRenderer()

void FIELDS_TABLE_DATA_MODEL_BASE::applyResolvedTextRenderer	(	wxGridCellAttr *	aAttr,
		bool	aApplyTint )

protected

Definition at line 112 of file fields_table_data_model.cpp.

References m_resolvedTextRenderer, FIELDS_TABLE_COLOR::TEXT_VARIABLE_DARK_AMBER(), and FIELDS_TABLE_COLOR::TEXT_VARIABLE_LIGHT_YELLOW().

◆ CanClearCell()

bool FIELDS_TABLE_DATA_MODEL_BASE::CanClearCell	(	int	aRow,
		int	aCol )

Definition at line 505 of file fields_table_data_model.cpp.

References GetDefaultFieldName(), IsCellClear(), IsCellReadOnly(), IsGeneratedField(), m_cols, MANDATORY_FIELDS, and UNTRANSLATED.

Referenced by FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::ClearCell().

◆ CanCopyCellFromVariant()

bool FIELDS_TABLE_DATA_MODEL_BASE::CanCopyCellFromVariant	(	int	aRow,
		int	aCol )

Definition at line 499 of file fields_table_data_model.cpp.

References fieldSupportsVariants(), IsCellReadOnly(), and m_cols.

Referenced by FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::CopyCellFromVariant().

◆ cellUsesResolvedTextRenderer()

bool FIELDS_TABLE_DATA_MODEL_BASE::cellUsesResolvedTextRenderer	(	int	aRow,
		int	aCol )

protected

Definition at line 102 of file fields_table_data_model.cpp.

References ColIsComputed(), ColIsItemIdentifier(), ColIsItemNumber(), ColIsQuantity(), GetNumberCols(), and IsGeneratedValue().

◆ cellUsesUrlEditor()

bool FIELDS_TABLE_DATA_MODEL_BASE::cellUsesUrlEditor	(	int	aRow,
		int	aCol )

protected

Definition at line 133 of file fields_table_data_model.cpp.

References DATASHEET, GetDefaultFieldName(), GetFieldNameCol(), GetNumberCols(), IsURL(), WX_GRID_TABLE_BASE::m_colAttrs, and UNTRANSLATED.

◆ Clear()

void WX_GRID_TABLE_BASE::Clear ( )

inlineoverrideinherited

Definition at line 122 of file wx_grid.h.

◆ ClearCell()

virtual void FIELDS_TABLE_DATA_MODEL_BASE::ClearCell	(	int	aRow,
		int	aCol )

pure virtual

Implemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >, and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL.

◆ ClearSelectionItems()

void FIELDS_TABLE_DATA_MODEL_BASE::ClearSelectionItems ( )

inline

Definition at line 220 of file fields_table_data_model.h.

References m_selectionItems.

◆ cloneUrlEditorAttr()

wxGridCellAttr * FIELDS_TABLE_DATA_MODEL_BASE::cloneUrlEditorAttr ( )

protected

Definition at line 152 of file fields_table_data_model.cpp.

References DATASHEET, GetDefaultFieldName(), GetFieldNameCol(), WX_GRID_TABLE_BASE::m_colAttrs, and UNTRANSLATED.

◆ ColIsAttribute()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsAttribute ( int aCol ) const

Definition at line 458 of file fields_table_data_model.cpp.

References fieldIsAttribute(), and m_cols.

Referenced by FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::allRowItemsHaveAttributeForcedOnBySheet(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::CopyCellFromVariant(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::GetGroupedValue(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::groupMatch(), and FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::MatchesFilter().

◆ ColIsComputed()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsComputed ( int aCol ) const

Definition at line 474 of file fields_table_data_model.cpp.

References ColIsItemProperty(), IsGeneratedField(), and m_cols.

Referenced by cellUsesResolvedTextRenderer(), ColIsReadOnly(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::GetGroupedValue(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::groupMatch(), and FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::MatchesFilter().

◆ ColIsFootprint()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsFootprint ( int aCol ) const

Definition at line 451 of file fields_table_data_model.cpp.

References FOOTPRINT, GetDefaultFieldName(), m_cols, and UNTRANSLATED.

◆ ColIsItemIdentifier()

virtual bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsItemIdentifier ( int aCol ) const

inlinevirtual

Reference for symbol/fields tables, lib_id for lib tables.

Reimplemented in LIB_FIELDS_EDITOR_GRID_DATA_MODEL, and LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 198 of file fields_table_data_model.h.

References ColIsReference().

Referenced by ApplyBomPreset(), cellUsesResolvedTextRenderer(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::cmpRows(), ColIsReadOnly(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::GetGroupedValue(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::groupMatch(), and FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::resolveStoredTextVar().

◆ ColIsItemNumber()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsItemNumber ( int aCol ) const

Definition at line 437 of file fields_table_data_model.cpp.

References ITEM_NUMBER_VARIABLE, and m_cols.

Referenced by cellUsesResolvedTextRenderer(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::GetGroupedValue(), and SetGroupColumn().

◆ ColIsItemProperty()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsItemProperty ( int aCol ) const

Definition at line 466 of file fields_table_data_model.cpp.

References fieldIsItemProperty(), and m_cols.

Referenced by ColIsComputed().

◆ ColIsQuantity()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsQuantity ( int aCol ) const

Definition at line 430 of file fields_table_data_model.cpp.

References m_cols, and QUANTITY_VARIABLE.

Referenced by cellUsesResolvedTextRenderer(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::GetGroupedValue(), and SetGroupColumn().

◆ ColIsReadOnly()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsReadOnly ( int aCol ) const

virtual

Reimplemented in FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 482 of file fields_table_data_model.cpp.

References ColIsComputed(), ColIsItemIdentifier(), and m_cols.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ColIsReadOnly(), and IsCellReadOnly().

◆ ColIsReference()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsReference ( int aCol ) const

Definition at line 423 of file fields_table_data_model.cpp.

References GetDefaultFieldName(), m_cols, REFERENCE, and UNTRANSLATED.

Referenced by ColIsItemIdentifier(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::GetGroupedValue(), and FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::groupMatch().

◆ ColIsValue()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsValue ( int aCol ) const

Definition at line 444 of file fields_table_data_model.cpp.

References GetDefaultFieldName(), m_cols, UNTRANSLATED, and VALUE.

◆ commitPendingGridChanges()

void FIELDS_TABLE_DATA_MODEL_BASE::commitPendingGridChanges ( )

protected

Definition at line 220 of file fields_table_data_model.cpp.

References grid.

Referenced by FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::AddColumn(), DeleteStoredVariant(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::refreshDataStoreItem(), RemoveColumn(), RenameStoredVariant(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::SetCurrentVariant(), and SetFieldsOrder().

◆ CopyCellFromVariant()

virtual void FIELDS_TABLE_DATA_MODEL_BASE::CopyCellFromVariant	(	int	aRow,
		int	aCol,
		const wxString &	aVariantName )

pure virtual

Copy each item's raw source value into the displayed variant, retaining staged edits.

Implemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

◆ DeleteStoredVariant()

void FIELDS_TABLE_DATA_MODEL_BASE::DeleteStoredVariant ( const wxString & aName )

Definition at line 848 of file fields_table_data_model.cpp.

References commitPendingGridChanges(), m_dataStore, name, and updateEditedState().

◆ DisableRebuilds()

void FIELDS_TABLE_DATA_MODEL_BASE::DisableRebuilds ( )

Definition at line 557 of file fields_table_data_model.cpp.

References m_rebuildsEnabled.

Referenced by DIALOG_FIELDS_TABLE::doApplyBomPreset().

◆ EnableRebuilds()

void FIELDS_TABLE_DATA_MODEL_BASE::EnableRebuilds ( )

Definition at line 551 of file fields_table_data_model.cpp.

References m_rebuildsEnabled.

Referenced by DIALOG_FIELDS_TABLE::doApplyBomPreset().

◆ enhanceAttr()

wxGridCellAttr * WX_GRID_TABLE_BASE::enhanceAttr	(	wxGridCellAttr *	aInputAttr,
		int	aRow,
		int	aCol,
		wxGridCellAttr::wxAttrKind	aKind )

protectedinherited

Definition at line 43 of file wx_grid.cpp.

Referenced by FIELDS_GRID_TABLE::GetAttr(), LAYERS_GRID_TABLE::GetAttr(), LIB_TABLE_GRID_DATA_MODEL::GetAttr(), PCB_FIELDS_GRID_TABLE::GetAttr(), SCH_PIN_TABLE_DATA_MODEL::GetAttr(), and GetAttr().

◆ ExpandCollapseRow()

virtual void FIELDS_TABLE_DATA_MODEL_BASE::ExpandCollapseRow ( int aRow )

pure virtual

Implemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Referenced by DIALOG_FIELDS_TABLE::OnTableLabelClick().

◆ Export()

wxString FIELDS_TABLE_DATA_MODEL_BASE::Export ( const BOM_FMT_PRESET & aSettings )

Definition at line 683 of file fields_table_data_model.cpp.

References BOM_FMT_PRESET::fieldDelimiter, GetExportValue(), WX_GRID_TABLE_BASE::GetRowState(), BOM_FMT_PRESET::includeByteOrderMark, BOM_FMT_PRESET::keepLineBreaks, BOM_FMT_PRESET::keepTabs, m_cols, BOM_FMT_PRESET::refDelimiter, BOM_FMT_PRESET::refRangeDelimiter, and BOM_FMT_PRESET::stringDelimiter.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), and PCBNEW_JOBS_HANDLER::JobExportBom().

◆ fieldIsAttribute()

bool FIELDS_TABLE_DATA_MODEL_BASE::fieldIsAttribute ( const wxString & aFieldName ) const

protectedvirtual

Reimplemented in LIB_FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 757 of file fields_table_data_model.cpp.

Referenced by ColIsAttribute(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::fieldIsAttribute(), and fieldIsItemProperty().

◆ fieldIsItemProperty()

bool FIELDS_TABLE_DATA_MODEL_BASE::fieldIsItemProperty ( const wxString & aFieldName ) const

protectedvirtual

Reimplemented in LIB_FIELDS_EDITOR_GRID_DATA_MODEL, and LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 765 of file fields_table_data_model.cpp.

References fieldIsAttribute().

Referenced by ColIsItemProperty(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::fieldIsItemProperty(), and LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::fieldIsItemProperty().

◆ fieldSupportsVariants()

virtual bool FIELDS_TABLE_DATA_MODEL_BASE::fieldSupportsVariants ( const wxString & aFieldName ) const

inlineprotectedvirtual

Reimplemented in FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL, LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL, and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 299 of file fields_table_data_model.h.

Referenced by CanCopyCellFromVariant(), and fieldVariant().

◆ fieldVariant()

wxString FIELDS_TABLE_DATA_MODEL_BASE::fieldVariant	(	const wxString &	aFieldName,
		const wxString &	aVariantName ) const

protected

Definition at line 791 of file fields_table_data_model.cpp.

References fieldSupportsVariants().

Referenced by FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::getStoredFieldValue(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::setStoredFieldValue(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::storedField(), and FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::updateDataStoreItemFieldFromLive().

◆ GetAttr()

wxGridCellAttr * WX_GRID_TABLE_BASE::GetAttr	(	int	aRow,
		int	aCol,
		wxGridCellAttr::wxAttrKind	aKind )

inlineoverrideinherited

Definition at line 96 of file wx_grid.h.

References enhanceAttr(), and m_colAttrs.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ getAttributeResolvedValue()

wxString FIELDS_TABLE_DATA_MODEL_BASE::getAttributeResolvedValue	(	const wxString &	aFieldName,
		bool	aValue ) const

protectedvirtual

Reimplemented in LIB_FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 771 of file fields_table_data_model.cpp.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeResolvedValue(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::GetGroupedValue(), and FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::MatchesFilter().

◆ GetBomSettings()

BOM_PRESET FIELDS_TABLE_DATA_MODEL_BASE::GetBomSettings ( )

Definition at line 663 of file fields_table_data_model.cpp.

References GetColFieldName(), GetExcludeDNP(), GetFieldsOrdered(), GetFilter(), GetFilterScope(), GetGroupingEnabled(), GetIncludeExcludedFromBOM(), GetNumberCols(), GetSortAsc(), and GetSortCol().

Referenced by DIALOG_FIELDS_TABLE::getDataModelBomPreset(), DIALOG_FIELDS_TABLE::saveJobSettings(), and DIALOG_FIELDS_TABLE::savePresets().

◆ GetColDataWidth()

int FIELDS_TABLE_DATA_MODEL_BASE::GetColDataWidth ( int aCol )

Definition at line 365 of file fields_table_data_model.cpp.

References GetColLabelValue(), GetResolvedValue(), and KIUI::GetTextSize().

Referenced by DIALOG_FIELDS_TABLE::SetupAllColumnProperties().

◆ GetColFieldName()

wxString FIELDS_TABLE_DATA_MODEL_BASE::GetColFieldName ( int aCol )

Definition at line 358 of file fields_table_data_model.cpp.

References m_cols.

Referenced by GetBomSettings().

◆ GetColLabelValue()

wxString FIELDS_TABLE_DATA_MODEL_BASE::GetColLabelValue ( int aCol )

override

Definition at line 351 of file fields_table_data_model.cpp.

References m_cols.

Referenced by DIALOG_FIELDS_TABLE::doApplyBomPreset(), and GetColDataWidth().

◆ GetCurrentVariant()

const wxString & FIELDS_TABLE_DATA_MODEL_BASE::GetCurrentVariant ( ) const

inline

Definition at line 272 of file fields_table_data_model.h.

References m_currentVariant.

◆ GetExcludeDNP()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetExcludeDNP ( )

inline

Definition at line 233 of file fields_table_data_model.h.

References m_excludeDNP.

Referenced by GetBomSettings().

◆ GetExportValue()

virtual wxString FIELDS_TABLE_DATA_MODEL_BASE::GetExportValue	(	int	aRow,
		int	aCol,
		const wxString &	aRefDelimiter,
		const wxString &	aRefRangeDelimiter )

pure virtual

Implemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Referenced by Export().

◆ GetFieldNameCol()

int FIELDS_TABLE_DATA_MODEL_BASE::GetFieldNameCol ( const wxString & aFieldName ) const

Definition at line 376 of file fields_table_data_model.cpp.

References FieldNamesAreDuplicates(), and m_cols.

Referenced by FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::AddColumn(), ApplyBomPreset(), cellUsesUrlEditor(), cloneUrlEditorAttr(), DIALOG_FIELDS_TABLE::doApplyBomPreset(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), DIALOG_FIELDS_TABLE::OnRemoveField(), DIALOG_FIELDS_TABLE::OnRenameField(), DIALOG_FIELDS_TABLE::OnViewControlsCellChanged(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::resolveStoredTextVar(), and DIALOG_FIELDS_TABLE::SetupAllColumnProperties().

◆ GetFieldsOrdered()

std::vector< BOM_FIELD > FIELDS_TABLE_DATA_MODEL_BASE::GetFieldsOrdered ( )

Definition at line 388 of file fields_table_data_model.cpp.

References m_cols.

Referenced by GetBomSettings(), EESCHEMA_JOBS_HANDLER::JobExportBom(), and PCBNEW_JOBS_HANDLER::JobExportBom().

◆ GetFilter()

const wxString & FIELDS_TABLE_DATA_MODEL_BASE::GetFilter ( )

inline

Definition at line 215 of file fields_table_data_model.h.

References m_filter.

Referenced by GetBomSettings().

◆ GetFilterScope()

BOM_FILTER_SCOPE FIELDS_TABLE_DATA_MODEL_BASE::GetFilterScope ( ) const

inline

Definition at line 217 of file fields_table_data_model.h.

References m_filterScope.

Referenced by GetBomSettings().

◆ GetGroupColumn()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetGroupColumn ( int aCol )

Definition at line 574 of file fields_table_data_model.cpp.

References m_cols.

Referenced by DIALOG_FIELDS_TABLE::doApplyBomPreset().

◆ GetGroupingEnabled()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetGroupingEnabled ( )

inline

Definition at line 223 of file fields_table_data_model.h.

References m_groupingEnabled.

Referenced by GetBomSettings().

◆ GetIncludeExcludedFromBOM()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetIncludeExcludedFromBOM ( )

inline

Definition at line 230 of file fields_table_data_model.h.

References m_includeExcluded.

Referenced by GetBomSettings(), and DIALOG_FIELDS_TABLE::PreviewRefresh().

◆ GetNumberCols()

int FIELDS_TABLE_DATA_MODEL_BASE::GetNumberCols ( )

inlineoverride

Definition at line 163 of file fields_table_data_model.h.

References m_cols.

Referenced by ApplyBomPreset(), cellUsesResolvedTextRenderer(), cellUsesUrlEditor(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::cmpRows(), GetBomSettings(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::GetValue(), IsCellReadOnly(), IsRowEdited(), and DIALOG_FIELDS_TABLE::OnAddField().

◆ GetResolvedValue()

virtual wxString FIELDS_TABLE_DATA_MODEL_BASE::GetResolvedValue	(	int	aRow,
		int	aCol )

pure virtual

Implemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Referenced by GetColDataWidth().

◆ GetRowItemKeys()

virtual std::vector< KIID_PATH > FIELDS_TABLE_DATA_MODEL_BASE::GetRowItemKeys ( int aRow ) const

pure virtual

Return the stable data-store keys of every item represented by a row.

Implemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

◆ GetRowState()

virtual ROW_STATE WX_GRID_TABLE_BASE::GetRowState ( int aRow ) const

inlinevirtualinherited

Reimplemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Definition at line 109 of file wx_grid.h.

References ROW_STATE::ROW_STATE.

Referenced by FIELDS_TABLE_DATA_MODEL_BASE::Export(), and DIALOG_FIELDS_TABLE::OnTableLabelClick().

◆ GetShowColumn()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetShowColumn ( int aCol )

Definition at line 588 of file fields_table_data_model.cpp.

References m_cols.

Referenced by DIALOG_FIELDS_TABLE::doApplyBomPreset().

◆ GetSortAsc()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetSortAsc ( )

inline

Definition at line 206 of file fields_table_data_model.h.

References m_sortAscending.

Referenced by GetBomSettings(), and DIALOG_FIELDS_TABLE::SetupAllColumnProperties().

◆ GetSortCol()

int FIELDS_TABLE_DATA_MODEL_BASE::GetSortCol ( )

inline

Definition at line 205 of file fields_table_data_model.h.

References m_sortColumn.

Referenced by GetBomSettings().

◆ GetVariantNames()

const std::vector< wxString > & FIELDS_TABLE_DATA_MODEL_BASE::GetVariantNames ( ) const

inline

Definition at line 278 of file fields_table_data_model.h.

References m_variantNames.

◆ HasRowLabelExpanders()

bool FIELDS_TABLE_DATA_MODEL_BASE::HasRowLabelExpanders ( ) const

inlineoverridevirtual

Show grouping controls in the row headers instead of row numbers.

Reimplemented from WX_GRID_TABLE_BASE.

Definition at line 201 of file fields_table_data_model.h.

◆ HasUndoStateSerialization()

bool FIELDS_TABLE_DATA_MODEL_BASE::HasUndoStateSerialization ( ) const

inlineoverridevirtual

Optional identity-based serialization for the host dialog's Ctrl+Z/Ctrl+Y.

The dialog's generic grid undo snapshots cells by (row, col) position, which is wrong for tables whose rows can regroup/sort/reorder. A table that returns true here is asked to serialize and restore its own state by stable identity instead.

Reimplemented from WX_GRID_TABLE_BASE.

Definition at line 282 of file fields_table_data_model.h.

◆ IsCellClear()

virtual bool FIELDS_TABLE_DATA_MODEL_BASE::IsCellClear	(	int	aRow,
		int	aCol )

pure virtual

Implemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Referenced by CanClearCell().

◆ IsCellEdited()

virtual bool FIELDS_TABLE_DATA_MODEL_BASE::IsCellEdited	(	int	aRow,
		int	aCol )

pure virtual

Implemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Referenced by IsRowEdited().

◆ IsCellReadOnly()

bool FIELDS_TABLE_DATA_MODEL_BASE::IsCellReadOnly	(	int	aRow,
		int	aCol )

virtual

Reimplemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >, and LIB_FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 490 of file fields_table_data_model.cpp.

References ColIsReadOnly(), and GetNumberCols().

Referenced by CanClearCell(), CanCopyCellFromVariant(), and FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::IsCellReadOnly().

◆ IsEdited()

bool FIELDS_TABLE_DATA_MODEL_BASE::IsEdited ( )

inline

Definition at line 155 of file fields_table_data_model.h.

References m_edited.

◆ IsEmptyCell()

bool FIELDS_TABLE_DATA_MODEL_BASE::IsEmptyCell	(	int	aRow,
		int	aCol )

inlineoverride

Definition at line 174 of file fields_table_data_model.h.

◆ IsRowEdited()

bool FIELDS_TABLE_DATA_MODEL_BASE::IsRowEdited ( int aRow )

Return true if any cell in the row has been edited.

Definition at line 529 of file fields_table_data_model.cpp.

References GetNumberCols(), and IsCellEdited().

◆ MoveColumn()

void FIELDS_TABLE_DATA_MODEL_BASE::MoveColumn	(	int	aCol,
		int	aNewPos )

Definition at line 227 of file fields_table_data_model.cpp.

References m_cols.

Referenced by DIALOG_FIELDS_TABLE::OnColMove().

◆ RebuildRows()

virtual void FIELDS_TABLE_DATA_MODEL_BASE::RebuildRows ( )

pure virtual

Implemented in FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL, LIB_FIELDS_EDITOR_GRID_DATA_MODEL, and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL.

Referenced by ApplyBomPreset(), DIALOG_FIELDS_TABLE::doApplyBomPreset(), DIALOG_FIELDS_TABLE::OnColSort(), DIALOG_FIELDS_TABLE::OnFilterScope(), DIALOG_FIELDS_TABLE::OnFilterText(), DIALOG_FIELDS_TABLE::OnGroupSymbolsToggled(), DIALOG_FIELDS_TABLE::OnRegroupSymbols(), DIALOG_FIELDS_TABLE::OnRenameField(), DIALOG_FIELDS_TABLE::OnViewControlsCellChanged(), DIALOG_FIELDS_TABLE::PreviewRefresh(), RestoreUndoState(), and DIALOG_FIELDS_TABLE::ShowHideColumn().

◆ RemoveColumn()

void FIELDS_TABLE_DATA_MODEL_BASE::RemoveColumn ( int aCol )

Definition at line 260 of file fields_table_data_model.cpp.

References commitPendingGridChanges(), m_cols, m_dataStore, FIELD_STORE_VALUE::m_present, and FIELD_STORE_VALUE::m_variants.

Referenced by DIALOG_FIELDS_TABLE::OnRemoveField().

◆ RenameColumn()

void FIELDS_TABLE_DATA_MODEL_BASE::RenameColumn	(	int	aCol,
		const wxString &	newName )

Definition at line 305 of file fields_table_data_model.cpp.

Referenced by DIALOG_FIELDS_TABLE::OnRenameField().

◆ RenameStoredVariant()

void FIELDS_TABLE_DATA_MODEL_BASE::RenameStoredVariant	(	const wxString &	aOldName,
		const wxString &	aNewName )

Definition at line 827 of file fields_table_data_model.cpp.

References commitPendingGridChanges(), m_currentVariant, m_dataStore, and name.

◆ RestoreUndoState()

void FIELDS_TABLE_DATA_MODEL_BASE::RestoreUndoState ( const wxString & aState )

overridevirtual

Reimplemented from WX_GRID_TABLE_BASE.

Definition at line 893 of file fields_table_data_model.cpp.

References FIELD_STORE_VALUE::m_baselinePresent, m_currentVariant, m_dataStore, FIELD_STORE_VALUE::m_present, FIELD_STORE_VALUE::m_variants, RebuildRows(), and SetCurrentVariant().

◆ RevertRow()

virtual void FIELDS_TABLE_DATA_MODEL_BASE::RevertRow ( int aRow )

pure virtual

Implemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >, and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL.

◆ SerializeUndoState()

wxString FIELDS_TABLE_DATA_MODEL_BASE::SerializeUndoState ( ) const

overridevirtual

Reimplemented from WX_GRID_TABLE_BASE.

Definition at line 862 of file fields_table_data_model.cpp.

References m_dataStore, and name.

◆ SetColAttr()

void WX_GRID_TABLE_BASE::SetColAttr	(	wxGridCellAttr *	aAttr,
		int	aCol )

inlineoverrideinherited

Definition at line 90 of file wx_grid.h.

References m_colAttrs.

Referenced by DIALOG_FIELDS_TABLE::SetupColumnProperties().

◆ SetColLabelValue()

void FIELDS_TABLE_DATA_MODEL_BASE::SetColLabelValue	(	int	aCol,
		const wxString &	aLabel )

override

Definition at line 342 of file fields_table_data_model.cpp.

References FinalizeTextVarExpansion(), FOR_GUI, and m_cols.

Referenced by ApplyBomPreset(), and DIALOG_FIELDS_TABLE::OnViewControlsCellChanged().

◆ SetCurrentVariant()

virtual void FIELDS_TABLE_DATA_MODEL_BASE::SetCurrentVariant ( const wxString & aVariantName )

pure virtual

Select the displayed variant, retaining un-applied edits in every variant.

Refresh live baselines without replacing staged edits to unchanged fields. Cells that differ from the default (non-variant) value will be highlighted.

Parameters

aVariantName The name of the current variant, or empty string for default.

Implemented in FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >, and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Referenced by DIALOG_FIELDS_TABLE::doApplyBomPreset(), and RestoreUndoState().

◆ SetExcludeDNP()

void FIELDS_TABLE_DATA_MODEL_BASE::SetExcludeDNP ( bool aExclude )

inline

Definition at line 232 of file fields_table_data_model.h.

References m_excludeDNP.

Referenced by ApplyBomPreset().

◆ SetFieldsOrder()

void FIELDS_TABLE_DATA_MODEL_BASE::SetFieldsOrder ( const std::vector< wxString > & aNewOrder )

Definition at line 399 of file fields_table_data_model.cpp.

References commitPendingGridChanges(), and m_cols.

Referenced by ApplyBomPreset().

◆ SetFilter()

void FIELDS_TABLE_DATA_MODEL_BASE::SetFilter ( const wxString & aFilter )

inline

Definition at line 214 of file fields_table_data_model.h.

References m_filter.

Referenced by ApplyBomPreset(), and DIALOG_FIELDS_TABLE::OnFilterText().

◆ SetFilterScope()

void FIELDS_TABLE_DATA_MODEL_BASE::SetFilterScope ( BOM_FILTER_SCOPE aScope )

inline

Definition at line 216 of file fields_table_data_model.h.

References m_filterScope.

Referenced by ApplyBomPreset(), and DIALOG_FIELDS_TABLE::OnFilterScope().

◆ SetGroupColumn()

void FIELDS_TABLE_DATA_MODEL_BASE::SetGroupColumn	(	int	aCol,
		bool	aGroup )

Definition at line 563 of file fields_table_data_model.cpp.

References ColIsItemNumber(), ColIsQuantity(), and m_cols.

Referenced by ApplyBomPreset(), and DIALOG_FIELDS_TABLE::OnViewControlsCellChanged().

◆ SetGroupingEnabled()

void FIELDS_TABLE_DATA_MODEL_BASE::SetGroupingEnabled ( bool aGroup )

inline

Definition at line 222 of file fields_table_data_model.h.

References m_groupingEnabled.

Referenced by ApplyBomPreset(), and DIALOG_FIELDS_TABLE::OnGroupSymbolsToggled().

◆ SetIncludeExcludedFromBOM()

void FIELDS_TABLE_DATA_MODEL_BASE::SetIncludeExcludedFromBOM ( bool aInclude )

inline

Definition at line 229 of file fields_table_data_model.h.

References m_includeExcluded.

Referenced by ApplyBomPreset(), and DIALOG_FIELDS_TABLE::PreviewRefresh().

◆ SetSelectionItems()

void FIELDS_TABLE_DATA_MODEL_BASE::SetSelectionItems ( const std::unordered_set< KIID_PATH > & aItems )

inline

Definition at line 219 of file fields_table_data_model.h.

References m_selectionItems.

◆ SetShowColumn()

void FIELDS_TABLE_DATA_MODEL_BASE::SetShowColumn	(	int	aCol,
		bool	aShow )

Definition at line 581 of file fields_table_data_model.cpp.

References m_cols.

Referenced by ApplyBomPreset(), DIALOG_FIELDS_TABLE::SetupAllColumnProperties(), and DIALOG_FIELDS_TABLE::ShowHideColumn().

◆ SetSorting()

void FIELDS_TABLE_DATA_MODEL_BASE::SetSorting	(	int	aCol,
		bool	aAscending )

Definition at line 543 of file fields_table_data_model.cpp.

References m_cols, m_sortAscending, and m_sortColumn.

Referenced by ApplyBomPreset(), DIALOG_FIELDS_TABLE::OnColSort(), and DIALOG_FIELDS_TABLE::SetupAllColumnProperties().

◆ SetVariantNames()

void FIELDS_TABLE_DATA_MODEL_BASE::SetVariantNames ( const std::vector< wxString > & aVariantNames )

inline

Definition at line 277 of file fields_table_data_model.h.

References m_variantNames.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), and PCBNEW_JOBS_HANDLER::JobExportBom().

◆ updateEditedState()

void FIELDS_TABLE_DATA_MODEL_BASE::updateEditedState ( )

protected

Definition at line 797 of file fields_table_data_model.cpp.

References m_dataStore, m_edited, and name.

Referenced by FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::CopyCellFromVariant(), DeleteStoredVariant(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::RevertRow(), and FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::SetCurrentVariant().

Member Data Documentation

◆ ITEM_NUMBER_VARIABLE

const wxString FIELDS_TABLE_DATA_MODEL_BASE::ITEM_NUMBER_VARIABLE = wxS( "${ITEM_NUMBER}" )

static

Definition at line 153 of file fields_table_data_model.h.

Referenced by ColIsItemNumber(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), DIALOG_FOOTPRINT_FIELDS_TABLE::LoadFieldNames(), and DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames().

◆ m_colAttrs

std::map<int, wxGridCellAttr*> WX_GRID_TABLE_BASE::m_colAttrs

protectedinherited

Definition at line 133 of file wx_grid.h.

Referenced by FIELDS_TABLE_DATA_MODEL_BASE::cellUsesUrlEditor(), FIELDS_TABLE_DATA_MODEL_BASE::cloneUrlEditorAttr(), GetAttr(), SetColAttr(), and ~WX_GRID_TABLE_BASE().

◆ m_cols

std::vector<DATA_MODEL_COL> FIELDS_TABLE_DATA_MODEL_BASE::m_cols

protected

Definition at line 339 of file fields_table_data_model.h.

◆ m_currentVariant

wxString FIELDS_TABLE_DATA_MODEL_BASE::m_currentVariant

protected

Current variant name for highlighting.

Definition at line 335 of file fields_table_data_model.h.

Referenced by FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::attributeForcedOnBySheet(), GetCurrentVariant(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::getStoredFieldValue(), RenameStoredVariant(), RestoreUndoState(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::SetCurrentVariant(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::setStoredFieldValue(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::storedField(), and FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::updateDataStoreItemFieldFromLive().

◆ m_dataStore

std::map<KIID_PATH, std::map<wxString, FIELD_STORE_VALUE> > FIELDS_TABLE_DATA_MODEL_BASE::m_dataStore

protected

Definition at line 363 of file fields_table_data_model.h.

◆ m_edited

bool FIELDS_TABLE_DATA_MODEL_BASE::m_edited

protected

Definition at line 322 of file fields_table_data_model.h.

Referenced by FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::AddColumn(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::ClearCell(), FIELDS_TABLE_DATA_MODEL_BASE(), IsEdited(), and updateEditedState().

◆ m_excludeDNP

bool FIELDS_TABLE_DATA_MODEL_BASE::m_excludeDNP

protected

Definition at line 328 of file fields_table_data_model.h.

Referenced by FIELDS_TABLE_DATA_MODEL_BASE(), GetExcludeDNP(), and SetExcludeDNP().

◆ m_filter

wxString FIELDS_TABLE_DATA_MODEL_BASE::m_filter

protected

Definition at line 325 of file fields_table_data_model.h.

Referenced by GetFilter(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::MatchesFilter(), and SetFilter().

◆ m_filterScope

BOM_FILTER_SCOPE FIELDS_TABLE_DATA_MODEL_BASE::m_filterScope

protected

Definition at line 326 of file fields_table_data_model.h.

Referenced by FIELDS_TABLE_DATA_MODEL_BASE(), GetFilterScope(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::MatchesFilter(), and SetFilterScope().

◆ m_groupingEnabled

bool FIELDS_TABLE_DATA_MODEL_BASE::m_groupingEnabled

protected

Definition at line 327 of file fields_table_data_model.h.

Referenced by FIELDS_TABLE_DATA_MODEL_BASE(), GetGroupingEnabled(), and SetGroupingEnabled().

◆ m_includeExcluded

bool FIELDS_TABLE_DATA_MODEL_BASE::m_includeExcluded

protected

Definition at line 329 of file fields_table_data_model.h.

Referenced by FIELDS_TABLE_DATA_MODEL_BASE(), GetIncludeExcludedFromBOM(), and SetIncludeExcludedFromBOM().

◆ m_rebuildsEnabled

bool FIELDS_TABLE_DATA_MODEL_BASE::m_rebuildsEnabled

protected

Definition at line 330 of file fields_table_data_model.h.

Referenced by DisableRebuilds(), EnableRebuilds(), and FIELDS_TABLE_DATA_MODEL_BASE().

◆ m_resolvedTextRenderer

wxGridCellRenderer* FIELDS_TABLE_DATA_MODEL_BASE::m_resolvedTextRenderer

protected

Definition at line 320 of file fields_table_data_model.h.

Referenced by applyResolvedTextRenderer(), FIELDS_TABLE_DATA_MODEL_BASE(), and ~FIELDS_TABLE_DATA_MODEL_BASE().

◆ m_selectionItems

std::unordered_set<KIID_PATH> FIELDS_TABLE_DATA_MODEL_BASE::m_selectionItems

protected

Items included by the user selection scope.

Definition at line 333 of file fields_table_data_model.h.

Referenced by ClearSelectionItems(), and SetSelectionItems().

◆ m_sortAscending

bool FIELDS_TABLE_DATA_MODEL_BASE::m_sortAscending

protected

Definition at line 324 of file fields_table_data_model.h.

Referenced by FIELDS_TABLE_DATA_MODEL_BASE(), GetSortAsc(), and SetSorting().

◆ m_sortColumn

int FIELDS_TABLE_DATA_MODEL_BASE::m_sortColumn

protected

Definition at line 323 of file fields_table_data_model.h.

Referenced by FIELDS_TABLE_DATA_MODEL_BASE(), GetSortCol(), and SetSorting().

◆ m_stripedRenderer

wxGridCellRenderer* FIELDS_TABLE_DATA_MODEL_BASE::m_stripedRenderer

protected

Definition at line 319 of file fields_table_data_model.h.

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

◆ m_variantNames

std::vector<wxString> FIELDS_TABLE_DATA_MODEL_BASE::m_variantNames

protected

Variant names for multi-variant DNP filtering.

Definition at line 336 of file fields_table_data_model.h.

Referenced by GetVariantNames(), and SetVariantNames().

◆ QUANTITY_VARIABLE

const wxString FIELDS_TABLE_DATA_MODEL_BASE::QUANTITY_VARIABLE = wxS( "${QUANTITY}" )

static

Definition at line 152 of file fields_table_data_model.h.

Referenced by ColIsQuantity(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), DIALOG_FOOTPRINT_FIELDS_TABLE::LoadFieldNames(), and DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames().

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FIELDS_TABLE_DATA_MODEL_BASE()

◆ ~FIELDS_TABLE_DATA_MODEL_BASE()

Member Function Documentation

◆ AddColumn()

◆ ApplyBomPreset()

◆ applyCellDecorations()

◆ applyFieldPresenceRenderer()

◆ applyResolvedTextRenderer()

◆ CanClearCell()

◆ CanCopyCellFromVariant()

◆ cellUsesResolvedTextRenderer()

◆ cellUsesUrlEditor()

◆ Clear()

◆ ClearCell()

◆ ClearSelectionItems()

◆ cloneUrlEditorAttr()

◆ ColIsAttribute()

◆ ColIsComputed()

◆ ColIsFootprint()

◆ ColIsItemIdentifier()

◆ ColIsItemNumber()

◆ ColIsItemProperty()

◆ ColIsQuantity()

◆ ColIsReadOnly()

◆ ColIsReference()

◆ ColIsValue()

◆ commitPendingGridChanges()

◆ CopyCellFromVariant()

◆ DeleteStoredVariant()

◆ DisableRebuilds()

◆ EnableRebuilds()

◆ enhanceAttr()

◆ ExpandCollapseRow()

◆ Export()

◆ fieldIsAttribute()

◆ fieldIsItemProperty()

◆ fieldSupportsVariants()

◆ fieldVariant()

◆ GetAttr()

◆ getAttributeResolvedValue()

◆ GetBomSettings()

◆ GetColDataWidth()

◆ GetColFieldName()

◆ GetColLabelValue()

◆ GetCurrentVariant()

◆ GetExcludeDNP()

◆ GetExportValue()

◆ GetFieldNameCol()

◆ GetFieldsOrdered()

◆ GetFilter()

◆ GetFilterScope()

◆ GetGroupColumn()

◆ GetGroupingEnabled()

◆ GetIncludeExcludedFromBOM()

◆ GetNumberCols()

◆ GetResolvedValue()

◆ GetRowItemKeys()

◆ GetRowState()

◆ GetShowColumn()

◆ GetSortAsc()

◆ GetSortCol()

◆ GetVariantNames()

◆ HasRowLabelExpanders()

◆ HasUndoStateSerialization()

◆ IsCellClear()

◆ IsCellEdited()

◆ IsCellReadOnly()

◆ IsEdited()

◆ IsEmptyCell()

◆ IsRowEdited()

◆ MoveColumn()

◆ RebuildRows()

◆ RemoveColumn()

◆ RenameColumn()