KiCad PCB EDA Suite
Loading...
Searching...
No Matches
LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL Class Reference

#include <footprint_fields_data_model.h>

Inheritance diagram for LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL:
FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF > FIELDS_TABLE_DATA_MODEL_BASE WX_GRID_TABLE_BASE

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, const wxString &aVariantName)
 
void SetScope (SCOPE aScope)
 
SCOPE GetScope ()
 
void SetPath (const KIID_PATH &aPath)
 
const KIID_PATHGetPath ()
 
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_LISTGetReferenceList () const
 
bool ColIsReadOnly (int aCol) const override
 
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.
 
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_PATHGetRowItemKeys (int aRow) const override
 Return the stable data-store keys of every item represented by a row.
 
std::vector< FOOTPRINT_REFGetRowReferences (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 listMixedValues=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_FIELDGetFieldsOrdered ()
 
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 IsExpanderColumn (int aCol) const override
 
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 IsRowEdited (int aRow)
 Return true if any cell in the row has been edited.
 
void SetCurrentVariant (const wxString &aVariantName)
 Set the current variant name for highlighting purposes.
 
const wxString & GetCurrentVariant () const
 
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 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 &aRef, 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 ()
 
const std::map< wxString, wxString > & getStoredFields (const FOOTPRINT_REF &aItem) const
 Returns all stored fields for an item without creating a data-store entry.
 
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.
 
void setStoredFieldValue (const FOOTPRINT_REF &aItem, const wxString &aFieldName, const wxString &aValue)
 Creates or updates a field in the data store.
 
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)
 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.
 
virtual bool fieldIsAttribute (const wxString &aFieldName) const
 
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
 Items included by the user selection scope.
 
std::unordered_set< KIID_PATHm_selectionItems
 
wxString m_currentVariant
 Current variant name for highlighting.
 
std::vector< wxString > m_variantNames
 Variant names for multi-variant DNP filtering.
 
std::vector< DATA_MODEL_COLm_cols
 
std::map< KIID_PATH, std::map< wxString, wxString > > m_dataStore
 
std::map< int, wxGridCellAttr * > m_colAttrs
 

Private Member Functions

bool fieldIsItemProperty (const wxString &aFieldName) const 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 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)
 
bool getLiveFieldValueForVariant (const FOOTPRINT_REF &aRef, const wxString &aFieldName, const wxString &aVariantName, wxString &aValue)
 
wxString getDefaultFieldValue (const FOOTPRINT_REF &aRef, const wxString &aFieldName)
 Get the default (non-variant) value for a field.
 
std::vector< FOOTPRINT_REFgetAllItems () 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 162 of file footprint_fields_data_model.h.

Member Enumeration Documentation

◆ SCOPE

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

Member Function Documentation

◆ 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 360 of file fields_table_data_model.h.

◆ AddReferences()

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences ( const FOOTPRINT_REFERENCE_LIST & aRefs)
inherited

◆ allRowItemsHaveAttributeForcedOnBySheet()

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

Definition at line 817 of file fields_table_data_model.h.

◆ ApplyBomPreset()

void FIELDS_TABLE_DATA_MODEL_BASE::ApplyBomPreset ( const BOM_PRESET & aPreset)
inherited

Definition at line 216 of file fields_table_data_model.cpp.

◆ applyCellDecorations()

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

◆ ApplyData() [1/2]

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData ( BOARD_COMMIT & aCommit,
TEMPLATES & aTemplateFieldnames,
const wxString & aVariantName )
inherited

◆ ApplyData() [2/2]

◆ applyDataToFootprint() [1/2]

◆ applyDataToFootprint() [2/2]

◆ applyFieldPresenceRenderer()

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

Definition at line 278 of file fields_table_data_model.cpp.

References m_colAttrs.

◆ applyResolvedTextRenderer()

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

◆ attributeForcedOnBySheet()

bool FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::attributeForcedOnBySheet ( const FOOTPRINT_REF & aRef,
const wxString & aAttributeName ) 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 267 of file footprint_fields_data_model.cpp.

◆ CanClearCell()

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

Definition at line 225 of file fields_table_data_model.cpp.

◆ cellUsesResolvedTextRenderer()

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

Definition at line 271 of file fields_table_data_model.cpp.

References m_cols.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ cellUsesUrlEditor()

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

◆ Clear()

void WX_GRID_TABLE_BASE::Clear ( )
inlineoverrideinherited

Definition at line 97 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 388 of file fields_table_data_model.h.

◆ ClearSelectionItems()

void FIELDS_TABLE_DATA_MODEL_BASE::ClearSelectionItems ( )
inlineinherited

Definition at line 195 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 1054 of file fields_table_data_model.h.

◆ cloneUrlEditorAttr()

wxGridCellAttr * FIELDS_TABLE_DATA_MODEL_BASE::cloneUrlEditorAttr ( )
protectedinherited

◆ cmpRowItems()

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

Definition at line 878 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 833 of file fields_table_data_model.h.

◆ ColIsAttribute()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsAttribute ( int aCol) const
inherited

Definition at line 161 of file fields_table_data_model.cpp.

◆ ColIsComputed()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsComputed ( int aCol) const
inherited

◆ ColIsFootprint()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsFootprint ( int aCol) const
inherited

◆ 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 814 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

◆ ColIsItemProperty()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsItemProperty ( int aCol) const
inherited

Definition at line 163 of file fields_table_data_model.cpp.

◆ ColIsQuantity()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsQuantity ( int aCol) const
inherited

◆ ColIsReadOnly()

bool FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ColIsReadOnly ( int aCol) const
overridevirtualinherited

◆ ColIsReference()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsReference ( int aCol) const
inherited

◆ ColIsValue()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsValue ( int aCol) const
inherited

Definition at line 157 of file fields_table_data_model.cpp.

References m_colAttrs.

◆ CollapseForSort()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::CollapseForSort ( )
inlineinherited

Definition at line 572 of file fields_table_data_model.h.

◆ CollapseRow()

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

Definition at line 543 of file fields_table_data_model.h.

◆ commitPendingGridChanges()

void FIELDS_TABLE_DATA_MODEL_BASE::commitPendingGridChanges ( )
protectedinherited

Definition at line 281 of file fields_table_data_model.cpp.

References m_colAttrs.

◆ DeleteRows()

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

◆ DisableRebuilds()

void FIELDS_TABLE_DATA_MODEL_BASE::DisableRebuilds ( )
inherited

Definition at line 186 of file fields_table_data_model.cpp.

◆ EnableRebuilds()

void FIELDS_TABLE_DATA_MODEL_BASE::EnableRebuilds ( )
inherited

Definition at line 185 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 104 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 1046 of file fields_table_data_model.h.

◆ ExpandAfterSort()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::ExpandAfterSort ( )
inlineinherited

Definition at line 585 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 563 of file fields_table_data_model.h.

◆ ExpandRow()

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

Definition at line 500 of file fields_table_data_model.h.

◆ Export()

wxString FIELDS_TABLE_DATA_MODEL_BASE::Export ( const BOM_FMT_PRESET & aSettings)
inherited

Definition at line 218 of file fields_table_data_model.cpp.

◆ fieldIsAttribute()

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

◆ fieldIsItemProperty()

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

◆ 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 1067 of file fields_table_data_model.h.

Referenced by LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData().

◆ getAllItems()

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

◆ GetAttr()

◆ getAttributeResolvedValue()

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

Definition at line 269 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

◆ GetBomSettings()

BOM_PRESET FIELDS_TABLE_DATA_MODEL_BASE::GetBomSettings ( )
inherited

Definition at line 217 of file fields_table_data_model.cpp.

◆ GetColDataWidth()

int FIELDS_TABLE_DATA_MODEL_BASE::GetColDataWidth ( int aCol)
inherited

Definition at line 143 of file fields_table_data_model.cpp.

References m_colAttrs.

◆ GetColFieldName()

wxString FIELDS_TABLE_DATA_MODEL_BASE::GetColFieldName ( int aCol)
inherited

Definition at line 142 of file fields_table_data_model.cpp.

◆ GetColLabelValue()

wxString FIELDS_TABLE_DATA_MODEL_BASE::GetColLabelValue ( int aCol)
overrideinherited

Definition at line 141 of file fields_table_data_model.cpp.

◆ GetCurrentVariant()

const wxString & FIELDS_TABLE_DATA_MODEL_BASE::GetCurrentVariant ( ) const
inlineinherited

Definition at line 244 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
aRefThe footprint reference.
aFieldNameThe name of the field.
Returns
The default field value.

Definition at line 332 of file footprint_fields_data_model.cpp.

References getLiveFieldValueForVariant().

Referenced by GetAttr().

◆ GetExcludeDNP()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetExcludeDNP ( )
inlineinherited

Definition at line 208 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 733 of file fields_table_data_model.h.

◆ GetFieldNameCol()

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

◆ 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 192 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 146 of file fields_table_data_model.cpp.

◆ GetFilter()

const wxString & FIELDS_TABLE_DATA_MODEL_BASE::GetFilter ( )
inlineinherited

Definition at line 190 of file fields_table_data_model.h.

◆ GetFilterScope()

BOM_FILTER_SCOPE FIELDS_TABLE_DATA_MODEL_BASE::GetFilterScope ( ) const
inlineinherited

Definition at line 192 of file fields_table_data_model.h.

◆ GetGroupColumn()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetGroupColumn ( int aCol)
inherited

Definition at line 211 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 listMixedValues = false )
inlineinherited

