#include <footprint_fields_data_model.h>

Inheritance diagram for LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL:

Public Types
enum	SCOPE : int { SCOPE_ALL = 0 , SCOPE_SHEET , SCOPE_SHEET_RECURSIVE , SCOPE_SELECTION }

Public Member Functions
	LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL (const FOOTPRINT_REFERENCE_LIST &aFootprints)

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

bool	ApplyData (std::function< bool(FOOTPRINT &)> aChangeHandler)

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

void	SetValue (int aRow, int aCol, const wxString &aValue) override

void	RebuildRows () override

void	ApplyData (BOARD_COMMIT &aCommit, TEMPLATES &aTemplateFieldnames)

void	SetScope (SCOPE aScope)

SCOPE	GetScope ()

void	SetPath (const KIID_PATH &aPath)

const KIID_PATH &	GetPath ()

void	AddReferences (const FOOTPRINT_REFERENCE_LIST &aRefs)

void	RemoveReferences (const FOOTPRINT_REFERENCE_LIST &aRefs)

void	RemoveFootprint (const FOOTPRINT_REF &aRef)

void	UpdateReferences (const FOOTPRINT_REFERENCE_LIST &aRefs)

bool	DeleteRows (size_t aPosition=0, size_t aNumRows=1) override

const FOOTPRINT_REFERENCE_LIST &	GetReferenceList () const

bool	ColIsReadOnly (int aCol) const override

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

void	AddColumn (const wxString &aFieldName, const wxString &aLabel, bool aAddedByUser) override

void	ClearCell (int aRow, int aCol) override
	Clears the field from the data store, rather than setting its value to an empty string.

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

bool	IsCellClear (int aRow, int aCol) override
	Returns true if the cell is not present in the data store for any item in the row, not just empty.

bool	IsCellEdited (int aRow, int aCol) override
	Returns true if the cell has been modified from the live value in any item in the row (symbol/footprint/etc).

int	GetNumberRows () override

ROW_STATE	GetRowState (int aRow) const override

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

std::vector< FOOTPRINT_REF >	GetRowReferences (int aRow) const

void	RevertRow (int aRow) override
	Go through and revert all the fields in the row to their live values from the item (symbol/footprint/etc).

void	ExpandRow (int aRow)

void	CollapseRow (int aRow)

void	ExpandCollapseRow (int aRow) override

void	CollapseForSort ()

void	ExpandAfterSort ()

wxString	GetGroupedValue (const DATA_MODEL_ROW< FOOTPRINT_REF > &aRow, int aCol, const wxString &refDelimiter=wxT(", "), const wxString &refRangeDelimiter=wxT("-"), bool resolveVars=false, bool forExport=false)

wxString	GetValue (int aRow, int aCol) override

wxString	GetResolvedValue (int aRow, int aCol) override

wxString	GetExportValue (int aRow, int aCol, const wxString &refDelimiter, const wxString &refRangeDelimiter) override

bool	IsCellReadOnly (int aRow, int aCol) override

bool	IsEdited ()

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

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

void	SetSorting (int aCol, bool aAscending)

int	GetSortCol ()

bool	GetSortAsc ()

void	EnableRebuilds ()

void	DisableRebuilds ()

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)

bool	CanClearCell (int aRow, int aCol)

bool	CanCopyCellFromVariant (int aRow, int aCol)

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

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

void	SetColAttr (wxGridCellAttr *aAttr, int aCol) override

void	Clear () override

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

static const wxString	FOOTPRINT_KEYWORDS = wxS( "${FOOTPRINT_KEYWORDS}" )

static const wxString	FOOTPRINT_LIBRARY_DESCRIPTION

static const wxString	QUANTITY_VARIABLE

static const wxString	ITEM_NUMBER_VARIABLE

Protected Member Functions
bool	attributeForcedOnBySheet (const FOOTPRINT_REF &aItem, const wxString &aAttributeName) const
	Sheets can force all the symbols in them to have certain attributes on, like DNP.

bool	applyDataToFootprint (const FOOTPRINT_REF &aSourceRef, FOOTPRINT &aDestFootprint, TEMPLATES *aTemplateFieldnames, const wxString &aVariantName)
	Returns whether or the the aDestFootprint was changed by applying the data from aSourceRef.

bool	setAttributeValue (const FOOTPRINT_REF &aReference, const wxString &aAttributeName, const wxString &aValue, const wxString &aVariantName=wxEmptyString)
	Set the attribute value.

bool	MatchesFilter (const FOOTPRINT_REF &aItem, const wxString &aReference, EDA_COMBINED_MATCHER &aMatcher)

bool	allRowItemsHaveAttributeForcedOnBySheet (const DATA_MODEL_ROW< FOOTPRINT_REF > &aRow, int aCol)

bool	cmpRows (const DATA_MODEL_ROW< FOOTPRINT_REF > &lhRow, const DATA_MODEL_ROW< FOOTPRINT_REF > &rhRow, int aSortCol, bool aAscending)

virtual bool	cmpRowItems (const FOOTPRINT_REF &lhItem, const FOOTPRINT_REF &rhItem)

bool	groupMatch (const FOOTPRINT_REF &lhItem, const FOOTPRINT_REF &rhItem)

void	Sort ()

std::map< wxString, wxString >	getStoredFields (const FOOTPRINT_REF &aItem, const wxString &aVariant) const
	Returns the edited, present fields belonging to a variant without creating entries.

bool	getStoredFieldValue (const FOOTPRINT_REF &aItem, const wxString &aFieldName, wxString &aValue) const
	Gets the stored value of the field from the data store, not from the live item, e.g.

bool	resolveStoredTextVar (const FOOTPRINT_REF &aItem, wxString *aToken, bool aCaseSensitive=false) const
	Resolve an ordinary field token from the current variant's staged values.

void	setStoredFieldValue (const FOOTPRINT_REF &aItem, const wxString &aFieldName, const wxString &aValue)
	Creates or updates a field in the data store.

virtual void	setCellValues (int aRow, int aCol, const std::vector< wxString > &aValues)
	Write one value per item represented by the cell. Models may propagate shared storage.

void	ensureStoredFieldPresent (const FOOTPRINT_REF &aItem, const wxString &aFieldName)
	Makes sure a field is at least marked present-but-empty without changing its value if it has one already.

void	clearStoredField (const FOOTPRINT_REF &aItem, const wxString &aFieldName)
	Clears a field, e.g.

bool	fieldIsModified (const FOOTPRINT_REF &aItem, const wxString &aFieldName)
	Compares the live value of the field to the stored value in the data store.

void	updateDataStoreItemFieldFromLive (const FOOTPRINT_REF &aItem, const wxString &aFieldName, bool aAllVariants=false)
	Updates the data store with the current value of the field from the live item.

void	initializeDataStoreItemField (const FOOTPRINT_REF &aItem, const DATA_MODEL_COL &aCol)
	Puts the live value of the field in the data store, correctly handling a missing field in the souce item as empty or not-present based on whether the col was added by the user.

void	initializeDataStoreItem (const FOOTPRINT_REF &aItem)
	Initializes every column in the data store for a newly added (or refreshed) item.

