KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL Class Reference

#include <symbol_fields_data_model.h>

Inheritance diagram for SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL:
FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE > 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

 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL (const SCH_REFERENCE_LIST &aSymbolsList)
 
wxGridCellAttr * GetAttr (int aRow, int aCol, wxGridCellAttr::wxAttrKind aKind) override
 
void SetValue (int aRow, int aCol, const wxString &aValue) 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 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 RebuildRows () override
 
void ApplyData (SCH_COMMIT &aCommit, TEMPLATES &aTemplateFieldnames)
 
void SetScope (SCOPE aScope)
 
SCOPE GetScope ()
 
void SetPath (const SCH_SHEET_PATH &aPath)
 
const SCH_SHEET_PATH & GetPath ()
 
void AddReferences (const SCH_REFERENCE_LIST &aRefs)
 
void RemoveReferences (const SCH_REFERENCE_LIST &aRefs)
 
void RemoveSymbol (const SCH_SYMBOL &aSymbol)
 
void UpdateReferences (const SCH_REFERENCE_LIST &aRefs)
 
bool DeleteRows (size_t aPosition=0, size_t aNumRows=1) override
 
const SCH_REFERENCE_LIST & GetReferenceList () const
 
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 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< SCH_REFERENCE > GetRowReferences (int aRow) const
 
void ExpandRow (int aRow)
 
void CollapseRow (int aRow)
 
void ExpandCollapseRow (int aRow) override
 
void CollapseForSort ()
 
void ExpandAfterSort ()
 