Definition at line 594 of file fields_table_data_model.h.

◆ GetGroupingEnabled()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetGroupingEnabled ( )
inlineinherited

Definition at line 198 of file fields_table_data_model.h.

◆ GetIncludeExcludedFromBOM()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetIncludeExcludedFromBOM ( )
inlineinherited

Definition at line 205 of file fields_table_data_model.h.

◆ getItemIdentifier()

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

◆ 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 829 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().

◆ getLiveFieldValueForVariant()

bool FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant ( const FOOTPRINT_REF & aRef,
const wxString & aFieldName,
const wxString & aVariantName,
wxString & aValue )
privateinherited

◆ GetNumberCols()

int FIELDS_TABLE_DATA_MODEL_BASE::GetNumberCols ( )
inlineoverrideinherited

Definition at line 138 of file fields_table_data_model.h.

◆ GetNumberRows()

int FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::GetNumberRows ( )
inlineoverrideinherited

Definition at line 445 of file fields_table_data_model.h.

Referenced by RemoveColumn().

◆ 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 728 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 449 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 462 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 446 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 214 of file fields_table_data_model.cpp.

◆ GetSortAsc()

bool FIELDS_TABLE_DATA_MODEL_BASE::GetSortAsc ( )
inlineinherited

Definition at line 181 of file fields_table_data_model.h.

◆ GetSortCol()

int FIELDS_TABLE_DATA_MODEL_BASE::GetSortCol ( )
inlineinherited

Definition at line 180 of file fields_table_data_model.h.

◆ getStoredFields()

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

Returns all stored fields for an item without creating a data-store entry.

Definition at line 1001 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 1019 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 720 of file fields_table_data_model.h.

Referenced by SetFieldsOrder().

◆ GetVariantNames()

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

Definition at line 247 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

◆ 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 251 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 1113 of file fields_table_data_model.h.

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

◆ 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 1099 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 409 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 430 of file fields_table_data_model.h.

◆ IsCellReadOnly()

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

◆ IsEdited()

bool FIELDS_TABLE_DATA_MODEL_BASE::IsEdited ( )
inlineinherited

Definition at line 130 of file fields_table_data_model.h.

◆ IsEmptyCell()

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

Definition at line 149 of file fields_table_data_model.h.

◆ IsExpanderColumn()

bool FIELDS_TABLE_DATA_MODEL_BASE::IsExpanderColumn ( int aCol) const
overrideinherited

Definition at line 176 of file fields_table_data_model.cpp.

◆ 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 229 of file fields_table_data_model.cpp.

References m_cols.

◆ MatchesFilter()

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

◆ MoveColumn()

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

Definition at line 134 of file fields_table_data_model.cpp.

◆ RebuildRows()

◆ RemoveColumn()

void FIELDS_TABLE_DATA_MODEL_BASE::RemoveColumn ( int aCol)
inherited

Definition at line 135 of file fields_table_data_model.cpp.

References GetNumberRows().

◆ RemoveFootprint()

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RemoveFootprint ( const FOOTPRINT_REF & aRef)
inherited

◆ RemoveReferences()

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::RemoveReferences ( const FOOTPRINT_REFERENCE_LIST & aRefs)
inherited

Definition at line 730 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 136 of file fields_table_data_model.cpp.

References DATASHEET, and UNTRANSLATED.

◆ resolveTextVars()

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

◆ RestoreUndoState()

void FIELDS_TABLE_DATA_MODEL_BASE::RestoreUndoState ( const wxString & aState)
overrideinherited

Definition at line 253 of file fields_table_data_model.cpp.

References m_cols, and m_sortColumn.

◆ 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 474 of file fields_table_data_model.h.

◆ SerializeUndoState()

wxString FIELDS_TABLE_DATA_MODEL_BASE::SerializeUndoState ( ) const
overrideinherited

Definition at line 252 of file fields_table_data_model.cpp.

References m_sortColumn.

◆ setAttributeValue()

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

Set the attribute value.

Parameters
aReferenceis a reference to the footprint to set the attribute.
aAttributeNameis the name of the footprint attribute.
aValueis the value to set the attribute.
aVariantNameis an optional variant name to set the variant attribute.
Return values
trueif the footprint attribute value has changed.
falseif the footprint attribute has not changed.

Definition at line 341 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().

◆ SetColAttr()

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

Definition at line 66 of file wx_grid.h.

◆ SetColLabelValue()

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

Definition at line 140 of file fields_table_data_model.cpp.

◆ SetCurrentVariant()

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

Set the current variant name for highlighting purposes.

When a variant is set, cells that differ from the default (non-variant) value will be highlighted.

Parameters
aVariantNameThe name of the current variant, or empty string for default.

Definition at line 243 of file fields_table_data_model.h.

◆ SetExcludeDNP()

void FIELDS_TABLE_DATA_MODEL_BASE::SetExcludeDNP ( bool aExclude)
inlineinherited

Definition at line 207 of file fields_table_data_model.h.

◆ SetFieldsOrder()

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

Definition at line 147 of file fields_table_data_model.cpp.

References GetValue().

◆ SetFilter()

void FIELDS_TABLE_DATA_MODEL_BASE::SetFilter ( const wxString & aFilter)
inlineinherited

Definition at line 189 of file fields_table_data_model.h.

◆ SetFilterScope()

void FIELDS_TABLE_DATA_MODEL_BASE::SetFilterScope ( BOM_FILTER_SCOPE aScope)
inlineinherited

Definition at line 191 of file fields_table_data_model.h.

◆ SetGroupColumn()

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

Definition at line 210 of file fields_table_data_model.cpp.

◆ SetGroupingEnabled()

void FIELDS_TABLE_DATA_MODEL_BASE::SetGroupingEnabled ( bool aGroup)
inlineinherited

Definition at line 197 of file fields_table_data_model.h.

◆ SetIncludeExcludedFromBOM()

void FIELDS_TABLE_DATA_MODEL_BASE::SetIncludeExcludedFromBOM ( bool aInclude)
inlineinherited

Definition at line 204 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 194 of file fields_table_data_model.h.

◆ SetShowColumn()

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

Definition at line 213 of file fields_table_data_model.cpp.

◆ SetSorting()

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

Definition at line 179 of file fields_table_data_model.cpp.

References m_stripedRenderer.

◆ 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 1036 of file fields_table_data_model.h.

Referenced by FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue().

◆ SetValue()

◆ SetVariantNames()

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

Definition at line 246 of file fields_table_data_model.h.

◆ Sort()

void FIELDS_TABLE_DATA_MODEL< FOOTPRINT_REF >::Sort ( )
inlineprotectedinherited

◆ 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 170 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 )
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 1084 of file fields_table_data_model.h.

Referenced by LIB_FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData().

◆ UpdateReferences()

void FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences ( const FOOTPRINT_REFERENCE_LIST & aRefs)
inherited

Member Data Documentation

◆ FOOTPRINT_KEYWORDS

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

◆ 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 167 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

◆ ITEM_NUMBER_VARIABLE

const wxString FIELDS_TABLE_DATA_MODEL_BASE::ITEM_NUMBER_VARIABLE
staticinherited

Definition at line 128 of file fields_table_data_model.h.

◆ m_colAttrs

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

◆ m_cols

◆ m_currentVariant

◆ m_dataStore

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

◆ m_edited

◆ m_excludeDNP

bool FIELDS_TABLE_DATA_MODEL_BASE::m_excludeDNP
protectedinherited

◆ m_filter

wxString FIELDS_TABLE_DATA_MODEL_BASE::m_filter
protectedinherited

◆ m_filterScope

BOM_FILTER_SCOPE FIELDS_TABLE_DATA_MODEL_BASE::m_filterScope
protectedinherited

Definition at line 291 of file fields_table_data_model.h.

◆ m_footprintsList

◆ m_groupingEnabled

bool FIELDS_TABLE_DATA_MODEL_BASE::m_groupingEnabled
protectedinherited

◆ m_includeExcluded

bool FIELDS_TABLE_DATA_MODEL_BASE::m_includeExcluded
protectedinherited

◆ m_path

KIID_PATH FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::m_path
protectedinherited

Definition at line 158 of file footprint_fields_data_model.h.

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

◆ m_rebuildsEnabled

bool FIELDS_TABLE_DATA_MODEL_BASE::m_rebuildsEnabled
protectedinherited

Items included by the user selection scope.

Definition at line 295 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 285 of file fields_table_data_model.h.

◆ m_rows

◆ m_scope

SCOPE FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::m_scope
protectedinherited

◆ m_selectionItems

std::unordered_set<KIID_PATH> FIELDS_TABLE_DATA_MODEL_BASE::m_selectionItems
protectedinherited

◆ m_sortAscending

bool FIELDS_TABLE_DATA_MODEL_BASE::m_sortAscending
protectedinherited

Definition at line 289 of file fields_table_data_model.h.

◆ m_sortColumn

int FIELDS_TABLE_DATA_MODEL_BASE::m_sortColumn
protectedinherited

◆ m_stripedRenderer

wxGridCellRenderer* FIELDS_TABLE_DATA_MODEL_BASE::m_stripedRenderer
protectedinherited

Definition at line 284 of file fields_table_data_model.h.

Referenced by ColIsComputed(), and SetSorting().

◆ m_variantNames

std::vector<wxString> FIELDS_TABLE_DATA_MODEL_BASE::m_variantNames
protectedinherited

Variant names for multi-variant DNP filtering.

Definition at line 301 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 127 of file fields_table_data_model.h.


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