FIELD_STORE_VALUE &	storedField (const FOOTPRINT_REF &aItem, const wxString &aFieldName)

FIELD_STORE_VALUE &	storedField (const FOOTPRINT_REF &aItem, const wxString &aFieldName, const wxString &aVariantName)

void	refreshDataStoreItem (const FOOTPRINT_REF &aItem)

bool	storedFieldIsRemoved (const FOOTPRINT_REF &aItem, const wxString &aName) const

std::set< wxString >	storedVariants (const FOOTPRINT_REF &aItem) const

void	acceptDataStoreItem (const FOOTPRINT_REF &aItem)

virtual void	getEffectiveFieldValue (const FOOTPRINT_REF &aItem, const wxString &aFieldName, wxString &aValue) const

virtual bool	fieldIsAttribute (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
FOOTPRINT_REFERENCE_LIST	m_footprintsList

SCOPE	m_scope

KIID_PATH	m_path

std::vector< DATA_MODEL_ROW< FOOTPRINT_REF > >	m_rows

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

Private Member Functions
bool	fieldSupportsVariants (const wxString &aFieldName) const override

bool	fieldIsItemProperty (const wxString &aFieldName) const override

bool	getLiveFieldValueForVariant (const FOOTPRINT_REF &aRef, const wxString &aFieldName, const wxString &aVariant, wxString &aValue) override

bool	getLiveFieldValue (const FOOTPRINT_REF &aRef, const wxString &aFieldName, wxString &aValue) override
	Gets the current value of the field from the live item, e.g.

wxString	getItemIdentifier (const FOOTPRINT_REF &aRef) const override

bool	applyDataToFootprint (const FOOTPRINT_REF &aRef, FOOTPRINT &aFootprint)

bool	unitMatch (const FOOTPRINT_REF &lhItem, const FOOTPRINT_REF &rhItem) override

bool	attributeForcedOnBySheet (const FOOTPRINT_REF &aRef, const wxString &aAttributeName, const wxString &aVariantName) const override
	Footprint attributes are don't currently track when they are inherited from the sheet, so this function always returns false.

wxString	getAttributeValue (const FOOTPRINT_REF &aRef, const wxString &aAttributeName, const wxString &aVariantNames)

wxString	getDefaultFieldValue (const FOOTPRINT_REF &aRef, const wxString &aFieldName)
	Get the default (non-variant) value for a field.

std::vector< FOOTPRINT_REF >	getAllItems () const override

wxString	getFieldResolvedLiveValue (const FOOTPRINT_REF &aRef, const wxString &aFieldName) override
	Explicitly bypasses the data store's field values and retries them from the item's current field value on the editing canvas.

wxString	resolveTextVars (const FOOTPRINT_REF &aRef, const wxString &aText) override

KIID_PATH	getDataStoreKey (const FOOTPRINT_REF &aItem) const override
	Data store UUID for a footprint is just the footprint's UUID, since footprints are unique across the board.

Detailed Description

Definition at line 165 of file footprint_fields_data_model.h.

Member Enumeration Documentation

◆ SCOPE

enum FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::SCOPE : int

inherited

Enumerator
SCOPE_ALL
SCOPE_SHEET
SCOPE_SHEET_RECURSIVE
SCOPE_SELECTION

Definition at line 59 of file footprint_fields_data_model.h.

Constructor & Destructor Documentation

◆ LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL()

LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL ( const FOOTPRINT_REFERENCE_LIST & aFootprints )

explicit

Definition at line 832 of file footprint_fields_data_model.cpp.

References FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL(), and FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::m_includeExcluded.

Member Function Documentation

◆ acceptDataStoreItem()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::acceptDataStoreItem ( const FOOTPRINT_REF & aItem )

inlineprotectedinherited

Definition at line 1402 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), and LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData().

◆ AddColumn()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::AddColumn	(	const wxString &	aFieldName,
		const wxString &	aLabel,
		bool	aAddedByUser )

inlineoverridevirtualinherited

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 406 of file fields_table_data_model.h.

◆ AddReferences()

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences ( const FOOTPRINT_REFERENCE_LIST & aRefs )

inherited

Definition at line 727 of file footprint_fields_data_model.cpp.

References alg::contains(), FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::initializeDataStoreItem(), and m_footprintsList.

◆ allRowItemsHaveAttributeForcedOnBySheet()

bool FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::allRowItemsHaveAttributeForcedOnBySheet	(	const DATA_MODEL_ROW< FOOTPRINT_REF > &	aRow,
		int	aCol )

inlineprotectedinherited

Definition at line 903 of file fields_table_data_model.h.

◆ ApplyBomPreset()

void FIELDS_TABLE_DATA_MODEL_BASE::ApplyBomPreset ( const BOM_PRESET & aPreset )

inherited

Definition at line 241 of file fields_table_data_model.cpp.

References m_sortColumn.

◆ applyCellDecorations()

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

protectedinherited

Definition at line 312 of file fields_table_data_model.cpp.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ ApplyData() [1/2]

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData	(	BOARD_COMMIT &	aCommit,
		TEMPLATES &	aTemplateFieldnames )

inherited

Definition at line 697 of file footprint_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::acceptDataStoreItem(), applyDataToFootprint(), LIB_TREE_ITEM::GetFootprint(), FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::m_edited, m_footprintsList, COMMIT::Modified(), FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::refreshDataStoreItem(), and FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::storedVariants().

◆ ApplyData() [2/2]

bool LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData ( std::function< bool(FOOTPRINT &)> aChangeHandler )

Definition at line 913 of file footprint_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::acceptDataStoreItem(), applyDataToFootprint(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::m_footprintsList, and FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::updateEditedState().

◆ applyDataToFootprint() [1/2]

bool FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint	(	const FOOTPRINT_REF &	aSourceRef,
		FOOTPRINT &	aDestFootprint,
		TEMPLATES *	aTemplateFieldnames,
		const wxString &	aVariantName )

protectedinherited

Returns whether or the the aDestFootprint was changed by applying the data from aSourceRef.

Definition at line 563 of file footprint_fields_data_model.cpp.

References FOOTPRINT::Add(), FOOTPRINT::AddVariant(), B_Fab, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::ColIsItemIdentifier(), F_Cu, F_Fab, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::fieldIsAttribute(), FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::fieldIsItemProperty(), FOOTPRINT, BOARD_ITEM::GetBoard(), GetDefaultFieldName(), GetDefaultVariantName(), FOOTPRINT::GetField(), TEMPLATES::GetFieldName(), FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::GetFieldNameCol(), FOOTPRINT::GetFields(), FOOTPRINT::GetFieldValueForVariant(), FOOTPRINT::GetLayer(), EDA_ITEM::GetParentGroup(), FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::getStoredFields(), PCB_FIELD::GetUntranslatedName(), IsGeneratedField(), PCB_FIELD::IsMandatory(), PCB_FIELD::IsPrivate(), FOOTPRINT::Remove(), setAttributeValue(), BOARD_ITEM::SetFPRelativePosition(), BOARD_ITEM::SetLayer(), PCB_FIELD::SetPrivate(), EDA_TEXT::SetText(), EDA_TEXT::SetVisible(), FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::storedFieldIsRemoved(), PCB_TEXT::StyleFromSettings(), UNTRANSLATED, and USER.

Referenced by ApplyData(), and LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint().

◆ applyDataToFootprint() [2/2]

bool LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint	(	const FOOTPRINT_REF &	aRef,
		FOOTPRINT &	aFootprint )

private

Definition at line 886 of file footprint_fields_data_model.cpp.

References FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), FOOTPRINT_KEYWORDS, FOOTPRINT_LIBRARY_DESCRIPTION, FOOTPRINT::GetKeywords(), FOOTPRINT::GetLibDescription(), FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::getStoredFieldValue(), FOOTPRINT::SetKeywords(), and FOOTPRINT::SetLibDescription().

Referenced by ApplyData().

◆ applyFieldPresenceRenderer()

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

protectedinherited

Definition at line 313 of file fields_table_data_model.cpp.

References m_dataStore.

◆ applyResolvedTextRenderer()

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

protectedinherited

Definition at line 307 of file fields_table_data_model.cpp.

References m_cols.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ attributeForcedOnBySheet() [1/2]

bool FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::attributeForcedOnBySheet	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aAttributeName ) const

inlineprotectedinherited

Sheets can force all the symbols in them to have certain attributes on, like DNP.

They can't force them off.

Returns true if the attribute is forced on by a sheet

Definition at line 891 of file fields_table_data_model.h.

◆ attributeForcedOnBySheet() [2/2]

bool FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::attributeForcedOnBySheet	(	const FOOTPRINT_REF &	aRef,
		const wxString &	aAttributeName,
		const wxString &	aVariantName ) const

overrideprivatevirtualinherited

Footprint attributes are don't currently track when they are inherited from the sheet, so this function always returns false.

That probably needs to change.

Reimplemented from FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >.

Definition at line 281 of file footprint_fields_data_model.cpp.

◆ CanClearCell()

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

inherited

Definition at line 250 of file fields_table_data_model.cpp.

References m_sortColumn.

◆ CanCopyCellFromVariant()

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

inherited

Definition at line 251 of file fields_table_data_model.cpp.

References m_cols, and m_sortColumn.

◆ cellUsesResolvedTextRenderer()

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

protectedinherited

Definition at line 306 of file fields_table_data_model.cpp.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ cellUsesUrlEditor()

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

protectedinherited

Definition at line 309 of file fields_table_data_model.cpp.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ Clear()

void WX_GRID_TABLE_BASE::Clear ( )

inlineoverrideinherited

Definition at line 122 of file wx_grid.h.

◆ ClearCell()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::ClearCell	(	int	aRow,
		int	aCol )

inlineoverridevirtualinherited

Clears the field from the data store, rather than setting its value to an empty string.

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 435 of file fields_table_data_model.h.

◆ ClearSelectionItems()

void FIELDS_TABLE_DATA_MODEL_BASE::ClearSelectionItems ( )

inlineinherited

Definition at line 220 of file fields_table_data_model.h.

◆ clearStoredField()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::clearStoredField	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aFieldName )

inlineprotectedinherited

Clears a field, e.g.

marks in not-present (as opposed to an empty string)

Definition at line 1228 of file fields_table_data_model.h.

◆ cloneUrlEditorAttr()

wxGridCellAttr * FIELDS_TABLE_DATA_MODEL_BASE::cloneUrlEditorAttr ( )

protectedinherited

Definition at line 310 of file fields_table_data_model.cpp.

References m_cols.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ cmpRowItems()

virtual bool FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::cmpRowItems	(	const FOOTPRINT_REF &	lhItem,
		const FOOTPRINT_REF &	rhItem )

inlineprotectedvirtualinherited

Definition at line 964 of file fields_table_data_model.h.

◆ cmpRows()

bool FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::cmpRows	(	const DATA_MODEL_ROW< FOOTPRINT_REF > &	lhRow,
		const DATA_MODEL_ROW< FOOTPRINT_REF > &	rhRow,
		int	aSortCol,
		bool	aAscending )

inlineprotectedinherited

Definition at line 919 of file fields_table_data_model.h.

◆ ColIsAttribute()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsAttribute ( int aCol ) const

inherited

Definition at line 186 of file fields_table_data_model.cpp.

◆ ColIsComputed()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsComputed ( int aCol ) const

inherited

Definition at line 192 of file fields_table_data_model.cpp.

References grid.

◆ ColIsFootprint()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsFootprint ( int aCol ) const

inherited

Definition at line 183 of file fields_table_data_model.cpp.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ColIsReadOnly().

◆ ColIsItemIdentifier()

bool LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ColIsItemIdentifier ( int aCol ) const

overridevirtual

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

Reimplemented from FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 840 of file footprint_fields_data_model.cpp.

References FOOTPRINT_NAME, and FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::m_cols.

◆ ColIsItemNumber()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsItemNumber ( int aCol ) const

inherited

Definition at line 181 of file fields_table_data_model.cpp.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ ColIsItemProperty()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsItemProperty ( int aCol ) const

inherited

Definition at line 188 of file fields_table_data_model.cpp.

◆ ColIsQuantity()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsQuantity ( int aCol ) const

inherited

Definition at line 180 of file fields_table_data_model.cpp.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ ColIsReadOnly()

bool FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ColIsReadOnly ( int aCol ) const

overridevirtualinherited

Reimplemented from FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 162 of file footprint_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::ColIsFootprint(), FIELDS_TABLE_DATA_MODEL_BASE::ColIsReadOnly(), and FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::m_cols.

◆ ColIsReference()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsReference ( int aCol ) const

inherited

Definition at line 179 of file fields_table_data_model.cpp.

References m_stripedRenderer.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ ColIsValue()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsValue ( int aCol ) const

inherited

Definition at line 182 of file fields_table_data_model.cpp.

◆ CollapseForSort()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::CollapseForSort ( )

inlineinherited

Definition at line 643 of file fields_table_data_model.h.

◆ CollapseRow()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::CollapseRow ( int aRow )

inlineinherited

Definition at line 610 of file fields_table_data_model.h.

◆ commitPendingGridChanges()

void FIELDS_TABLE_DATA_MODEL_BASE::commitPendingGridChanges ( )

protectedinherited

Definition at line 316 of file fields_table_data_model.cpp.

References FIELD_STORE_VALUE::m_present, and FIELD_STORE_VALUE::m_variants.

◆ CopyCellFromVariant()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::CopyCellFromVariant	(	int	aRow,
		int	aCol,
		const wxString &	aVariantName )

inlineoverridevirtualinherited

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

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 452 of file fields_table_data_model.h.

◆ DeleteRows()

bool FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::DeleteRows	(	size_t	aPosition = 0,
		size_t	aNumRows = 1 )

overrideinherited

Definition at line 778 of file footprint_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::m_dataStore, m_footprintsList, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::m_rows, RebuildRows(), and RemoveReferences().

◆ DeleteStoredVariant()

void FIELDS_TABLE_DATA_MODEL_BASE::DeleteStoredVariant ( const wxString & aName )

inherited

Definition at line 275 of file fields_table_data_model.cpp.

References m_colAttrs, m_cols, and m_sortColumn.

◆ DisableRebuilds()

void FIELDS_TABLE_DATA_MODEL_BASE::DisableRebuilds ( )

inherited

Definition at line 211 of file fields_table_data_model.cpp.

◆ EnableRebuilds()

void FIELDS_TABLE_DATA_MODEL_BASE::EnableRebuilds ( )

inherited

Definition at line 210 of file fields_table_data_model.cpp.

◆ enhanceAttr()

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

protectedinherited

Definition at line 129 of file wx_grid.cpp.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ ensureStoredFieldPresent()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::ensureStoredFieldPresent	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aFieldName )

inlineprotectedinherited

Makes sure a field is at least marked present-but-empty without changing its value if it has one already.

Definition at line 1220 of file fields_table_data_model.h.

◆ ExpandAfterSort()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::ExpandAfterSort ( )

inlineinherited

Definition at line 657 of file fields_table_data_model.h.

◆ ExpandCollapseRow()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::ExpandCollapseRow ( int aRow )

inlineoverridevirtualinherited

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 634 of file fields_table_data_model.h.

◆ ExpandRow()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::ExpandRow ( int aRow )

inlineinherited

Definition at line 562 of file fields_table_data_model.h.

◆ Export()

wxString FIELDS_TABLE_DATA_MODEL_BASE::Export ( const BOM_FMT_PRESET & aSettings )

inherited

Definition at line 243 of file fields_table_data_model.cpp.

References m_cols, and m_sortColumn.

◆ fieldIsAttribute()

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

protectedvirtualinherited

Definition at line 292 of file fields_table_data_model.cpp.

References grid, and m_colAttrs.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), and FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant().

◆ fieldIsItemProperty()

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

overrideprivatevirtual

Reimplemented from FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 847 of file footprint_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL_BASE::fieldIsItemProperty(), FOOTPRINT_KEYWORDS, FOOTPRINT_LIBRARY_DESCRIPTION, and FOOTPRINT_NAME.

◆ fieldIsModified()

bool FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::fieldIsModified	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aFieldName )

inlineprotectedinherited

Compares the live value of the field to the stored value in the data store.

If they differ in presence or value then the field has been modified

Definition at line 1242 of file fields_table_data_model.h.

◆ fieldSupportsVariants()

bool LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::fieldSupportsVariants ( const wxString & aFieldName ) const

inlineoverrideprivatevirtual

Reimplemented from FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 179 of file footprint_fields_data_model.h.

◆ fieldVariant()

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

protectedinherited

Definition at line 300 of file fields_table_data_model.cpp.

◆ getAllItems()

std::vector< FOOTPRINT_REF > FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getAllItems ( ) const

overrideprivatevirtualinherited

Implements FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >.

Definition at line 195 of file footprint_fields_data_model.cpp.

References m_footprintsList.

◆ GetAttr()

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

overrideinherited

Definition at line 65 of file footprint_fields_data_model.cpp.

◆ getAttributeResolvedValue()

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

protectedvirtualinherited

Definition at line 304 of file fields_table_data_model.cpp.

◆ getAttributeValue()

wxString FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue	(	const FOOTPRINT_REF &	aRef,
		const wxString &	aAttributeName,
		const wxString &	aVariantNames )

privateinherited

Definition at line 258 of file footprint_fields_data_model.cpp.

References FOOTPRINT::GetDNPForVariant(), FOOTPRINT::GetExcludedFromBOMForVariant(), FOOTPRINT::GetExcludedFromPosFilesForVariant(), FOOTPRINT::GetExcludedFromSimForVariant(), and FOOTPRINT_REF::GetFootprint().

Referenced by getLiveFieldValueForVariant().

◆ GetBomSettings()

BOM_PRESET FIELDS_TABLE_DATA_MODEL_BASE::GetBomSettings ( )

inherited

Definition at line 242 of file fields_table_data_model.cpp.

References m_sortColumn.

◆ GetColDataWidth()

int FIELDS_TABLE_DATA_MODEL_BASE::GetColDataWidth ( int aCol )

inherited

Definition at line 168 of file fields_table_data_model.cpp.

◆ GetColFieldName()

wxString FIELDS_TABLE_DATA_MODEL_BASE::GetColFieldName ( int aCol )

inherited

Definition at line 167 of file fields_table_data_model.cpp.

◆ GetColLabelValue()

wxString FIELDS_TABLE_DATA_MODEL_BASE::GetColLabelValue ( int aCol )

overrideinherited

Definition at line 166 of file fields_table_data_model.cpp.

◆ GetCurrentVariant()

const wxString & FIELDS_TABLE_DATA_MODEL_BASE::GetCurrentVariant ( ) const

inlineinherited

Definition at line 272 of file fields_table_data_model.h.

◆ getDataStoreKey()

KIID_PATH FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getDataStoreKey ( const FOOTPRINT_REF & aItem ) const

overrideprivatevirtualinherited

Data store UUID for a footprint is just the footprint's UUID, since footprints are unique across the board.

Implements FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >.

Definition at line 51 of file footprint_fields_data_model.cpp.

References FOOTPRINT_REF::GetFootprint(), and EDA_ITEM::m_Uuid.

Referenced by RebuildRows(), and RemoveFootprint().

◆ getDefaultFieldValue()

wxString FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getDefaultFieldValue	(	const FOOTPRINT_REF &	aRef,
		const wxString &	aFieldName )

privateinherited

Get the default (non-variant) value for a field.

This retrieves the field value as it would appear without any variant override.

Parameters

aRef	The footprint reference.
aFieldName	The name of the field.

Returns: The default field value.

Definition at line 347 of file footprint_fields_data_model.cpp.

References getLiveFieldValueForVariant().

Referenced by GetAttr().

◆ getEffectiveFieldValue()

virtual void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::getEffectiveFieldValue	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aFieldName,
		wxString &	aValue ) const

inlineprotectedvirtualinherited

Definition at line 1409 of file fields_table_data_model.h.

◆ GetExcludeDNP()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetExcludeDNP ( )

inlineinherited

Definition at line 233 of file fields_table_data_model.h.

◆ GetExportValue()

wxString FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::GetExportValue	(	int	aRow,
		int	aCol,
		const wxString &	refDelimiter,
		const wxString &	refRangeDelimiter )

inlineoverridevirtualinherited

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 813 of file fields_table_data_model.h.

◆ GetFieldNameCol()

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

inherited

Definition at line 169 of file fields_table_data_model.cpp.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint().

◆ getFieldResolvedLiveValue()

wxString FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getFieldResolvedLiveValue	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aFieldName )

overrideprivatevirtualinherited

Explicitly bypasses the data store's field values and retries them from the item's current field value on the editing canvas.

Will also handle generated fields as necessary. Returns empty string for private/missing fields.

Example: BOM template provides ${DNP} as a field, but they symbol doesn't have the field.

Returns: Resolved display text for the field's live value from the canvas.

Implements FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >.

Definition at line 201 of file footprint_fields_data_model.cpp.