wxString GetGroupedValue (const DATA_MODEL_ROW< SCH_REFERENCE > &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
 
virtual bool ColIsItemIdentifier (int aCol) const
 Reference for symbol/fields tables, lib_id for lib tables.
 
virtual bool ColIsReadOnly (int aCol) const
 
bool HasRowLabelExpanders () const override
 Show grouping controls in the row headers instead of row numbers.
 
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 QUANTITY_VARIABLE
 
static const wxString ITEM_NUMBER_VARIABLE
 

Protected Member Functions

bool MatchesFilter (const SCH_REFERENCE &aItem, const wxString &aReference, EDA_COMBINED_MATCHER &aMatcher)
 
bool attributeForcedOnBySheet (const SCH_REFERENCE &aItem, const wxString &aAttributeName) const
 Sheets can force all the symbols in them to have certain attributes on, like DNP.
 
bool allRowItemsHaveAttributeForcedOnBySheet (const DATA_MODEL_ROW< SCH_REFERENCE > &aRow, int aCol)
 
bool cmpRows (const DATA_MODEL_ROW< SCH_REFERENCE > &lhRow, const DATA_MODEL_ROW< SCH_REFERENCE > &rhRow, int aSortCol, bool aAscending)
 
virtual bool cmpRowItems (const SCH_REFERENCE &lhItem, const SCH_REFERENCE &rhItem)
 
bool groupMatch (const SCH_REFERENCE &lhItem, const SCH_REFERENCE &rhItem)
 
void Sort ()
 
std::map< wxString, wxString > getStoredFields (const SCH_REFERENCE &aItem, const wxString &aVariant) const
 Returns the edited, present fields belonging to a variant without creating entries.
 
bool getStoredFieldValue (const SCH_REFERENCE &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 SCH_REFERENCE &aItem, wxString *aToken, bool aCaseSensitive=false) const
 Resolve an ordinary field token from the current variant's staged values.
 
void setStoredFieldValue (const SCH_REFERENCE &aItem, const wxString &aFieldName, const wxString &aValue)
 Creates or updates a field in the data store.
 
void ensureStoredFieldPresent (const SCH_REFERENCE &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 SCH_REFERENCE &aItem, const wxString &aFieldName)
 Clears a field, e.g.
 
bool fieldIsModified (const SCH_REFERENCE &aItem, const wxString &aFieldName)
 Compares the live value of the field to the stored value in the data store.
 
void updateDataStoreItemFieldFromLive (const SCH_REFERENCE &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 SCH_REFERENCE &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 SCH_REFERENCE &aItem)
 Initializes every column in the data store for a newly added (or refreshed) item.
 
FIELD_STORE_VALUE & storedField (const SCH_REFERENCE &aItem, const wxString &aFieldName)
 
FIELD_STORE_VALUE & storedField (const SCH_REFERENCE &aItem, const wxString &aFieldName, const wxString &aVariantName)
 
void refreshDataStoreItem (const SCH_REFERENCE &aItem)
 
bool storedFieldIsRemoved (const SCH_REFERENCE &aItem, const wxString &aName) const
 
std::set< wxString > storedVariants (const SCH_REFERENCE &aItem) const
 
void acceptDataStoreItem (const SCH_REFERENCE &aItem)
 
virtual void getEffectiveFieldValue (const SCH_REFERENCE &aItem, const wxString &aFieldName, wxString &aValue) const
 
virtual bool fieldIsAttribute (const wxString &aFieldName) const
 
virtual bool fieldIsItemProperty (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

SCH_REFERENCE_LIST m_symbolsList
 The flattened by hierarchy list of symbols.
 
SCOPE m_scope
 
SCH_SHEET_PATH m_path
 
std::vector< DATA_MODEL_ROW< SCH_REFERENCE > > 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

void setCellValues (int aRow, int aCol, const std::vector< wxString > &aValues) override
 Write one value per item represented by the cell. Models may propagate shared storage.
 
bool fieldSupportsVariants (const wxString &aFieldName) const override
 
bool unitMatch (const SCH_REFERENCE &lhItem, const SCH_REFERENCE &rhItem) override
 
bool storageIsSharedAcrossPaths (const wxString &aFieldName) const
 Test whether a field's storage is common to every sheet path that reaches a symbol.
 
bool attributeForcedOnBySheet (const SCH_REFERENCE &aRef, const wxString &aAttributeName, const wxString &aVariantName) const override
 
wxString getAttributeValue (const SCH_REFERENCE &aRef, const wxString &aAttributeName, const wxString &aVariantNames)
 
bool getLiveFieldValueForVariant (const SCH_REFERENCE &aRef, const wxString &aFieldName, const wxString &aVariantName, wxString &aValue) override
 
wxString getDefaultFieldValue (const SCH_REFERENCE &aRef, const wxString &aFieldName)
 Get the default (non-variant) value for a field.
 
bool setAttributeValue (SCH_REFERENCE &aRef, const wxString &aAttributeName, const wxString &aValue, const wxString &aVariantName=wxEmptyString)
 Set the attribute value.
 
bool getLiveFieldValue (const SCH_REFERENCE &aRef, const wxString &aFieldName, wxString &aValue) override
 Gets the current value of the field from the live item, e.g.
 
std::vector< SCH_REFERENCE > getAllItems () const override
 
wxString getFieldResolvedLiveValue (const SCH_REFERENCE &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 SCH_REFERENCE &aRef, const wxString &aText) override
 
KIID_PATH getDataStoreKey (const SCH_REFERENCE &aItem) const override
 Create a unique key for the data store by combining the KIID_PATH from the SCH_SHEET_PATH with the symbol's UUID.
 
wxString getItemIdentifier (const SCH_REFERENCE &aItem) const override
 

Detailed Description

Definition at line 43 of file symbol_fields_data_model.h.

Member Enumeration Documentation

◆ SCOPE

enum SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::SCOPE : int
Enumerator
SCOPE_ALL 
SCOPE_SHEET 
SCOPE_SHEET_RECURSIVE 
SCOPE_SELECTION 

Definition at line 46 of file symbol_fields_data_model.h.

Constructor & Destructor Documentation

◆ SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL()

SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL ( const SCH_REFERENCE_LIST & aSymbolsList)
inline

Definition at line 54 of file symbol_fields_data_model.h.

References m_scope, m_symbolsList, and SCOPE_ALL.

Member Function Documentation

◆ acceptDataStoreItem()

void FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::acceptDataStoreItem ( const SCH_REFERENCE & aItem)
inlineprotectedinherited

Definition at line 1402 of file fields_table_data_model.h.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData().

◆ AddColumn()

void FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences ( const SCH_REFERENCE_LIST & aRefs)

Definition at line 794 of file symbol_fields_data_model.cpp.

References getDataStoreKey(), getLiveFieldValueForVariant(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::initializeDataStoreItem(), FIELD_VALUE_STATE::m_baseline, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_dataStore, FIELD_STORE_VALUE::m_present, m_symbolsList, FIELD_VALUE_STATE::m_value, FIELD_STORE_VALUE::m_variants, name, source, and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::storedField().

◆ allRowItemsHaveAttributeForcedOnBySheet()

bool FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::allRowItemsHaveAttributeForcedOnBySheet ( const DATA_MODEL_ROW< SCH_REFERENCE > & 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.

◆ 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ ApplyData()

void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData ( SCH_COMMIT & aCommit,
TEMPLATES & aTemplateFieldnames )

Definition at line 676 of file symbol_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::acceptDataStoreItem(), SCH_SYMBOL::AddField(), SCHEMATIC::ConvertRefsToKIIDs(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::fieldIsAttribute(), SCH_SYMBOL::GetField(), TEMPLATES::GetFieldName(), SCH_SYMBOL::GetFields(), SCH_FIELD::GetId(), SCH_SYMBOL::GetPosition(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::getStoredFields(), SCH_FIELD::GetText(), EDA_TEXT::GetTextAngle(), IsGeneratedField(), SCH_ITEM::IsPrivate(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_edited, m_symbolsList, COMMIT::Modified(), REFERENCE, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::refreshDataStoreItem(), SCH_SYMBOL::RemoveField(), SCH_ITEM::Schematic(), setAttributeValue(), SCH_ITEM::SetPrivate(), SCH_FIELD::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetVisible(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::storedFieldIsRemoved(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::storedVariants(), and USER.

Referenced by ISSUE25112_FIXTURE::Apply().

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

◆ applyResolvedTextRenderer()

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

Definition at line 307 of file fields_table_data_model.cpp.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ attributeForcedOnBySheet() [1/2]

bool FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::attributeForcedOnBySheet ( const SCH_REFERENCE & 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::attributeForcedOnBySheet ( const SCH_REFERENCE & aRef,
const wxString & aAttributeName,
const wxString & aVariantName ) const
overrideprivatevirtual

Reimplemented from FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Definition at line 426 of file symbol_fields_data_model.cpp.

References SCH_REFERENCE::GetSheetPath(), and path.

◆ CanClearCell()

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

Definition at line 250 of file fields_table_data_model.cpp.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ClearCell().

◆ CanCopyCellFromVariant()

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

Definition at line 251 of file fields_table_data_model.cpp.

◆ 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 SYMBOL_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 SYMBOL_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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ClearCell ( int aRow,
int aCol )
overridevirtual

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

Reimplemented from FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Definition at line 174 of file symbol_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::CanClearCell(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::clearStoredField(), SCH_REFERENCE::GetSymbol(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_cols, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_edited, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_rows, and m_symbolsList.

◆ 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< SCH_REFERENCE >::clearStoredField ( const SCH_REFERENCE & 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.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ClearCell().

◆ cloneUrlEditorAttr()

wxGridCellAttr * FIELDS_TABLE_DATA_MODEL_BASE::cloneUrlEditorAttr ( )
protectedinherited

Definition at line 310 of file fields_table_data_model.cpp.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ cmpRowItems()

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

Definition at line 964 of file fields_table_data_model.h.

◆ cmpRows()

bool FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::cmpRows ( const DATA_MODEL_ROW< SCH_REFERENCE > & lhRow,
const DATA_MODEL_ROW< SCH_REFERENCE > & 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.

◆ ColIsFootprint()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsFootprint ( int aCol) const
inherited

Definition at line 183 of file fields_table_data_model.cpp.

◆ ColIsItemIdentifier()

virtual bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsItemIdentifier ( int aCol) const
inlinevirtualinherited

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

Definition at line 198 of file fields_table_data_model.h.

◆ 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 SYMBOL_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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ ColIsReadOnly()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsReadOnly ( int aCol) const
virtualinherited

Definition at line 200 of file fields_table_data_model.cpp.

◆ ColIsReference()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsReference ( int aCol) const
inherited

Definition at line 179 of file fields_table_data_model.cpp.

Referenced by SYMBOL_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< SCH_REFERENCE >::CollapseForSort ( )
inlineinherited

Definition at line 643 of file fields_table_data_model.h.

◆ CollapseRow()

void FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::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.

◆ CopyCellFromVariant()

void FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::DeleteRows ( size_t aPosition = 0,
size_t aNumRows = 1 )
override

Definition at line 939 of file symbol_fields_data_model.cpp.

References SCH_REFERENCE_LIST::AddItem(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_dataStore, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_rows, m_symbolsList, 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.

◆ 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ ensureStoredFieldPresent()

void FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::ensureStoredFieldPresent ( const SCH_REFERENCE & 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.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setCellValues().

◆ ExpandAfterSort()

void FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::ExpandAfterSort ( )
inlineinherited

Definition at line 657 of file fields_table_data_model.h.

◆ ExpandCollapseRow()

void FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::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< SCH_REFERENCE >::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.

◆ fieldIsAttribute()

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

Definition at line 292 of file fields_table_data_model.cpp.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant().

◆ fieldIsItemProperty()

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

Definition at line 297 of file fields_table_data_model.cpp.

◆ fieldIsModified()

bool FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::fieldIsModified ( const SCH_REFERENCE & 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::fieldSupportsVariants ( const wxString & aFieldName) const
overrideprivatevirtual

Reimplemented from FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 303 of file symbol_fields_data_model.cpp.

References GetDefaultFieldName(), REFERENCE, and UNTRANSLATED.

◆ 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< SCH_REFERENCE > SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getAllItems ( ) const
overrideprivatevirtual

Implements FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Definition at line 328 of file symbol_fields_data_model.cpp.

References m_symbolsList.

◆ GetAttr()

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

Definition at line 58 of file symbol_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::applyCellDecorations(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::applyResolvedTextRenderer(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::cellUsesResolvedTextRenderer(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::cellUsesUrlEditor(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::cloneUrlEditorAttr(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::ColIsItemNumber(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::ColIsQuantity(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::ColIsReference(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::enhanceAttr(), WX_GRID_TABLE_BASE::GetAttr(), getDefaultFieldValue(), SCH_REFERENCE::GetSheetPath(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::getStoredFieldValue(), SCH_REFERENCE::GetSymbol(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::IsCellReadOnly(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_colAttrs, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_cols, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_currentVariant, DATA_MODEL_ROW< ITEM_TYPE >::m_items, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_rows, FIELDS_TABLE_COLOR::VARIANT_FIELD_OVERRIDE_DARK_YELLOW(), FIELDS_TABLE_COLOR::VARIANT_FIELD_OVERRIDE_LIGHT_YELLOW(), FIELDS_TABLE_COLOR::VARIANT_SYMBOL_OVERRIDE_DARK_BLUE(), and FIELDS_TABLE_COLOR::VARIANT_SYMBOL_OVERRIDE_LIGHT_BLUE().

◆ 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue ( const SCH_REFERENCE & aRef,
const wxString & aAttributeName,
const wxString & aVariantNames )
private

Definition at line 403 of file symbol_fields_data_model.cpp.

References SCH_REFERENCE::GetSymbolDNP(), SCH_REFERENCE::GetSymbolExcludedFromBoard(), SCH_REFERENCE::GetSymbolExcludedFromBOM(), SCH_REFERENCE::GetSymbolExcludedFromPosFiles(), and SCH_REFERENCE::GetSymbolExcludedFromSim().

Referenced by getLiveFieldValueForVariant().

◆ GetBomSettings()

BOM_PRESET FIELDS_TABLE_DATA_MODEL_BASE::GetBomSettings ( )
inherited

Definition at line 242 of file fields_table_data_model.cpp.

◆ 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getDataStoreKey ( const SCH_REFERENCE & aItem) const
overrideprivatevirtual

Create a unique key for the data store by combining the KIID_PATH from the SCH_SHEET_PATH with the symbol's UUID.

Returns
A KIID_PATH representing the full SCH_SHEET_PATH + symbol UUID.

Implements FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Definition at line 44 of file symbol_fields_data_model.cpp.

References SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), EDA_ITEM::m_Uuid, SCH_SHEET_PATH::Path(), and path.

Referenced by AddReferences(), RebuildRows(), and RemoveReferences().

◆ getDefaultFieldValue()

wxString SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getDefaultFieldValue ( const SCH_REFERENCE & aRef,
const wxString & aFieldName )
private

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

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

Parameters
aRefThe symbol reference.
aFieldNameThe name of the field.
Returns
The default field value.

Definition at line 482 of file symbol_fields_data_model.cpp.

References getLiveFieldValueForVariant().

Referenced by GetAttr().

◆ getEffectiveFieldValue()

virtual void FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::getEffectiveFieldValue ( const SCH_REFERENCE & 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< SCH_REFERENCE >::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.

◆ getFieldResolvedLiveValue()

wxString SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getFieldResolvedLiveValue ( const SCH_REFERENCE & aItem,
const wxString & aFieldName )
overrideprivatevirtual

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< SCH_REFERENCE >.

Definition at line 342 of file symbol_fields_data_model.cpp.

References SCH_SYMBOL::GetField(), SCH_REFERENCE::GetSheetPath(), SCH_FIELD::GetShownText(), SCH_REFERENCE::GetSymbol(), INTERNAL, IsGeneratedField(), SCH_ITEM::IsPrivate(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_currentVariant, path, SCH_SYMBOL::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< SCH_REFERENCE >::GetGroupedValue ( const DATA_MODEL_ROW< SCH_REFERENCE > & 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getItemIdentifier ( const SCH_REFERENCE & aItem) const
overrideprivatevirtual

Implements FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Definition at line 52 of file symbol_fields_data_model.cpp.

References SCH_REFERENCE::GetRef(), and SCH_REFERENCE::GetRefNumber().

◆ getLiveFieldValue()

bool SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValue ( const SCH_REFERENCE & 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).

Implements FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Definition at line 320 of file symbol_fields_data_model.cpp.

References getLiveFieldValueForVariant(), and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_currentVariant.

Referenced by RevertRow().

◆ getLiveFieldValueForVariant()

bool SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant ( const SCH_REFERENCE & aRef,
const wxString & aFieldName,
const wxString & aVariantName,
wxString & aValue )
overrideprivatevirtual

Reimplemented from FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Definition at line 445 of file symbol_fields_data_model.cpp.

References SCHEMATIC::ConvertKIIDsToRefs(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::fieldIsAttribute(), getAttributeValue(), SCH_SYMBOL::GetField(), SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), IsGeneratedField(), and SCH_ITEM::Schematic().

Referenced by AddReferences(), getDefaultFieldValue(), and 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< SCH_REFERENCE >::GetNumberRows ( )
inlineoverrideinherited

Definition at line 518 of file fields_table_data_model.h.

◆ GetPath()

const SCH_SHEET_PATH & SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetPath ( )
inline

Definition at line 75 of file symbol_fields_data_model.h.

References m_path.

◆ GetReferenceList()

const SCH_REFERENCE_LIST & SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetReferenceList ( ) const
inline

Definition at line 84 of file symbol_fields_data_model.h.

References m_symbolsList.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom().

◆ GetResolvedValue()

wxString FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::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< SCH_REFERENCE >::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< SCH_REFERENCE > FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::GetRowReferences ( int aRow) const
inlineinherited

Definition at line 535 of file fields_table_data_model.h.

◆ GetRowState()

ROW_STATE FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::GetRowState ( int aRow) const
inlineoverridevirtualinherited

Reimplemented from WX_GRID_TABLE_BASE.

Definition at line 519 of file fields_table_data_model.h.

◆ GetScope()

SCOPE SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetScope ( )
inline

Definition at line 72 of file symbol_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< SCH_REFERENCE >::getStoredFields ( const SCH_REFERENCE & 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData().

◆ getStoredFieldValue()

bool FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::getStoredFieldValue ( const SCH_REFERENCE & 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RevertRow(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setCellValues().

◆ GetValue()

wxString FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::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< SCH_REFERENCE >::groupMatch ( const SCH_REFERENCE & lhItem,
const SCH_REFERENCE & rhItem )
inlineprotectedinherited

Definition at line 971 of file fields_table_data_model.h.

Referenced by SYMBOL_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< SCH_REFERENCE >::initializeDataStoreItem ( const SCH_REFERENCE & 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences().

◆ initializeDataStoreItemField()

void FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::initializeDataStoreItemField ( const SCH_REFERENCE & 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< SCH_REFERENCE >::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< SCH_REFERENCE >::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< SCH_REFERENCE >::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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), and SYMBOL_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< SCH_REFERENCE >::MatchesFilter ( const SCH_REFERENCE & aItem,
const wxString & aReference,
EDA_COMBINED_MATCHER & aMatcher )
inlineprotectedinherited

Definition at line 827 of file fields_table_data_model.h.

Referenced by SYMBOL_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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows ( )
overridevirtual

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 539 of file symbol_fields_data_model.cpp.

References CTX_SEARCH, getDataStoreKey(), SCH_SHEET_PATH::GetDNP(), SCH_SHEET_PATH::GetExcludedFromBOM(), SCH_REFERENCE::GetFullRef(), SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::groupMatch(), SCH_SHEET_PATH::IsContainedWithin(), SCH_REFERENCE::IsMultiUnit(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_currentVariant, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_excludeDNP, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_filter, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_groupingEnabled, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_includeExcluded, m_path, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_rebuildsEnabled, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_rows, m_scope, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_selectionItems, m_symbolsList, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_variantNames, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::MatchesFilter(), SCH_ITEM::ResolveDNP(), SCH_ITEM::ResolveExcludedFromBOM(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::Sort(), and unitMatch().

Referenced by DeleteRows().

◆ refreshDataStoreItem()

void FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::refreshDataStoreItem ( const SCH_REFERENCE & aItem)
inlineprotectedinherited

Definition at line 1334 of file fields_table_data_model.h.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), and SYMBOL_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.

◆ RemoveReferences()

void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RemoveReferences ( const SCH_REFERENCE_LIST & aRefs)

Definition at line 879 of file symbol_fields_data_model.cpp.

References getDataStoreKey(), index, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_dataStore, and m_symbolsList.

Referenced by DeleteRows().

◆ RemoveSymbol()

void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RemoveSymbol ( const SCH_SYMBOL & aSymbol)

Definition at line 849 of file symbol_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_dataStore, m_symbolsList, and EDA_ITEM::m_Uuid.

◆ 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< SCH_REFERENCE >::resolveStoredTextVar ( const SCH_REFERENCE & 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars().

◆ resolveTextVars()

wxString SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars ( const SCH_REFERENCE & aRef,
const wxString & aText )
overrideprivatevirtual

Implements FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Definition at line 375 of file symbol_fields_data_model.cpp.

References SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_currentVariant, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::resolveStoredTextVar(), SCH_SYMBOL::ResolveTextVar(), and ResolveTextVars().

◆ RestoreUndoState()

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

Definition at line 284 of file fields_table_data_model.cpp.

◆ RevertRow()

void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RevertRow ( int aRow)
overridevirtual

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.

Reimplemented from FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Definition at line 203 of file symbol_fields_data_model.cpp.

References getLiveFieldValue(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::getStoredFieldValue(), SCH_REFERENCE::GetSymbol(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_cols, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_rows, m_symbolsList, FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::RevertRow(), storageIsSharedAcrossPaths(), and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::updateDataStoreItemFieldFromLive().

◆ SerializeUndoState()

wxString FIELDS_TABLE_DATA_MODEL_BASE::SerializeUndoState ( ) const
overrideinherited

Definition at line 283 of file fields_table_data_model.cpp.

◆ setAttributeValue()

bool SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue ( SCH_REFERENCE & aRef,
const wxString & aAttributeName,
const wxString & aValue,
const wxString & aVariantName = wxEmptyString )
private

Set the attribute value.

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

Definition at line 491 of file symbol_fields_data_model.cpp.

References SCH_REFERENCE::GetSymbolDNP(), SCH_REFERENCE::GetSymbolExcludedFromBoard(), SCH_REFERENCE::GetSymbolExcludedFromBOM(), SCH_REFERENCE::GetSymbolExcludedFromPosFiles(), SCH_REFERENCE::GetSymbolExcludedFromSim(), SCH_REFERENCE::SetSymbolDNP(), SCH_REFERENCE::SetSymbolExcludedFromBoard(), SCH_REFERENCE::SetSymbolExcludedFromBOM(), SCH_REFERENCE::SetSymbolExcludedFromPosFiles(), and SCH_REFERENCE::SetSymbolExcludedFromSim().

Referenced by ApplyData().

◆ setCellValues()

void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setCellValues ( int aRow,
int aCol,
const std::vector< wxString > & aValues )
overrideprivatevirtual

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

Reimplemented from FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Definition at line 257 of file symbol_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::ensureStoredFieldPresent(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::getStoredFieldValue(), SCH_REFERENCE::GetSymbol(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_cols, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_rows, m_symbolsList, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::setStoredFieldValue(), and storageIsSharedAcrossPaths().

Referenced by SetValue().

◆ 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< SCH_REFERENCE >::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
aVariantNameThe 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.

◆ 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::SetPath ( const SCH_SHEET_PATH & aPath)
inline

Definition at line 74 of file symbol_fields_data_model.h.

References m_path.

◆ SetScope()

void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::SetScope ( SCOPE aScope)
inline

Definition at line 71 of file symbol_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.

◆ setStoredFieldValue()

void FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::setStoredFieldValue ( const SCH_REFERENCE & 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setCellValues().

◆ SetValue()

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

Definition at line 159 of file symbol_fields_data_model.cpp.

References INDETERMINATE_STATE, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::IsCellReadOnly(), FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_cols, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_edited, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_rows, and setCellValues().

◆ 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< SCH_REFERENCE >::Sort ( )
inlineprotectedinherited

Definition at line 1043 of file fields_table_data_model.h.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ storageIsSharedAcrossPaths()

bool SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::storageIsSharedAcrossPaths ( const wxString & aFieldName) const
private

Test whether a field's storage is common to every sheet path that reaches a symbol.

Shared sheets present one symbol under several paths. Edits to storage they have in common must be recorded against all of those paths, while variant overrides belong to a single symbol instance.

Parameters
aFieldNameis the untranslated field or attribute name.
Return values
trueif the field is stored on the symbol.
falseif the field is stored on the symbol instance.

Definition at line 392 of file symbol_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_currentVariant.

Referenced by RevertRow(), and setCellValues().

◆ storedField() [1/2]

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

Definition at line 1308 of file fields_table_data_model.h.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences().

◆ storedField() [2/2]

FIELD_STORE_VALUE & FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::storedField ( const SCH_REFERENCE & 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< SCH_REFERENCE >::storedFieldIsRemoved ( const SCH_REFERENCE & aItem,
const wxString & aName ) const
inlineprotectedinherited

Definition at line 1374 of file fields_table_data_model.h.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData().

◆ storedVariants()

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

Definition at line 1385 of file fields_table_data_model.h.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData().

◆ unitMatch()

bool SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch ( const SCH_REFERENCE & lhItem,
const SCH_REFERENCE & rhItem )
overrideprivatevirtual

Implements FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >.

Definition at line 310 of file symbol_fields_data_model.cpp.

References SCH_REFERENCE::GetRef(), and SCH_REFERENCE::GetRefNumber().

Referenced by RebuildRows().

◆ updateDataStoreItemFieldFromLive()

void FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::updateDataStoreItemFieldFromLive ( const SCH_REFERENCE & 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.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RevertRow().

◆ updateEditedState()

void FIELDS_TABLE_DATA_MODEL_BASE::updateEditedState ( )
protectedinherited

Definition at line 301 of file fields_table_data_model.cpp.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences().

◆ UpdateReferences()

void SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences ( const SCH_REFERENCE_LIST & aRefs)

Definition at line 894 of file symbol_fields_data_model.cpp.

References SCH_REFERENCE::GetSymbol(), m_symbolsList, FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::refreshDataStoreItem(), and FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::updateEditedState().

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom().

Member Data Documentation

◆ 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ClearCell(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RevertRow(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setCellValues(), and SYMBOL_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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getFieldResolvedLiveValue(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValue(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::storageIsSharedAcrossPaths().

◆ 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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::DeleteRows(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RemoveReferences(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RemoveSymbol().

◆ m_edited

bool FIELDS_TABLE_DATA_MODEL_BASE::m_edited
protectedinherited

Definition at line 322 of file fields_table_data_model.h.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ClearCell(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue().

◆ m_excludeDNP

bool FIELDS_TABLE_DATA_MODEL_BASE::m_excludeDNP
protectedinherited

Definition at line 328 of file fields_table_data_model.h.

Referenced by SYMBOL_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 SYMBOL_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_groupingEnabled

bool FIELDS_TABLE_DATA_MODEL_BASE::m_groupingEnabled
protectedinherited

Definition at line 327 of file fields_table_data_model.h.

Referenced by SYMBOL_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 SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ m_path

SCH_SHEET_PATH SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::m_path
protected

Definition at line 158 of file symbol_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 SYMBOL_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<SCH_REFERENCE> > FIELDS_TABLE_DATA_MODEL< SCH_REFERENCE >::m_rows
protectedinherited

Definition at line 1435 of file fields_table_data_model.h.

Referenced by SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ClearCell(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::DeleteRows(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RevertRow(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::setCellValues(), and SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue().

◆ m_scope

SCOPE SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::m_scope
protected

Definition at line 157 of file symbol_fields_data_model.h.

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

◆ 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 SYMBOL_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.

◆ m_stripedRenderer

wxGridCellRenderer* FIELDS_TABLE_DATA_MODEL_BASE::m_stripedRenderer
protectedinherited

Definition at line 319 of file fields_table_data_model.h.

◆ m_symbolsList

SCH_REFERENCE_LIST SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::m_symbolsList
protected

The flattened by hierarchy list of symbols.

Warning
This list must be kept sorted by symbol pointer. Otherwise, the undo/redo commit actions will be broken.

Definition at line 156 of file symbol_fields_data_model.h.

Referenced by AddReferences(), ApplyData(), ClearCell(), DeleteRows(), getAllItems(), GetReferenceList(), RebuildRows(), RemoveReferences(), RemoveSymbol(), RevertRow(), setCellValues(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL(), and UpdateReferences().

◆ 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 SYMBOL_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: