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
LIB_FIELDS_EDITOR_GRID_DATA_MODEL Class Reference

#include <lib_fields_data_model.h>

Inheritance diagram for LIB_FIELDS_EDITOR_GRID_DATA_MODEL:
FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * > FIELDS_TABLE_DATA_MODEL_BASE WX_GRID_TABLE_BASE

Public Types

enum  SCOPE : int { SCOPE_LIBRARY = 0 , SCOPE_RELATED_SYMBOLS }
 

Public Member Functions

 LIB_FIELDS_EDITOR_GRID_DATA_MODEL (const std::vector< LIB_SYMBOL * > &aSymbolsList)
 
void CreateDerivedSymbolImmediate (int aRow, int aCol, wxString &aNewSymbolName)
 
wxString GetTypeName (int row, int col) override
 
void SetValue (int aRow, int aCol, const wxString &aValue) override
 
wxGridCellAttr * GetAttr (int row, int col, wxGridCellAttr::wxAttrKind kind) override
 
bool ColIsItemIdentifier (int aCol) const override
 Reference for symbol/fields tables, lib_id for lib tables.
 
const LIB_SYMBOL * GetSymbolForRow (int aRow)
 
void GetSymbolNames (wxArrayString &aList, SYMBOL_NAME_FILTER aFilter)
 
void RebuildRows () override
 
void SetScope (SCOPE aScope)
 
SCOPE GetScope ()
 
void SetRelatedSymbolRoot (const wxString &aRootSymbolName)
 
void ApplyData (std::function< void(LIB_SYMBOL *)> symbolChangeHandler, std::function< void()> postApplyHandler=nullptr)
 
bool ValidateReferences (wxString &aSymbolName, wxString &aErrorMessage) const
 
std::vector< std::pair< LIB_SYMBOL *, wxString > > GetAndClearCreatedDerivedSymbols ()
 Get and clear the list of newly created derived symbols for library manager processing.
 
bool IsRowSingleSymbol (int aRow)
 
bool IsCellReadOnly (int aRow, int aCol) 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_PATH > GetRowItemKeys (int aRow) const override
 Return the stable data-store keys of every item represented by a row.
 
std::vector< LIB_SYMBOL * > GetRowReferences (int aRow) const
 
void RevertRow (int aRow) override
 Go through and revert all the fields in the row to their live values from the item (symbol/footprint/etc).
 
void ExpandRow (int aRow)
 
void CollapseRow (int aRow)
 
void ExpandCollapseRow (int aRow) override
 
void CollapseForSort ()
 
void ExpandAfterSort ()
 