References FOOTPRINT::GetField(), FOOTPRINT_REF::GetFootprint(), PCB_FIELD::GetShownText(), INTERNAL, IsGeneratedField(), PCB_FIELD::IsPrivate(), FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::m_currentVariant, FOOTPRINT::ResolveTextVar(), and ResolveTextVars().

◆ GetFieldsOrdered()

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

inherited

Definition at line 171 of file fields_table_data_model.cpp.

◆ GetFilter()

const wxString & FIELDS_TABLE_DATA_MODEL_BASE::GetFilter ( )

inlineinherited

Definition at line 215 of file fields_table_data_model.h.

◆ GetFilterScope()

BOM_FILTER_SCOPE FIELDS_TABLE_DATA_MODEL_BASE::GetFilterScope ( ) const

inlineinherited

Definition at line 217 of file fields_table_data_model.h.

◆ GetGroupColumn()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetGroupColumn ( int aCol )

inherited

Definition at line 236 of file fields_table_data_model.cpp.

◆ GetGroupedValue()

wxString FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::GetGroupedValue	(	const DATA_MODEL_ROW< FOOTPRINT_REF > &	aRow,
		int	aCol,
		const wxString &	refDelimiter = wxT( ", " ),
		const wxString &	refRangeDelimiter = wxT( "-" ),
		bool	resolveVars = false,
		bool	forExport = false )

inlineinherited

Definition at line 667 of file fields_table_data_model.h.

◆ GetGroupingEnabled()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetGroupingEnabled ( )

inlineinherited

Definition at line 223 of file fields_table_data_model.h.

◆ GetIncludeExcludedFromBOM()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetIncludeExcludedFromBOM ( )

inlineinherited

Definition at line 230 of file fields_table_data_model.h.

◆ getItemIdentifier()

wxString LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getItemIdentifier ( const FOOTPRINT_REF & aRef ) const

overrideprivatevirtual

Reimplemented from FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 880 of file footprint_fields_data_model.cpp.

References FOOTPRINT_REF::GetFootprint(), and FOOTPRINT::GetName().

◆ getLiveFieldValue()

bool LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValue	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aFieldName,
		wxString &	aValue )

overrideprivatevirtual

Gets the current value of the field from the live item, e.g.

from the symbol on the schematic.

Returns: True if the field is present in the live item, false if it is not present (and aValue will be empty).

Reimplemented from FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 855 of file footprint_fields_data_model.cpp.

References FOOTPRINT_KEYWORDS, FOOTPRINT_LIBRARY_DESCRIPTION, FOOTPRINT_NAME, FOOTPRINT_REF::GetFootprint(), FOOTPRINT::GetKeywords(), FOOTPRINT::GetLibDescription(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValue(), and FOOTPRINT::GetName().

Referenced by getLiveFieldValueForVariant().

◆ getLiveFieldValueForVariant()

bool LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant	(	const FOOTPRINT_REF &	aRef,
		const wxString &	aFieldName,
		const wxString &	aVariant,
		wxString &	aValue )

inlineoverrideprivatevirtual

Reimplemented from FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL.

Definition at line 182 of file footprint_fields_data_model.h.

References getLiveFieldValue().

◆ GetNumberCols()

int FIELDS_TABLE_DATA_MODEL_BASE::GetNumberCols ( )

inlineoverrideinherited

Definition at line 163 of file fields_table_data_model.h.

◆ GetNumberRows()

int FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::GetNumberRows ( )

inlineoverrideinherited

Definition at line 518 of file fields_table_data_model.h.

◆ GetPath()

const KIID_PATH & FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetPath ( )

inlineinherited

Definition at line 85 of file footprint_fields_data_model.h.

References m_path.

◆ GetReferenceList()

const FOOTPRINT_REFERENCE_LIST & FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetReferenceList ( ) const

inlineinherited

Definition at line 94 of file footprint_fields_data_model.h.

References m_footprintsList.

Referenced by PCBNEW_JOBS_HANDLER::JobExportBom().

◆ GetResolvedValue()

wxString FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::GetResolvedValue	(	int	aRow,
		int	aCol )

inlineoverridevirtualinherited

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 808 of file fields_table_data_model.h.

◆ GetRowItemKeys()

std::vector< KIID_PATH > FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::GetRowItemKeys ( int aRow ) const

inlineoverridevirtualinherited

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

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 522 of file fields_table_data_model.h.

◆ GetRowReferences()

std::vector< FOOTPRINT_REF > FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::GetRowReferences ( int aRow ) const

inlineinherited

Definition at line 535 of file fields_table_data_model.h.

◆ GetRowState()

ROW_STATE FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::GetRowState ( int aRow ) const

inlineoverridevirtualinherited

Reimplemented from WX_GRID_TABLE_BASE.

Definition at line 519 of file fields_table_data_model.h.

◆ GetScope()

SCOPE FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetScope ( )

inlineinherited

Definition at line 82 of file footprint_fields_data_model.h.

References m_scope.

◆ GetShowColumn()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetShowColumn ( int aCol )

inherited

Definition at line 239 of file fields_table_data_model.cpp.

◆ GetSortAsc()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetSortAsc ( )

inlineinherited

Definition at line 206 of file fields_table_data_model.h.

◆ GetSortCol()

int FIELDS_TABLE_DATA_MODEL_BASE::GetSortCol ( )

inlineinherited

Definition at line 205 of file fields_table_data_model.h.

◆ getStoredFields()

std::map< wxString, wxString > FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::getStoredFields	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aVariant ) const

inlineprotectedinherited

Returns the edited, present fields belonging to a variant without creating entries.

Definition at line 1092 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint().

◆ getStoredFieldValue()

bool FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::getStoredFieldValue	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aFieldName,
		wxString &	aValue ) const

inlineprotectedinherited

Gets the stored value of the field from the data store, not from the live item, e.g.

from the symbol on the schematic.

Returns: True if the field is present in the data store, false if it is not present (and aValue will be empty).

Definition at line 1122 of file fields_table_data_model.h.

Referenced by LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), and FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ GetValue()

wxString FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::GetValue	(	int	aRow,
		int	aCol )

inlineoverrideinherited

Definition at line 800 of file fields_table_data_model.h.

◆ GetVariantNames()

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

inlineinherited

Definition at line 278 of file fields_table_data_model.h.

◆ groupMatch()

bool FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::groupMatch	(	const FOOTPRINT_REF &	lhItem,
		const FOOTPRINT_REF &	rhItem )

inlineprotectedinherited

Definition at line 971 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ HasRowLabelExpanders()

bool FIELDS_TABLE_DATA_MODEL_BASE::HasRowLabelExpanders ( ) const

inlineoverrideinherited

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

Definition at line 201 of file fields_table_data_model.h.

◆ HasUndoStateSerialization()

bool FIELDS_TABLE_DATA_MODEL_BASE::HasUndoStateSerialization ( ) const

inlineoverrideinherited

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.

Definition at line 282 of file fields_table_data_model.h.

◆ initializeDataStoreItem()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::initializeDataStoreItem ( const FOOTPRINT_REF & aItem )

inlineprotectedinherited

Initializes every column in the data store for a newly added (or refreshed) item.

Like the field initializer, this will correctly handle missing fields in the source item as empty or not-present based on the column user-added status

Definition at line 1302 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences().

◆ initializeDataStoreItemField()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::initializeDataStoreItemField	(	const FOOTPRINT_REF &	aItem,
		const DATA_MODEL_COL &	aCol )

inlineprotectedinherited

Puts the live value of the field in the data store, correctly handling a missing field in the souce item as empty or not-present based on whether the col was added by the user.

Definition at line 1288 of file fields_table_data_model.h.

◆ IsCellClear()

bool FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::IsCellClear	(	int	aRow,
		int	aCol )

inlineoverridevirtualinherited

Returns true if the cell is not present in the data store for any item in the row, not just empty.

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 482 of file fields_table_data_model.h.

◆ IsCellEdited()

bool FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::IsCellEdited	(	int	aRow,
		int	aCol )

inlineoverridevirtualinherited

Returns true if the cell has been modified from the live value in any item in the row (symbol/footprint/etc).

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 503 of file fields_table_data_model.h.

◆ IsCellReadOnly()

bool FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::IsCellReadOnly	(	int	aRow,
		int	aCol )

inlineoverridevirtualinherited

Reimplemented from FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 819 of file fields_table_data_model.h.

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

◆ IsEdited()

bool FIELDS_TABLE_DATA_MODEL_BASE::IsEdited ( )

inlineinherited

Definition at line 155 of file fields_table_data_model.h.

◆ IsEmptyCell()

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

inlineoverrideinherited

Definition at line 174 of file fields_table_data_model.h.

◆ IsRowEdited()

bool FIELDS_TABLE_DATA_MODEL_BASE::IsRowEdited ( int aRow )

inherited

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

Definition at line 257 of file fields_table_data_model.cpp.

◆ MatchesFilter()

bool FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::MatchesFilter	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aReference,
		EDA_COMBINED_MATCHER &	aMatcher )

inlineprotectedinherited

Definition at line 827 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ MoveColumn()

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

inherited

Definition at line 159 of file fields_table_data_model.cpp.

◆ RebuildRows()

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows ( )

overridevirtualinherited

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 427 of file footprint_fields_data_model.cpp.

Referenced by DeleteRows().

◆ refreshDataStoreItem()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::refreshDataStoreItem ( const FOOTPRINT_REF & aItem )

inlineprotectedinherited

Definition at line 1334 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), and FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences().

◆ RemoveColumn()

void FIELDS_TABLE_DATA_MODEL_BASE::RemoveColumn ( int aCol )

inherited

Definition at line 160 of file fields_table_data_model.cpp.

◆ RemoveFootprint()

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RemoveFootprint ( const FOOTPRINT_REF & aRef )

inherited

Definition at line 741 of file footprint_fields_data_model.cpp.

References getDataStoreKey(), FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::m_dataStore, and m_footprintsList.

Referenced by RemoveReferences().

◆ RemoveReferences()

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RemoveReferences ( const FOOTPRINT_REFERENCE_LIST & aRefs )

inherited

Definition at line 754 of file footprint_fields_data_model.cpp.

References RemoveFootprint().

Referenced by DeleteRows().

◆ RenameColumn()

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

inherited

Definition at line 161 of file fields_table_data_model.cpp.

◆ RenameStoredVariant()

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

inherited

Definition at line 274 of file fields_table_data_model.cpp.

◆ resolveStoredTextVar()

bool FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::resolveStoredTextVar	(	const FOOTPRINT_REF &	aItem,
		wxString *	aToken,
		bool	aCaseSensitive = false ) const

inlineprotectedinherited

Resolve an ordinary field token from the current variant's staged values.

Return raw variable references so ResolveTextVars can expand nested fields with its depth limit. Tokens not tracked by the table must still be offered to the live item's resolver.

Definition at line 1149 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars().

◆ resolveTextVars()

wxString FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars	(	const FOOTPRINT_REF &	aRef,
		const wxString &	aText )

overrideprivatevirtualinherited

Implements FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >.

Definition at line 234 of file footprint_fields_data_model.cpp.

References GetDefaultFieldName(), FOOTPRINT_REF::GetFootprint(), FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::m_currentVariant, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::resolveStoredTextVar(), FOOTPRINT::ResolveTextVar(), ResolveTextVars(), UNTRANSLATED, and VALUE.

◆ RestoreUndoState()

void FIELDS_TABLE_DATA_MODEL_BASE::RestoreUndoState ( const wxString & aState )

overrideinherited

Definition at line 284 of file fields_table_data_model.cpp.

References m_colAttrs.

◆ RevertRow()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::RevertRow ( int aRow )

inlineoverridevirtualinherited

Go through and revert all the fields in the row to their live values from the item (symbol/footprint/etc).

Then recheck if any fields in the entire table are modified, and set edited state accordingly.

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 548 of file fields_table_data_model.h.

◆ SerializeUndoState()

wxString FIELDS_TABLE_DATA_MODEL_BASE::SerializeUndoState ( ) const

overrideinherited

Definition at line 283 of file fields_table_data_model.cpp.

◆ setAttributeValue()

bool FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue	(	const FOOTPRINT_REF &	aReference,
		const wxString &	aAttributeName,
		const wxString &	aValue,
		const wxString &	aVariantName = wxEmptyString )

protectedinherited

Set the attribute value.

Parameters

aReference	is a reference to the footprint to set the attribute.
aAttributeName	is the name of the footprint attribute.
aValue	is the value to set the attribute.
aVariantName	is an optional variant name to set the variant attribute.

Return values

true	if the footprint attribute value has changed.
false	if the footprint attribute has not changed.

Definition at line 356 of file footprint_fields_data_model.cpp.

References FOOTPRINT::AddVariant(), GetDefaultVariantName(), FOOTPRINT::GetDNPForVariant(), FOOTPRINT::GetExcludedFromBOMForVariant(), FOOTPRINT::GetExcludedFromPosFilesForVariant(), FOOTPRINT::GetExcludedFromSimForVariant(), FOOTPRINT_REF::GetFootprint(), FOOTPRINT::SetDNP(), FOOTPRINT::SetExcludedFromBOM(), FOOTPRINT::SetExcludedFromPosFiles(), and FOOTPRINT::SetExcludedFromSim().

Referenced by applyDataToFootprint().

◆ setCellValues()

virtual void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::setCellValues	(	int	aRow,
		int	aCol,
		const std::vector< wxString > &	aValues )

inlineprotectedvirtualinherited

Write one value per item represented by the cell. Models may propagate shared storage.

Definition at line 1208 of file fields_table_data_model.h.

◆ SetColAttr()

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

inlineoverrideinherited

Definition at line 90 of file wx_grid.h.

◆ SetColLabelValue()

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

overrideinherited

Definition at line 165 of file fields_table_data_model.cpp.

◆ SetCurrentVariant()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::SetCurrentVariant ( const wxString & aVariantName )

inlineoverridevirtualinherited

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.

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 395 of file fields_table_data_model.h.

◆ SetExcludeDNP()

void FIELDS_TABLE_DATA_MODEL_BASE::SetExcludeDNP ( bool aExclude )

inlineinherited

Definition at line 232 of file fields_table_data_model.h.

◆ SetFieldsOrder()

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

inherited

Definition at line 172 of file fields_table_data_model.cpp.

References FIELDS_TABLE_COLOR::CLEARED_FIELD_STRIPE_ON_DARK_LIGHT_RED(), FIELDS_TABLE_COLOR::CLEARED_FIELD_STRIPE_ON_LIGHT_DARK_RED(), and m_stripedRenderer.

◆ SetFilter()

void FIELDS_TABLE_DATA_MODEL_BASE::SetFilter ( const wxString & aFilter )

inlineinherited

Definition at line 214 of file fields_table_data_model.h.

◆ SetFilterScope()

void FIELDS_TABLE_DATA_MODEL_BASE::SetFilterScope ( BOM_FILTER_SCOPE aScope )

inlineinherited

Definition at line 216 of file fields_table_data_model.h.

◆ SetGroupColumn()

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

inherited

Definition at line 235 of file fields_table_data_model.cpp.

◆ SetGroupingEnabled()

void FIELDS_TABLE_DATA_MODEL_BASE::SetGroupingEnabled ( bool aGroup )

inlineinherited

Definition at line 222 of file fields_table_data_model.h.

◆ SetIncludeExcludedFromBOM()

void FIELDS_TABLE_DATA_MODEL_BASE::SetIncludeExcludedFromBOM ( bool aInclude )

inlineinherited

Definition at line 229 of file fields_table_data_model.h.

◆ SetPath()

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::SetPath ( const KIID_PATH & aPath )

inlineinherited

Definition at line 84 of file footprint_fields_data_model.h.

References m_path.

◆ SetScope()

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::SetScope ( SCOPE aScope )

inlineinherited

Definition at line 81 of file footprint_fields_data_model.h.

References m_scope.

◆ SetSelectionItems()

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

inlineinherited

Definition at line 219 of file fields_table_data_model.h.

◆ SetShowColumn()

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

inherited

Definition at line 238 of file fields_table_data_model.cpp.

◆ SetSorting()

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

inherited

Definition at line 204 of file fields_table_data_model.cpp.

References grid.

◆ setStoredFieldValue()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::setStoredFieldValue	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aFieldName,
		const wxString &	aValue )

inlineprotectedinherited

Creates or updates a field in the data store.

Always marks the field present as a result.

Definition at line 1199 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue().

◆ SetValue()

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue	(	int	aRow,
		int	aCol,
		const wxString &	aValue )

overrideinherited

Definition at line 142 of file footprint_fields_data_model.cpp.

References INDETERMINATE_STATE, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::IsCellReadOnly(), FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::m_cols, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::m_edited, DATA_MODEL_ROW< ITEM_TYPE >::m_items, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::m_rows, and FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::setStoredFieldValue().

◆ SetVariantNames()

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

inlineinherited

Definition at line 277 of file fields_table_data_model.h.

◆ Sort()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::Sort ( )

inlineprotectedinherited

Definition at line 1043 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ storedField() [1/2]

FIELD_STORE_VALUE & FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::storedField	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aFieldName )

inlineprotectedinherited

Definition at line 1308 of file fields_table_data_model.h.

◆ storedField() [2/2]

FIELD_STORE_VALUE & FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::storedField	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aFieldName,
		const wxString &	aVariantName )

inlineprotectedinherited

Definition at line 1313 of file fields_table_data_model.h.

◆ storedFieldIsRemoved()

bool FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::storedFieldIsRemoved	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aName ) const

inlineprotectedinherited

Definition at line 1374 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint().

◆ storedVariants()

std::set< wxString > FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::storedVariants ( const FOOTPRINT_REF & aItem ) const

inlineprotectedinherited

Definition at line 1385 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData().

◆ unitMatch()

bool FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch	(	const FOOTPRINT_REF &	lhItem,
		const FOOTPRINT_REF &	rhItem )

overrideprivatevirtualinherited

Implements FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >.

Definition at line 178 of file footprint_fields_data_model.cpp.

Referenced by RebuildRows().

◆ updateDataStoreItemFieldFromLive()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::updateDataStoreItemFieldFromLive	(	const FOOTPRINT_REF &	aItem,
		const wxString &	aFieldName,
		bool	aAllVariants = false )

inlineprotectedinherited

Updates the data store with the current value of the field from the live item.

If the field is not present on the item, it will be cleared from the data store rather than set to empty.

Definition at line 1259 of file fields_table_data_model.h.

◆ updateEditedState()

void FIELDS_TABLE_DATA_MODEL_BASE::updateEditedState ( )

protectedinherited

Definition at line 301 of file fields_table_data_model.cpp.

References m_edited.

Referenced by LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), and FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences().

◆ UpdateReferences()

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences ( const FOOTPRINT_REFERENCE_LIST & aRefs )

inherited

Definition at line 761 of file footprint_fields_data_model.cpp.

References alg::contains(), m_footprintsList, FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::refreshDataStoreItem(), and FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::updateEditedState().

Referenced by PCBNEW_JOBS_HANDLER::JobExportBom().

Member Data Documentation

◆ FOOTPRINT_KEYWORDS

const wxString LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::FOOTPRINT_KEYWORDS = wxS( "${FOOTPRINT_KEYWORDS}" )

static

Definition at line 169 of file footprint_fields_data_model.h.

Referenced by applyDataToFootprint(), fieldIsItemProperty(), DIALOG_LIB_FOOTPRINT_FIELDS_TABLE::getBuiltInBomPresets(), getLiveFieldValue(), and DIALOG_LIB_FOOTPRINT_FIELDS_TABLE::LoadFieldNames().

◆ FOOTPRINT_LIBRARY_DESCRIPTION

const wxString LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::FOOTPRINT_LIBRARY_DESCRIPTION

static

Initial value:

=

wxS( "${FOOTPRINT_LIBRARY_DESCRIPTION}" )

Definition at line 170 of file footprint_fields_data_model.h.

Referenced by applyDataToFootprint(), fieldIsItemProperty(), and getLiveFieldValue().

◆ FOOTPRINT_NAME

const wxString LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::FOOTPRINT_NAME = wxS( "${FOOTPRINT_NAME}" )

static

Definition at line 168 of file footprint_fields_data_model.h.

Referenced by ColIsItemIdentifier(), fieldIsItemProperty(), DIALOG_LIB_FOOTPRINT_FIELDS_TABLE::getBuiltInBomPresets(), and getLiveFieldValue().

◆ ITEM_NUMBER_VARIABLE

const wxString FIELDS_TABLE_DATA_MODEL_BASE::ITEM_NUMBER_VARIABLE

staticinherited

Definition at line 153 of file fields_table_data_model.h.

◆ m_colAttrs

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

protectedinherited

Definition at line 133 of file wx_grid.h.

Referenced by DeleteStoredVariant(), fieldIsAttribute(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), and RestoreUndoState().

◆ m_cols