wxString GetGroupedValue (const DATA_MODEL_ROW< LIB_SYMBOL * > &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 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 ColIsReadOnly (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 SYMBOL_NAME = wxS( "${SYMBOL_NAME}" )
 
static const wxString SYMBOL_KEYWORDS = wxS( "${SYMBOL_KEYWORDS}" )
 
static const wxString SYMBOL_IS_POWER = wxS( "${SYMBOL_IS_POWER}" )
 
static const wxString SYMBOL_IS_LOCAL_POWER = wxS( "${SYMBOL_IS_LOCAL_POWER}" )
 
static const wxString QUANTITY_VARIABLE
 
static const wxString ITEM_NUMBER_VARIABLE
 

Protected Member Functions

bool MatchesFilter (const LIB_SYMBOL *&aItem, const wxString &aReference, EDA_COMBINED_MATCHER &aMatcher)
 
virtual bool attributeForcedOnBySheet (const LIB_SYMBOL *&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< LIB_SYMBOL * > &aRow, int aCol)
 
bool cmpRows (const DATA_MODEL_ROW< LIB_SYMBOL * > &lhRow, const DATA_MODEL_ROW< LIB_SYMBOL * > &rhRow, int aSortCol, bool aAscending)
 
virtual bool cmpRowItems (const LIB_SYMBOL *&lhItem, const LIB_SYMBOL *&rhItem)
 
bool groupMatch (const LIB_SYMBOL *&lhItem, const LIB_SYMBOL *&rhItem)
 
void Sort ()
 
const std::map< wxString, wxString > & getStoredFields (const LIB_SYMBOL *&aItem) const
 Returns all stored fields for an item without creating a data-store entry.
 
bool getStoredFieldValue (const LIB_SYMBOL *&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 LIB_SYMBOL *&aItem, const wxString &aFieldName, const wxString &aValue)
 Creates or updates a field in the data store.
 
void ensureStoredFieldPresent (const LIB_SYMBOL *&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 LIB_SYMBOL *&aItem, const wxString &aFieldName)
 Clears a field, e.g.
 
bool fieldIsModified (const LIB_SYMBOL *&aItem, const wxString &aFieldName)
 Compares the live value of the field to the stored value in the data store.
 
void updateDataStoreItemFieldFromLive (const LIB_SYMBOL *&aItem, const wxString &aFieldName)
 Updates the data store with the current value of the field from the live item.
 
void initializeDataStoreItemField (const LIB_SYMBOL *&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 LIB_SYMBOL *&aItem)
 Initializes every column in the data store for a newly added (or refreshed) item.
 
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

std::vector< LIB_SYMBOL * > m_symbolsList
 
SCOPE m_scope
 
wxString m_relatedSymbolRoot
 
std::vector< std::pair< LIB_SYMBOL *, wxString > > m_createdDerivedSymbols
 
std::vector< DATA_MODEL_ROW< LIB_SYMBOL * > > 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_PATH > m_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_COL > m_cols
 
std::map< KIID_PATH, std::map< wxString, wxString > > m_dataStore
 
std::map< int, wxGridCellAttr * > m_colAttrs
 

Private Member Functions

bool unitMatch (LIB_SYMBOL *const &lhItem, LIB_SYMBOL *const &rhItem) override
 
bool fieldIsAttribute (const wxString &aFieldName) const override
 
bool fieldIsItemProperty (const wxString &aFieldName) const override
 
wxString getAttributeValue (const LIB_SYMBOL *, const wxString &aAttributeName)
 
void setAttributeValue (LIB_SYMBOL *aSymbol, const wxString &aAttributeName, const wxString &aValue)
 
wxString getAttributeResolvedValue (const wxString &aFieldName, bool aValue) const override
 
bool isPowerSymbolControlledField (const wxString &aFieldName) const
 
bool getStoredPowerSymbolValue (LIB_SYMBOL *aSymbol) const
 
void setPowerSymbolDefaults (LIB_SYMBOL *aSymbol)
 
wxString getFieldResolvedLiveValue (LIB_SYMBOL *const &aSymbol, 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 (LIB_SYMBOL *const &aSymbol, const wxString &aText) override
 
void createActualDerivedSymbol (const LIB_SYMBOL *aParentSymbol, const wxString &aNewSymbolName, const KIID &aNewSymbolUuid)
 
bool getLiveFieldValue (LIB_SYMBOL *const &aSymbol, const wxString &aFieldName, wxString &aValue) override
 Gets the current value of the field from the live item, e.g.
 
std::vector< LIB_SYMBOL * > getAllItems () const override
 
KIID_PATH getDataStoreKey (LIB_SYMBOL *const &aItem) const override
 
wxString getItemIdentifier (LIB_SYMBOL *const &aItem) const override
 

Detailed Description

Definition at line 35 of file lib_fields_data_model.h.

Member Enumeration Documentation

◆ SCOPE

enum LIB_FIELDS_EDITOR_GRID_DATA_MODEL::SCOPE : int
Enumerator
SCOPE_LIBRARY 
SCOPE_RELATED_SYMBOLS 

Definition at line 38 of file lib_fields_data_model.h.

Constructor & Destructor Documentation

◆ LIB_FIELDS_EDITOR_GRID_DATA_MODEL()

LIB_FIELDS_EDITOR_GRID_DATA_MODEL::LIB_FIELDS_EDITOR_GRID_DATA_MODEL ( const std::vector< LIB_SYMBOL * > & aSymbolsList)
inline

Definition at line 44 of file lib_fields_data_model.h.

References FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_includeExcluded, m_scope, m_symbolsList, and SCOPE_LIBRARY.

Member Function Documentation

◆ AddColumn()

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

◆ allRowItemsHaveAttributeForcedOnBySheet()

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

Definition at line 277 of file fields_table_data_model.cpp.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ ApplyData()

void LIB_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData ( std::function< void(LIB_SYMBOL *)> symbolChangeHandler,
std::function< void()> postApplyHandler = nullptr )

Definition at line 644 of file lib_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::ColIsAttribute(), getAttributeValue(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::GetFieldNameCol(), SCH_FIELD::GetId(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::getStoredFieldValue(), SCH_FIELD::GetText(), IsGeneratedField(), SCH_FIELD::IsMandatory(), SCH_ITEM::IsPrivate(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_cols, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_edited, DATA_MODEL_COL::m_fieldName, m_symbolsList, setAttributeValue(), SCH_FIELD::SetPosition(), SCH_FIELD::SetText(), SYMBOL_IS_LOCAL_POWER, SYMBOL_IS_POWER, SYMBOL_KEYWORDS, SYMBOL_NAME, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::updateDataStoreItemFieldFromLive(), USER, and VALUE.

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

◆ applyResolvedTextRenderer()

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

Definition at line 272 of file fields_table_data_model.cpp.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ attributeForcedOnBySheet()

virtual bool FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::attributeForcedOnBySheet ( const LIB_SYMBOL * & aItem,
const wxString & aAttributeName ) const
inlineprotectedvirtualinherited

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

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

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ cellUsesUrlEditor()

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

Definition at line 274 of file fields_table_data_model.cpp.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ Clear()

void WX_GRID_TABLE_BASE::Clear ( )
inlineoverrideinherited

Definition at line 97 of file wx_grid.h.

◆ ClearCell()

void FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::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< LIB_SYMBOL * >::clearStoredField ( const LIB_SYMBOL * & 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

Definition at line 275 of file fields_table_data_model.cpp.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ cmpRowItems()

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

Definition at line 878 of file fields_table_data_model.h.

◆ cmpRows()

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

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValue(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetTypeName().

◆ ColIsComputed()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsComputed ( int aCol) const
inherited

Definition at line 167 of file fields_table_data_model.cpp.

◆ ColIsFootprint()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsFootprint ( int aCol) const
inherited

Definition at line 158 of file fields_table_data_model.cpp.

◆ ColIsItemIdentifier()

bool LIB_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 129 of file lib_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_cols, and SYMBOL_NAME.

◆ ColIsItemNumber()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsItemNumber ( int aCol) const
inherited

Definition at line 156 of file fields_table_data_model.cpp.

◆ 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

Definition at line 155 of file fields_table_data_model.cpp.

◆ ColIsReadOnly()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsReadOnly ( int aCol) const
virtualinherited

Definition at line 175 of file fields_table_data_model.cpp.

◆ ColIsReference()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsReference ( int aCol) const
inherited

Definition at line 154 of file fields_table_data_model.cpp.

◆ ColIsValue()

bool FIELDS_TABLE_DATA_MODEL_BASE::ColIsValue ( int aCol) const
inherited

Definition at line 157 of file fields_table_data_model.cpp.

◆ CollapseForSort()

void FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::CollapseForSort ( )
inlineinherited

Definition at line 572 of file fields_table_data_model.h.

◆ CollapseRow()

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

◆ createActualDerivedSymbol()

void LIB_FIELDS_EDITOR_GRID_DATA_MODEL::createActualDerivedSymbol ( const LIB_SYMBOL * aParentSymbol,
const wxString & aNewSymbolName,
const KIID & aNewSymbolUuid )
private

Definition at line 356 of file lib_fields_data_model.cpp.

References LIB_SYMBOL::GetLibId(), LIB_ID::GetLibNickname(), LIB_SYMBOL::GetName(), LIB_SYMBOL::GetValueField(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::initializeDataStoreItem(), m_createdDerivedSymbols, m_symbolsList, EDA_ITEM::m_Uuid, LIB_SYMBOL::SetName(), LIB_SYMBOL::SetParent(), SCH_FIELD::SetText(), and traceLibFieldTable.

Referenced by CreateDerivedSymbolImmediate().

◆ CreateDerivedSymbolImmediate()

void LIB_FIELDS_EDITOR_GRID_DATA_MODEL::CreateDerivedSymbolImmediate ( int aRow,
int aCol,
wxString & aNewSymbolName )

Definition at line 333 of file lib_fields_data_model.cpp.

References createActualDerivedSymbol(), LIB_SYMBOL::GetName(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_cols, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_edited, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_rows, RebuildRows(), and traceLibFieldTable.

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

◆ ensureStoredFieldPresent()

void FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::ensureStoredFieldPresent ( const LIB_SYMBOL * & 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< LIB_SYMBOL * >::ExpandAfterSort ( )
inlineinherited

Definition at line 585 of file fields_table_data_model.h.

◆ ExpandCollapseRow()

void FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::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< LIB_SYMBOL * >::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 LIB_FIELDS_EDITOR_GRID_DATA_MODEL::fieldIsAttribute ( const wxString & aFieldName) const
overrideprivatevirtual

Reimplemented from FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 136 of file lib_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL_BASE::fieldIsAttribute(), SYMBOL_IS_LOCAL_POWER, and SYMBOL_IS_POWER.

◆ fieldIsItemProperty()

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

Reimplemented from FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 143 of file lib_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL_BASE::fieldIsItemProperty(), SYMBOL_KEYWORDS, and SYMBOL_NAME.

◆ fieldIsModified()

bool FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::fieldIsModified ( const LIB_SYMBOL * & 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_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ getAllItems()

std::vector< LIB_SYMBOL * > LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getAllItems ( ) const
overrideprivatevirtual

Implements FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >.

Definition at line 74 of file lib_fields_data_model.cpp.

References m_symbolsList.

◆ GetAndClearCreatedDerivedSymbols()

std::vector< std::pair< LIB_SYMBOL *, wxString > > LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAndClearCreatedDerivedSymbols ( )
inline

Get and clear the list of newly created derived symbols for library manager processing.

Definition at line 100 of file lib_fields_data_model.h.

References m_createdDerivedSymbols, and result.

◆ GetAttr()

wxGridCellAttr * LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr ( int row,
int col,
wxGridCellAttr::wxAttrKind kind )
override

Definition at line 179 of file lib_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::applyCellDecorations(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::applyResolvedTextRenderer(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::cellUsesResolvedTextRenderer(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::cellUsesUrlEditor(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::cloneUrlEditorAttr(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::ColIsAttribute(), FIELDS_TABLE_COLOR::EDITED_EMPTY_FIELD_BRIGHT_GREEN(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::fieldIsModified(), getLiveFieldValue(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::getStoredFieldValue(), IsCellReadOnly(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_colAttrs, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_cols, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_rows, FIELDS_TABLE_COLOR::STRIPED_CLEARED_EMPTY_FIELD_LIGHT_GREEN(), FIELDS_TABLE_COLOR::STRIPED_CLEARED_NONEMPTY_FIELD_LIGHT_RED(), FIELDS_TABLE_COLOR::STRIPED_EDITED_EMPTY_FIELD_MUTED_GREEN(), and FIELDS_TABLE_COLOR::STRIPED_EDITED_NONEMPTY_FIELD_MUTED_RED().

◆ getAttributeResolvedValue()

wxString LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeResolvedValue ( const wxString & aFieldName,
bool aValue ) const
overrideprivatevirtual

Reimplemented from FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 489 of file lib_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL_BASE::getAttributeResolvedValue(), SYMBOL_IS_LOCAL_POWER, and SYMBOL_IS_POWER.

◆ getAttributeValue()

wxString LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue ( const LIB_SYMBOL * aSymbol,
const wxString & aAttributeName )
private

Definition at line 402 of file lib_fields_data_model.cpp.

References SYMBOL::GetDNP(), SYMBOL::GetExcludedFromBoard(), SYMBOL::GetExcludedFromBOM(), SYMBOL::GetExcludedFromPosFiles(), SYMBOL::GetExcludedFromSim(), LIB_SYMBOL::IsLocalPower(), LIB_SYMBOL::IsPower(), SYMBOL_IS_LOCAL_POWER, and SYMBOL_IS_POWER.

Referenced by ApplyData(), and getLiveFieldValue().

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

◆ 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 LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getDataStoreKey ( LIB_SYMBOL *const & aItem) const
overrideprivatevirtual

Implements FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >.

Definition at line 854 of file lib_fields_data_model.cpp.

References EDA_ITEM::m_Uuid.

◆ 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< LIB_SYMBOL * >::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

Definition at line 144 of file fields_table_data_model.cpp.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValue(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getStoredPowerSymbolValue(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::setPowerSymbolDefaults().

◆ getFieldResolvedLiveValue()

wxString LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getFieldResolvedLiveValue ( LIB_SYMBOL *const & 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< LIB_SYMBOL * >.

Definition at line 593 of file lib_fields_data_model.cpp.

References LIB_SYMBOL::GetField(), SCH_FIELD::GetShownText(), INTERNAL, IsGeneratedField(), SCH_ITEM::IsPrivate(), LIB_SYMBOL::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< LIB_SYMBOL * >::GetGroupedValue ( const DATA_MODEL_ROW< LIB_SYMBOL * > & 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_FIELDS_EDITOR_GRID_DATA_MODEL::getItemIdentifier ( LIB_SYMBOL *const & aItem) const
overrideprivatevirtual

Implements FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >.

Definition at line 862 of file lib_fields_data_model.cpp.

References LIB_SYMBOL::GetName().

◆ getLiveFieldValue()

bool LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValue ( LIB_SYMBOL *const & 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< LIB_SYMBOL * >.

Definition at line 42 of file lib_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::ColIsAttribute(), getAttributeValue(), LIB_SYMBOL::GetField(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::GetFieldNameCol(), LIB_SYMBOL::GetKeyWords(), LIB_SYMBOL::GetName(), SYMBOL_KEYWORDS, and SYMBOL_NAME.

Referenced by GetAttr().

◆ 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< LIB_SYMBOL * >::GetNumberRows ( )
inlineoverrideinherited

Definition at line 445 of file fields_table_data_model.h.

◆ GetResolvedValue()

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

Definition at line 462 of file fields_table_data_model.h.

◆ GetRowState()

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

Reimplemented from WX_GRID_TABLE_BASE.

Definition at line 446 of file fields_table_data_model.h.

◆ GetScope()

SCOPE LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetScope ( )
inline

Definition at line 90 of file lib_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< LIB_SYMBOL * >::getStoredFields ( const LIB_SYMBOL * & 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.

◆ getStoredFieldValue()

bool FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::getStoredFieldValue ( const LIB_SYMBOL * & 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_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getStoredPowerSymbolValue(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::ValidateReferences().

◆ getStoredPowerSymbolValue()

bool LIB_FIELDS_EDITOR_GRID_DATA_MODEL::getStoredPowerSymbolValue ( LIB_SYMBOL * aSymbol) const
private

Definition at line 459 of file lib_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::GetFieldNameCol(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::getStoredFieldValue(), LIB_SYMBOL::IsPower(), and SYMBOL_IS_POWER.

Referenced by IsCellReadOnly(), and SetValue().

◆ GetSymbolForRow()

const LIB_SYMBOL * LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetSymbolForRow ( int aRow)
inline

Definition at line 65 of file lib_fields_data_model.h.

References FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_rows.

◆ GetSymbolNames()

void LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetSymbolNames ( wxArrayString & aList,
SYMBOL_NAME_FILTER aFilter )
inline

Definition at line 71 of file lib_fields_data_model.h.

References DERIVED_ONLY, m_symbolsList, ROOT_ONLY, and UnescapeString().

◆ GetTypeName()

wxString LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetTypeName ( int row,
int col )
override

Definition at line 845 of file lib_fields_data_model.cpp.

References FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::ColIsAttribute().

◆ GetValue()

wxString FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::GetValue ( int aRow,
int aCol )
inlineoverrideinherited

Definition at line 720 of file fields_table_data_model.h.

◆ 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< LIB_SYMBOL * >::groupMatch ( const LIB_SYMBOL * & lhItem,
const LIB_SYMBOL * & rhItem )
inlineprotectedinherited

Definition at line 885 of file fields_table_data_model.h.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ 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< LIB_SYMBOL * >::initializeDataStoreItem ( const LIB_SYMBOL * & 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 LIB_FIELDS_EDITOR_GRID_DATA_MODEL::createActualDerivedSymbol().

◆ initializeDataStoreItemField()

void FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::initializeDataStoreItemField ( const LIB_SYMBOL * & 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< LIB_SYMBOL * >::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< LIB_SYMBOL * >::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 LIB_FIELDS_EDITOR_GRID_DATA_MODEL::IsCellReadOnly ( int aRow,
int aCol )
overridevirtual

Reimplemented from FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >.

Definition at line 150 of file lib_fields_data_model.cpp.

References getStoredPowerSymbolValue(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::IsCellReadOnly(), isPowerSymbolControlledField(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_cols, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_rows, and SYMBOL_IS_LOCAL_POWER.

Referenced by GetAttr(), and SetValue().

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

◆ isPowerSymbolControlledField()

bool LIB_FIELDS_EDITOR_GRID_DATA_MODEL::isPowerSymbolControlledField ( const wxString & aFieldName) const
private

Definition at line 449 of file lib_fields_data_model.cpp.

References GetDefaultFieldName(), UNTRANSLATED, and VALUE.

Referenced by IsCellReadOnly(), and SetValue().

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

◆ IsRowSingleSymbol()

bool LIB_FIELDS_EDITOR_GRID_DATA_MODEL::IsRowSingleSymbol ( int aRow)
inline

Definition at line 107 of file lib_fields_data_model.h.

References FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_rows.

◆ MatchesFilter()

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

Definition at line 747 of file fields_table_data_model.h.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

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

void LIB_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows ( )
overridevirtual

Implements FIELDS_TABLE_DATA_MODEL_BASE.

Definition at line 503 of file lib_fields_data_model.cpp.

References CTX_SEARCH, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::groupMatch(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_excludeDNP, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_filter, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_groupingEnabled, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_includeExcluded, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_rebuildsEnabled, m_relatedSymbolRoot, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_rows, m_scope, m_symbolsList, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::MatchesFilter(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::Sort(), and traceLibFieldTable.

Referenced by CreateDerivedSymbolImmediate().

◆ RemoveColumn()

void FIELDS_TABLE_DATA_MODEL_BASE::RemoveColumn ( int aCol)
inherited

Definition at line 135 of file fields_table_data_model.cpp.

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

◆ resolveTextVars()

wxString LIB_FIELDS_EDITOR_GRID_DATA_MODEL::resolveTextVars ( LIB_SYMBOL *const & aSymbol,
const wxString & aText )
overrideprivatevirtual

Implements FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >.

Definition at line 625 of file lib_fields_data_model.cpp.

References LIB_SYMBOL::ResolveTextVar(), and ResolveTextVars().

◆ RestoreUndoState()

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

Definition at line 253 of file fields_table_data_model.cpp.

◆ RevertRow()

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

◆ setAttributeValue()

void LIB_FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue ( LIB_SYMBOL * aSymbol,
const wxString & aAttributeName,
const wxString & aValue )
private

Definition at line 430 of file lib_fields_data_model.cpp.

References SYMBOL::SetDNP(), SYMBOL::SetExcludedFromBoard(), SYMBOL::SetExcludedFromBOM(), SYMBOL::SetExcludedFromPosFiles(), and SYMBOL::SetExcludedFromSim().

Referenced by ApplyData().

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

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

◆ setPowerSymbolDefaults()

void LIB_FIELDS_EDITOR_GRID_DATA_MODEL::setPowerSymbolDefaults ( LIB_SYMBOL * aSymbol)
private

Definition at line 470 of file lib_fields_data_model.cpp.

References GetDefaultFieldName(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::GetFieldNameCol(), LIB_SYMBOL::GetName(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::setStoredFieldValue(), UNTRANSLATED, and VALUE.

Referenced by SetValue().

◆ SetRelatedSymbolRoot()

void LIB_FIELDS_EDITOR_GRID_DATA_MODEL::SetRelatedSymbolRoot ( const wxString & aRootSymbolName)
inline

Definition at line 92 of file lib_fields_data_model.h.

References m_relatedSymbolRoot.

◆ SetScope()

void LIB_FIELDS_EDITOR_GRID_DATA_MODEL::SetScope ( SCOPE aScope)
inline

Definition at line 89 of file lib_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.

◆ setStoredFieldValue()

void FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::setStoredFieldValue ( const LIB_SYMBOL * & 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 LIB_FIELDS_EDITOR_GRID_DATA_MODEL::setPowerSymbolDefaults(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue().

◆ SetValue()

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

Definition at line 80 of file lib_fields_data_model.cpp.

References GetDefaultFieldName(), LIB_SYMBOL::GetName(), getStoredPowerSymbolValue(), INDETERMINATE_STATE, IsCellReadOnly(), isPowerSymbolControlledField(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_cols, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_edited, DATA_MODEL_ROW< ITEM_TYPE >::m_items, FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_rows, setPowerSymbolDefaults(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::setStoredFieldValue(), SYMBOL_IS_LOCAL_POWER, SYMBOL_IS_POWER, UNTRANSLATED, and VALUE.

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

Definition at line 957 of file fields_table_data_model.h.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ unitMatch()

bool LIB_FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch ( LIB_SYMBOL *const & lhItem,
LIB_SYMBOL *const & rhItem )
overrideprivatevirtual

Implements FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >.

Definition at line 587 of file lib_fields_data_model.cpp.

◆ updateDataStoreItemFieldFromLive()

void FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::updateDataStoreItemFieldFromLive ( const LIB_SYMBOL * & 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_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData().

◆ ValidateReferences()

bool LIB_FIELDS_EDITOR_GRID_DATA_MODEL::ValidateReferences ( wxString & aSymbolName,
wxString & aErrorMessage ) const

Definition at line 819 of file lib_fields_data_model.cpp.

References GetDefaultFieldName(), GetFieldValidationErrorMessage(), FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::getStoredFieldValue(), m_symbolsList, REFERENCE, UnescapeString(), and UNTRANSLATED.

Member Data Documentation

◆ 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

Definition at line 108 of file wx_grid.h.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr().

◆ m_cols

std::vector<DATA_MODEL_COL> FIELDS_TABLE_DATA_MODEL_BASE::m_cols
protectedinherited

Definition at line 304 of file fields_table_data_model.h.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::ColIsItemIdentifier(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::CreateDerivedSymbolImmediate(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::IsCellReadOnly(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue().

◆ m_createdDerivedSymbols

std::vector<std::pair<LIB_SYMBOL*, wxString> > LIB_FIELDS_EDITOR_GRID_DATA_MODEL::m_createdDerivedSymbols
protected

Definition at line 148 of file lib_fields_data_model.h.

Referenced by createActualDerivedSymbol(), and GetAndClearCreatedDerivedSymbols().

◆ m_currentVariant

wxString FIELDS_TABLE_DATA_MODEL_BASE::m_currentVariant
protectedinherited

Current variant name for highlighting.

Definition at line 300 of file fields_table_data_model.h.

◆ m_dataStore

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

Definition at line 328 of file fields_table_data_model.h.

◆ m_edited

bool FIELDS_TABLE_DATA_MODEL_BASE::m_edited
protectedinherited

Definition at line 287 of file fields_table_data_model.h.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::CreateDerivedSymbolImmediate(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue().

◆ m_excludeDNP

bool FIELDS_TABLE_DATA_MODEL_BASE::m_excludeDNP
protectedinherited

Definition at line 293 of file fields_table_data_model.h.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ m_filter

wxString FIELDS_TABLE_DATA_MODEL_BASE::m_filter
protectedinherited

Definition at line 290 of file fields_table_data_model.h.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

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

bool FIELDS_TABLE_DATA_MODEL_BASE::m_groupingEnabled
protectedinherited

Definition at line 292 of file fields_table_data_model.h.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ m_includeExcluded

bool FIELDS_TABLE_DATA_MODEL_BASE::m_includeExcluded
protectedinherited

Definition at line 294 of file fields_table_data_model.h.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::LIB_FIELDS_EDITOR_GRID_DATA_MODEL(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ 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 LIB_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows().

◆ m_relatedSymbolRoot

wxString LIB_FIELDS_EDITOR_GRID_DATA_MODEL::m_relatedSymbolRoot
protected

Definition at line 145 of file lib_fields_data_model.h.

Referenced by RebuildRows(), and SetRelatedSymbolRoot().

◆ m_resolvedTextRenderer

wxGridCellRenderer* FIELDS_TABLE_DATA_MODEL_BASE::m_resolvedTextRenderer
protectedinherited

Definition at line 285 of file fields_table_data_model.h.

◆ m_rows

std::vector<DATA_MODEL_ROW<LIB_SYMBOL *> > FIELDS_TABLE_DATA_MODEL< LIB_SYMBOL * >::m_rows
protectedinherited

Definition at line 1139 of file fields_table_data_model.h.

Referenced by LIB_FIELDS_EDITOR_GRID_DATA_MODEL::CreateDerivedSymbolImmediate(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetAttr(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetSymbolForRow(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::IsCellReadOnly(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::IsRowSingleSymbol(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), and LIB_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue().

◆ m_scope

SCOPE LIB_FIELDS_EDITOR_GRID_DATA_MODEL::m_scope
protected

Definition at line 144 of file lib_fields_data_model.h.

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

◆ m_selectionItems

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

Definition at line 298 of file fields_table_data_model.h.

◆ 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

Definition at line 288 of file fields_table_data_model.h.

◆ m_stripedRenderer

wxGridCellRenderer* FIELDS_TABLE_DATA_MODEL_BASE::m_stripedRenderer
protectedinherited

Definition at line 284 of file fields_table_data_model.h.

◆ m_symbolsList

std::vector<LIB_SYMBOL*> LIB_FIELDS_EDITOR_GRID_DATA_MODEL::m_symbolsList
protected

Definition at line 143 of file lib_fields_data_model.h.

Referenced by ApplyData(), createActualDerivedSymbol(), getAllItems(), GetSymbolNames(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL(), RebuildRows(), and ValidateReferences().

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

◆ QUANTITY_VARIABLE

const wxString FIELDS_TABLE_DATA_MODEL_BASE::QUANTITY_VARIABLE
staticinherited

Definition at line 127 of file fields_table_data_model.h.

◆ SYMBOL_IS_LOCAL_POWER

const wxString LIB_FIELDS_EDITOR_GRID_DATA_MODEL::SYMBOL_IS_LOCAL_POWER = wxS( "${SYMBOL_IS_LOCAL_POWER}" )
static

Definition at line 54 of file lib_fields_data_model.h.

Referenced by ApplyData(), fieldIsAttribute(), getAttributeResolvedValue(), getAttributeValue(), DIALOG_LIB_FIELDS_TABLE::getBuiltInBomPresets(), IsCellReadOnly(), DIALOG_LIB_FIELDS_TABLE::LoadFieldNames(), and SetValue().

◆ SYMBOL_IS_POWER

const wxString LIB_FIELDS_EDITOR_GRID_DATA_MODEL::SYMBOL_IS_POWER = wxS( "${SYMBOL_IS_POWER}" )
static

Definition at line 53 of file lib_fields_data_model.h.

Referenced by ApplyData(), fieldIsAttribute(), getAttributeResolvedValue(), getAttributeValue(), DIALOG_LIB_FIELDS_TABLE::getBuiltInBomPresets(), getStoredPowerSymbolValue(), DIALOG_LIB_FIELDS_TABLE::LoadFieldNames(), and SetValue().

◆ SYMBOL_KEYWORDS

const wxString LIB_FIELDS_EDITOR_GRID_DATA_MODEL::SYMBOL_KEYWORDS = wxS( "${SYMBOL_KEYWORDS}" )
static

Definition at line 52 of file lib_fields_data_model.h.

Referenced by ApplyData(), fieldIsItemProperty(), DIALOG_LIB_FIELDS_TABLE::getBuiltInBomPresets(), getLiveFieldValue(), and DIALOG_LIB_FIELDS_TABLE::LoadFieldNames().

◆ SYMBOL_NAME

const wxString LIB_FIELDS_EDITOR_GRID_DATA_MODEL::SYMBOL_NAME = wxS( "${SYMBOL_NAME}" )
static

Definition at line 51 of file lib_fields_data_model.h.

Referenced by ApplyData(), ColIsItemIdentifier(), fieldIsItemProperty(), DIALOG_LIB_FIELDS_TABLE::getBuiltInBomPresets(), getLiveFieldValue(), and DIALOG_LIB_FIELDS_TABLE::LoadFieldNames().

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