std::vector<DATA_MODEL_COL> FIELDS_TABLE_DATA_MODEL_BASE::m_cols

protectedinherited

Definition at line 339 of file fields_table_data_model.h.

Referenced by applyResolvedTextRenderer(), CanCopyCellFromVariant(), cloneUrlEditorAttr(), LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ColIsItemIdentifier(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ColIsReadOnly(), DeleteStoredVariant(), Export(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), and FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue().

◆ m_currentVariant

wxString FIELDS_TABLE_DATA_MODEL_BASE::m_currentVariant

protectedinherited

Current variant name for highlighting.

Definition at line 335 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getFieldResolvedLiveValue(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValue(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), and FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars().

◆ m_dataStore

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

protectedinherited

Definition at line 363 of file fields_table_data_model.h.

Referenced by applyFieldPresenceRenderer(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::DeleteRows(), and FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RemoveFootprint().

◆ m_edited

bool FIELDS_TABLE_DATA_MODEL_BASE::m_edited

protectedinherited

Definition at line 322 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue(), and updateEditedState().

◆ m_excludeDNP

bool FIELDS_TABLE_DATA_MODEL_BASE::m_excludeDNP

protectedinherited

Definition at line 328 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ m_filter

wxString FIELDS_TABLE_DATA_MODEL_BASE::m_filter

protectedinherited

Definition at line 325 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ m_filterScope

BOM_FILTER_SCOPE FIELDS_TABLE_DATA_MODEL_BASE::m_filterScope

protectedinherited

Definition at line 326 of file fields_table_data_model.h.

◆ m_footprintsList

FOOTPRINT_REFERENCE_LIST FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::m_footprintsList

protectedinherited

Definition at line 159 of file footprint_fields_data_model.h.

Referenced by AddReferences(), ApplyData(), LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), DeleteRows(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL(), getAllItems(), GetReferenceList(), RebuildRows(), RemoveFootprint(), and UpdateReferences().

◆ m_groupingEnabled

bool FIELDS_TABLE_DATA_MODEL_BASE::m_groupingEnabled

protectedinherited

Definition at line 327 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ m_includeExcluded

bool FIELDS_TABLE_DATA_MODEL_BASE::m_includeExcluded

protectedinherited

Definition at line 329 of file fields_table_data_model.h.

Referenced by LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL(), and FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ m_path

KIID_PATH FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::m_path

protectedinherited

Definition at line 161 of file footprint_fields_data_model.h.

Referenced by GetPath(), RebuildRows(), and SetPath().

◆ m_rebuildsEnabled

bool FIELDS_TABLE_DATA_MODEL_BASE::m_rebuildsEnabled

protectedinherited

Definition at line 330 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ m_resolvedTextRenderer

wxGridCellRenderer* FIELDS_TABLE_DATA_MODEL_BASE::m_resolvedTextRenderer

protectedinherited

Definition at line 320 of file fields_table_data_model.h.

◆ m_rows

std::vector<DATA_MODEL_ROW<FOOTPRINT_REF> > FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::m_rows

protectedinherited

Definition at line 1435 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::DeleteRows(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), and FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue().

◆ m_scope

SCOPE FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::m_scope

protectedinherited

Definition at line 160 of file footprint_fields_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL(), GetScope(), RebuildRows(), and SetScope().

◆ m_selectionItems

std::unordered_set<KIID_PATH> FIELDS_TABLE_DATA_MODEL_BASE::m_selectionItems

protectedinherited

Items included by the user selection scope.

Definition at line 333 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ m_sortAscending

bool FIELDS_TABLE_DATA_MODEL_BASE::m_sortAscending

protectedinherited

Definition at line 324 of file fields_table_data_model.h.

◆ m_sortColumn

int FIELDS_TABLE_DATA_MODEL_BASE::m_sortColumn

protectedinherited

Definition at line 323 of file fields_table_data_model.h.

Referenced by ApplyBomPreset(), CanClearCell(), CanCopyCellFromVariant(), DeleteStoredVariant(), Export(), and GetBomSettings().

◆ m_stripedRenderer

wxGridCellRenderer* FIELDS_TABLE_DATA_MODEL_BASE::m_stripedRenderer

protectedinherited

Definition at line 319 of file fields_table_data_model.h.

Referenced by ColIsReference(), and SetFieldsOrder().

◆ m_variantNames

std::vector<wxString> FIELDS_TABLE_DATA_MODEL_BASE::m_variantNames

protectedinherited

Variant names for multi-variant DNP filtering.

Definition at line 336 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ QUANTITY_VARIABLE

const wxString FIELDS_TABLE_DATA_MODEL_BASE::QUANTITY_VARIABLE

staticinherited

Definition at line 152 of file fields_table_data_model.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ SCOPE

Constructor & Destructor Documentation

◆ LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL()

Member Function Documentation

◆ acceptDataStoreItem()

◆ AddColumn()

◆ AddReferences()

◆ allRowItemsHaveAttributeForcedOnBySheet()

◆ ApplyBomPreset()

◆ applyCellDecorations()

◆ ApplyData() [1/2]

◆ ApplyData() [2/2]

◆ applyDataToFootprint() [1/2]

◆ applyDataToFootprint() [2/2]

◆ applyFieldPresenceRenderer()

◆ applyResolvedTextRenderer()

◆ attributeForcedOnBySheet() [1/2]

◆ attributeForcedOnBySheet() [2/2]

◆ CanClearCell()

◆ CanCopyCellFromVariant()

◆ cellUsesResolvedTextRenderer()

◆ cellUsesUrlEditor()

◆ Clear()

◆ ClearCell()

◆ ClearSelectionItems()

◆ clearStoredField()

◆ cloneUrlEditorAttr()

◆ cmpRowItems()

◆ cmpRows()

◆ ColIsAttribute()

◆ ColIsComputed()

◆ ColIsFootprint()

◆ ColIsItemIdentifier()

◆ ColIsItemNumber()

◆ ColIsItemProperty()

◆ ColIsQuantity()

◆ ColIsReadOnly()

◆ ColIsReference()

◆ ColIsValue()

◆ CollapseForSort()

◆ CollapseRow()

◆ commitPendingGridChanges()

◆ CopyCellFromVariant()

◆ DeleteRows()

◆ DeleteStoredVariant()

◆ DisableRebuilds()

◆ EnableRebuilds()

◆ enhanceAttr()

◆ ensureStoredFieldPresent()

◆ ExpandAfterSort()

◆ ExpandCollapseRow()

◆ ExpandRow()

◆ Export()

◆ fieldIsAttribute()

◆ fieldIsItemProperty()

◆ fieldIsModified()

◆ fieldSupportsVariants()

◆ fieldVariant()

◆ getAllItems()

◆ GetAttr()

◆ getAttributeResolvedValue()

◆ getAttributeValue()

◆ GetBomSettings()

◆ GetColDataWidth()

◆ GetColFieldName()

◆ GetColLabelValue()

◆ GetCurrentVariant()

◆ getDataStoreKey()

◆ getDefaultFieldValue()

◆ getEffectiveFieldValue()

◆ GetExcludeDNP()

◆ GetExportValue()