FIELDS_EDITOR_GRID_DATA_MODEL Class Reference

#include <fields_data_model.h>

Inheritance diagram for FIELDS_EDITOR_GRID_DATA_MODEL:

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

Public Member Functions
	FIELDS_EDITOR_GRID_DATA_MODEL (SCH_REFERENCE_LIST &aSymbolsList)
void	AddColumn (const wxString &aFieldName, const wxString &aLabel, bool aAddedByUser)
void	RemoveColumn (int aCol)
void	RenameColumn (int aCol, const wxString &newName)
void	MoveColumn (int aCol, int aNewPos)
int	GetNumberRows () override
int	GetNumberCols () override
void	SetColLabelValue (int aCol, const wxString &aLabel) override
wxString	GetColLabelValue (int aCol) override
wxString	GetColFieldName (int aCol)
int	GetFieldNameCol (wxString aFieldName)
const std::vector< BOM_FIELD >	GetFieldsOrdered ()
void	SetFieldsOrder (const std::vector< wxString > &aNewOrder)
bool	IsEmptyCell (int aRow, int aCol) override
wxString	GetValue (int aRow, int aCol) override
wxString	GetValue (const DATA_MODEL_ROW &group, int aCol, const wxString &refDelimiter=wxT(", "), const wxString &refRangDelimiter=wxT("-"), bool resolveVars=false)
wxString	GetExportValue (int aRow, int aCol, const wxString &refDelimiter, const wxString &refRangeDelimiter)
void	SetValue (int aRow, int aCol, const wxString &aValue) override
GROUP_TYPE	GetRowFlags (int aRow)
std::vector< SCH_REFERENCE >	GetRowReferences (int aRow) const
bool	ColIsReference (int aCol)
bool	ColIsValue (int aCol)
bool	ColIsQuantity (int aCol)
bool	ColIsItemNumber (int aCol)
bool	ColIsAttribute (int aCol)
void	SetSorting (int aCol, bool ascending)
int	GetSortCol ()
bool	GetSortAsc ()
void	EnableRebuilds ()
void	DisableRebuilds ()
void	RebuildRows ()
void	ExpandRow (int aRow)
void	CollapseRow (int aRow)
void	ExpandCollapseRow (int aRow)
void	CollapseForSort ()
void	ExpandAfterSort ()
void	ApplyData (std::function< void(SCH_SYMBOL &, SCH_SHEET_PATH &)> symbolChangeHandler)
bool	IsEdited ()
int	GetDataWidth (int aCol)
void	SetFilter (const wxString &aFilter)
const wxString &	GetFilter ()
void	SetScope (SCOPE aScope)
SCOPE	GetScope ()
void	SetPath (const SCH_SHEET_PATH &aPath)
const SCH_SHEET_PATH &	GetPath ()
void	SetGroupingEnabled (bool group)
bool	GetGroupingEnabled ()
void	SetIncludeExcludedFromBOM (bool include)
bool	GetIncludeExcludedFromBOM ()
void	SetExcludeDNP (bool exclude)
bool	GetExcludeDNP ()
void	SetGroupColumn (int aCol, bool group)
bool	GetGroupColumn (int aCol)
void	SetShowColumn (int aCol, bool show)
bool	GetShowColumn (int aCol)
void	ApplyBomPreset (const BOM_PRESET &preset)
BOM_PRESET	GetBomSettings ()
wxString	Export (const BOM_FMT_PRESET &settings)
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)

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

Protected Attributes
SCH_REFERENCE_LIST	m_symbolsList
bool	m_edited
int	m_sortColumn
bool	m_sortAscending
wxString	m_filter
enum SCOPE	m_scope
SCH_SHEET_PATH	m_path
bool	m_groupingEnabled
bool	m_excludeDNP
bool	m_includeExcluded
bool	m_rebuildsEnabled
std::vector< DATA_MODEL_COL >	m_cols
std::vector< DATA_MODEL_ROW >	m_rows
std::map< KIID, std::map< wxString, wxString > >	m_dataStore

Private Member Functions
bool	unitMatch (const SCH_REFERENCE &lhRef, const SCH_REFERENCE &rhRef)
bool	groupMatch (const SCH_REFERENCE &lhRef, const SCH_REFERENCE &rhRef)
bool	isAttribute (const wxString &aFieldName)
wxString	getAttributeValue (const SCH_SYMBOL &, const wxString &aAttributeName)
void	setAttributeValue (SCH_SYMBOL &aSymbol, const wxString &aAttributeName, const wxString &aValue)
wxString	getFieldShownText (const SCH_REFERENCE &aRef, const wxString &aFieldName)
void	Sort ()
SCH_REFERENCE_LIST	getSymbolReferences (SCH_SYMBOL *aSymbol)
void	storeReferenceFields (SCH_REFERENCE &aRef)
void	updateDataStoreSymbolField (const SCH_SYMBOL &aSymbol, const wxString &aFieldName)

Static Private Member Functions
static bool	cmp (const DATA_MODEL_ROW &lhGroup, const DATA_MODEL_ROW &rhGroup, FIELDS_EDITOR_GRID_DATA_MODEL *dataModel, int sortCol, bool ascending)

Detailed Description

Definition at line 73 of file fields_data_model.h.

Member Enumeration Documentation

SCOPE

enum FIELDS_EDITOR_GRID_DATA_MODEL::SCOPE : int

Enumerator
SCOPE_ALL
SCOPE_SHEET
SCOPE_SHEET_RECURSIVE

Definition at line 76 of file fields_data_model.h.

Constructor & Destructor Documentation

FIELDS_EDITOR_GRID_DATA_MODEL()

FIELDS_EDITOR_GRID_DATA_MODEL::FIELDS_EDITOR_GRID_DATA_MODEL ( SCH_REFERENCE_LIST &  aSymbolsList )

inline

Definition at line 83 of file fields_data_model.h.

References m_symbolsList, and SCH_REFERENCE_LIST::SplitReferences().

Member Function Documentation

AddColumn()

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

Definition at line 36 of file fields_data_model.cpp.

References SCH_REFERENCE_LIST::GetCount(), GetFieldNameCol(), m_cols, m_symbolsList, and updateDataStoreSymbolField().

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::AddField(), ApplyBomPreset(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

AddReferences()

void FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences

(

const SCH_REFERENCE_LIST &

aRefs

)

Definition at line 960 of file fields_data_model.cpp.

References SCH_REFERENCE_LIST::AddItem(), SCH_REFERENCE_LIST::Contains(), m_dataStore, and m_symbolsList.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsAdded().

ApplyBomPreset()

void FIELDS_EDITOR_GRID_DATA_MODEL::ApplyBomPreset

(

const BOM_PRESET &

preset

)

Definition at line 814 of file fields_data_model.cpp.

References AddColumn(), BOM_PRESET::excludeDNP, BOM_PRESET::fieldsOrdered, BOM_PRESET::filterString, GetCanonicalFieldName(), GetFieldNameCol(), BOM_FIELD::groupBy, BOM_PRESET::groupSymbols, BOM_PRESET::includeExcludedFromBOM, BOM_FIELD::label, m_cols, BOM_FIELD::name, RebuildRows(), REFERENCE_FIELD, SetColLabelValue(), SetExcludeDNP(), SetFieldsOrder(), SetFilter(), SetGroupColumn(), SetGroupingEnabled(), SetIncludeExcludedFromBOM(), SetShowColumn(), SetSorting(), BOM_FIELD::show, BOM_PRESET::sortAsc, and BOM_PRESET::sortField.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset(), and EESCHEMA_JOBS_HANDLER::JobExportBom().

ApplyData()

void FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData

(

std::function< void(SCH_SYMBOL &, SCH_SHEET_PATH &)>

symbolChangeHandler

)

Definition at line 713 of file fields_data_model.cpp.

References SCH_SYMBOL::AddField(), SCH_SYMBOL::FindField(), FOOTPRINT_FIELD, SCH_REFERENCE_LIST::GetCount(), GetFieldNameCol(), SCH_SYMBOL::GetFields(), SCH_FIELD::GetId(), SCH_SYMBOL::GetPosition(), isAttribute(), IsTextVar(), m_cols, m_dataStore, m_edited, m_symbolsList, EDA_ITEM::m_Uuid, MANDATORY_FIELDS, REFERENCE_FIELD, setAttributeValue(), SCH_SYMBOL::SetFootprintFieldText(), SCH_FIELD::SetText(), SCH_SYMBOL::SetValueFieldText(), and VALUE_FIELD.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::TransferDataFromWindow().

cmp()

bool FIELDS_EDITOR_GRID_DATA_MODEL::cmp ( const DATA_MODEL_ROW &  lhGroup, const DATA_MODEL_ROW &  rhGroup, FIELDS_EDITOR_GRID_DATA_MODEL *  dataModel, int  sortCol, bool  ascending  )

staticprivate

Definition at line 299 of file fields_data_model.cpp.

References GetValue(), DATA_MODEL_ROW::m_Refs, REFERENCE_FIELD, StrNumCmp(), and ValueStringCompare().

ColIsAttribute()

bool FIELDS_EDITOR_GRID_DATA_MODEL::ColIsAttribute

(

int

aCol

)

Definition at line 292 of file fields_data_model.cpp.

References isAttribute(), and m_cols.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties(), and SetValue().

ColIsItemNumber()

bool FIELDS_EDITOR_GRID_DATA_MODEL::ColIsItemNumber

(

int

aCol

)

Definition at line 285 of file fields_data_model.cpp.

References ITEM_NUMBER_VARIABLE, and m_cols.

Referenced by GetValue(), DIALOG_SYMBOL_FIELDS_TABLE::OnColSort(), DIALOG_SYMBOL_FIELDS_TABLE::OnColumnItemToggled(), and DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties().

ColIsQuantity()

bool FIELDS_EDITOR_GRID_DATA_MODEL::ColIsQuantity

(

int

aCol

)

Definition at line 278 of file fields_data_model.cpp.

References m_cols, and QUANTITY_VARIABLE.

Referenced by GetValue(), DIALOG_SYMBOL_FIELDS_TABLE::OnColumnItemToggled(), and DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties().

ColIsReference()

bool FIELDS_EDITOR_GRID_DATA_MODEL::ColIsReference

(

int

aCol

)

Definition at line 264 of file fields_data_model.cpp.

References GetCanonicalFieldName(), m_cols, and REFERENCE_FIELD.

Referenced by GetDataWidth(), GetValue(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableCellClick(), DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties(), SetValue(), and DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow().

ColIsValue()

bool FIELDS_EDITOR_GRID_DATA_MODEL::ColIsValue

(

int

aCol

)

Definition at line 271 of file fields_data_model.cpp.

References GetCanonicalFieldName(), m_cols, and VALUE_FIELD.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow().

CollapseForSort()

void FIELDS_EDITOR_GRID_DATA_MODEL::CollapseForSort

(

)

Definition at line 690 of file fields_data_model.cpp.

References CollapseRow(), GROUP_COLLAPSED_DURING_SORT, GROUP_EXPANDED, and m_rows.

Referenced by Sort().

CollapseRow()

void FIELDS_EDITOR_GRID_DATA_MODEL::CollapseRow

(

int

aRow

)

Definition at line 659 of file fields_data_model.cpp.

References CHILD_ITEM, GROUP_COLLAPSED, and m_rows.

Referenced by CollapseForSort(), and ExpandCollapseRow().

DisableRebuilds()

void FIELDS_EDITOR_GRID_DATA_MODEL::DisableRebuilds

(

)

Definition at line 528 of file fields_data_model.cpp.

References m_rebuildsEnabled.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset().

EnableRebuilds()

void FIELDS_EDITOR_GRID_DATA_MODEL::EnableRebuilds

(

)

Definition at line 522 of file fields_data_model.cpp.

References m_rebuildsEnabled.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset().

ExpandAfterSort()

void FIELDS_EDITOR_GRID_DATA_MODEL::ExpandAfterSort

(

)

Definition at line 703 of file fields_data_model.cpp.

References ExpandRow(), GROUP_COLLAPSED_DURING_SORT, and m_rows.

Referenced by Sort().

ExpandCollapseRow()

void FIELDS_EDITOR_GRID_DATA_MODEL::ExpandCollapseRow

(

int

aRow

)

Definition at line 679 of file fields_data_model.cpp.

References CollapseRow(), ExpandRow(), group, GROUP_COLLAPSED, GROUP_EXPANDED, and m_rows.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnTableCellClick().

ExpandRow()

void FIELDS_EDITOR_GRID_DATA_MODEL::ExpandRow

(

int

aRow

)

Definition at line 617 of file fields_data_model.cpp.

References CHILD_ITEM, GROUP_EXPANDED, m_rows, and unitMatch().

Referenced by ExpandAfterSort(), and ExpandCollapseRow().

Export()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::Export

(

const BOM_FMT_PRESET &

settings

)

Definition at line 887 of file fields_data_model.cpp.

References CHILD_ITEM, BOM_FMT_PRESET::fieldDelimiter, GetExportValue(), GetRowFlags(), BOM_FMT_PRESET::keepLineBreaks, BOM_FMT_PRESET::keepTabs, m_cols, m_rows, BOM_FMT_PRESET::refDelimiter, BOM_FMT_PRESET::refRangeDelimiter, and BOM_FMT_PRESET::stringDelimiter.

Referenced by EESCHEMA_JOBS_HANDLER::JobExportBom(), and DIALOG_SYMBOL_FIELDS_TABLE::PreviewRefresh().

getAttributeValue()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::getAttributeValue ( const SCH_SYMBOL &  aSymbol, const wxString &  aAttributeName  )

private

Definition at line 489 of file fields_data_model.cpp.

References SYMBOL::GetDNP(), SYMBOL::GetExcludedFromBoard(), SYMBOL::GetExcludedFromBOM(), and SYMBOL::GetExcludedFromSim().

Referenced by updateDataStoreSymbolField().

GetBomSettings()

BOM_PRESET FIELDS_EDITOR_GRID_DATA_MODEL::GetBomSettings

(

)

Definition at line 871 of file fields_data_model.cpp.

References BOM_PRESET::excludeDNP, BOM_PRESET::fieldsOrdered, BOM_PRESET::filterString, GetColFieldName(), GetExcludeDNP(), GetFieldsOrdered(), GetFilter(), GetGroupingEnabled(), GetIncludeExcludedFromBOM(), GetSortAsc(), GetSortCol(), BOM_PRESET::groupSymbols, BOM_PRESET::includeExcludedFromBOM, BOM_PRESET::readOnly, BOM_PRESET::sortAsc, and BOM_PRESET::sortField.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::onBomPresetChanged(), DIALOG_SYMBOL_FIELDS_TABLE::savePresetsToSchematic(), and DIALOG_SYMBOL_FIELDS_TABLE::syncBomPresetSelection().

GetColFieldName()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::GetColFieldName ( int  aCol )

inline

Definition at line 128 of file fields_data_model.h.

References m_cols.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), GetBomSettings(), GetDataWidth(), DIALOG_SYMBOL_FIELDS_TABLE::OnAddField(), DIALOG_SYMBOL_FIELDS_TABLE::OnClose(), DIALOG_SYMBOL_FIELDS_TABLE::OnColMove(), DIALOG_SYMBOL_FIELDS_TABLE::OnColSort(), DIALOG_SYMBOL_FIELDS_TABLE::OnRemoveField(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableColSize(), DIALOG_SYMBOL_FIELDS_TABLE::SetupAllColumnProperties(), and DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties().

GetColLabelValue()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::GetColLabelValue ( int  aCol )

inlineoverride

Definition at line 122 of file fields_data_model.h.

References m_cols.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset().

GetDataWidth()

int FIELDS_EDITOR_GRID_DATA_MODEL::GetDataWidth

(

int

aCol

)

Definition at line 788 of file fields_data_model.cpp.

References ColIsReference(), GetColFieldName(), SCH_REFERENCE_LIST::GetCount(), GetNumberRows(), KIUI::GetTextSize(), GetValue(), m_dataStore, m_symbolsList, and text.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::SetupAllColumnProperties().

GetExcludeDNP()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetExcludeDNP ( )

inline

Definition at line 220 of file fields_data_model.h.

References m_excludeDNP.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset(), and GetBomSettings().

GetExportValue()

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

inline

Definition at line 150 of file fields_data_model.h.

References GetValue(), and m_rows.

Referenced by Export().

GetFieldNameCol()

int FIELDS_EDITOR_GRID_DATA_MODEL::GetFieldNameCol

(

wxString

aFieldName

)

Definition at line 100 of file fields_data_model.cpp.

References m_cols.

Referenced by AddColumn(), ApplyBomPreset(), ApplyData(), DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset(), groupMatch(), DIALOG_SYMBOL_FIELDS_TABLE::OnColLabelChange(), DIALOG_SYMBOL_FIELDS_TABLE::OnColumnItemToggled(), DIALOG_SYMBOL_FIELDS_TABLE::OnRenameField(), and DIALOG_SYMBOL_FIELDS_TABLE::SetupAllColumnProperties().

getFieldShownText()

wxString FIELDS_EDITOR_GRID_DATA_MODEL::getFieldShownText ( const SCH_REFERENCE &  aRef, const wxString &  aFieldName  )

private

Definition at line 452 of file fields_data_model.cpp.

References ExpandTextVars(), SCH_SYMBOL::GetFieldByName(), SCH_REFERENCE::GetSheetPath(), SCH_FIELD::GetShownText(), SCH_REFERENCE::GetSymbol(), IsTextVar(), path, and SCH_SYMBOL::ResolveTextVar().

Referenced by GetValue(), and groupMatch().

GetFieldsOrdered()

const std::vector< BOM_FIELD > FIELDS_EDITOR_GRID_DATA_MODEL::GetFieldsOrdered

(

)

Definition at line 112 of file fields_data_model.cpp.

References m_cols.

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

GetFilter()

const wxString & FIELDS_EDITOR_GRID_DATA_MODEL::GetFilter ( )

inline

Definition at line 201 of file fields_data_model.h.

References m_filter.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset(), and GetBomSettings().

GetGroupColumn()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetGroupColumn ( int  aCol )

inline

Definition at line 228 of file fields_data_model.h.

References m_cols.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset().

GetGroupingEnabled()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetGroupingEnabled ( )

inline

Definition at line 210 of file fields_data_model.h.

References m_groupingEnabled.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset(), and GetBomSettings().

GetIncludeExcludedFromBOM()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetIncludeExcludedFromBOM ( )

inline

Definition at line 217 of file fields_data_model.h.

References m_includeExcluded.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset(), and GetBomSettings().

GetNumberCols()

int FIELDS_EDITOR_GRID_DATA_MODEL::GetNumberCols ( )

inlineoverride

Definition at line 113 of file fields_data_model.h.

References m_cols.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnAddField(), DIALOG_SYMBOL_FIELDS_TABLE::OnRemoveField(), and DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow().

GetNumberRows()

int FIELDS_EDITOR_GRID_DATA_MODEL::GetNumberRows ( )

inlineoverride

Definition at line 112 of file fields_data_model.h.

References m_rows.

Referenced by GetDataWidth(), and DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow().

GetPath()

const SCH_SHEET_PATH & FIELDS_EDITOR_GRID_DATA_MODEL::GetPath ( )

inline

Definition at line 207 of file fields_data_model.h.

References m_path.

GetRowFlags()

GROUP_TYPE FIELDS_EDITOR_GRID_DATA_MODEL::GetRowFlags ( int  aRow )

inline

Definition at line 158 of file fields_data_model.h.

References m_rows.

Referenced by Export().

GetRowReferences()

std::vector< SCH_REFERENCE > FIELDS_EDITOR_GRID_DATA_MODEL::GetRowReferences ( int  aRow ) const

inline

Definition at line 160 of file fields_data_model.h.

References m_rows.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected(), and DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow().

GetScope()

SCOPE FIELDS_EDITOR_GRID_DATA_MODEL::GetScope ( )

inline

Definition at line 204 of file fields_data_model.h.

References m_scope.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnSchSheetChanged().

GetShowColumn()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetShowColumn ( int  aCol )

inline

Definition at line 240 of file fields_data_model.h.

References m_cols.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), and DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow().

GetSortAsc()

bool FIELDS_EDITOR_GRID_DATA_MODEL::GetSortAsc ( )

inline

Definition at line 180 of file fields_data_model.h.

References m_sortAscending.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset(), GetBomSettings(), and DIALOG_SYMBOL_FIELDS_TABLE::SetupAllColumnProperties().

GetSortCol()

int FIELDS_EDITOR_GRID_DATA_MODEL::GetSortCol ( )

inline

Definition at line 179 of file fields_data_model.h.

References m_sortColumn.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset(), GetBomSettings(), and DIALOG_SYMBOL_FIELDS_TABLE::SetupAllColumnProperties().

getSymbolReferences()

SCH_REFERENCE_LIST FIELDS_EDITOR_GRID_DATA_MODEL::getSymbolReferences ( SCH_SYMBOL *  aSymbol )

private

GetValue() [1/2]

wxString FIELDS_EDITOR_GRID_DATA_MODEL::GetValue	(	const DATA_MODEL_ROW &	group,
		int	aCol,
		const wxString &	refDelimiter = wxT( ", " ),
		const wxString &	refRangDelimiter = wxT( "-" ),
		bool	resolveVars = false
	)

Definition at line 162 of file fields_data_model.cpp.

References CHILD_ITEM, ColIsItemNumber(), ColIsQuantity(), ColIsReference(), getFieldShownText(), SCH_REFERENCE::GetSymbol(), group, INDETERMINATE_STATE, IsTextVar(), m_cols, m_dataStore, EDA_ITEM::m_Uuid, and SCH_REFERENCE_LIST::Shorthand().

GetValue() [2/2]

wxString FIELDS_EDITOR_GRID_DATA_MODEL::GetValue ( int  aRow, int  aCol  )

override

Definition at line 141 of file fields_data_model.cpp.

References CHILD_ITEM, ColIsReference(), GetValue(), GROUP_COLLAPSED, GROUP_EXPANDED, and m_rows.

Referenced by cmp(), GetDataWidth(), GetExportValue(), and GetValue().

groupMatch()

bool FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch ( const SCH_REFERENCE &  lhRef, const SCH_REFERENCE &  rhRef  )

private

Definition at line 384 of file fields_data_model.cpp.

References GetCanonicalFieldName(), GetFieldNameCol(), getFieldShownText(), SCH_REFERENCE::GetRef(), SCH_REFERENCE::GetSymbol(), IsTextVar(), m_cols, m_dataStore, EDA_ITEM::m_Uuid, and REFERENCE_FIELD.

Referenced by RebuildRows().

isAttribute()

bool FIELDS_EDITOR_GRID_DATA_MODEL::isAttribute ( const wxString &  aFieldName )

private

Definition at line 480 of file fields_data_model.cpp.

Referenced by ApplyData(), ColIsAttribute(), and updateDataStoreSymbolField().

IsEdited()

bool FIELDS_EDITOR_GRID_DATA_MODEL::IsEdited ( )

inline

Definition at line 196 of file fields_data_model.h.

References m_edited.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnClose(), and DIALOG_SYMBOL_FIELDS_TABLE::OnExport().

IsEmptyCell()

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

inlineoverride

Definition at line 139 of file fields_data_model.h.

MoveColumn()

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

inline

Definition at line 98 of file fields_data_model.h.

References m_cols.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnColMove().

RebuildRows()

void FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows

(

)

Definition at line 534 of file fields_data_model.cpp.

References SCH_REFERENCE_LIST::GetCount(), SYMBOL::GetDNP(), SYMBOL::GetExcludedFromBOM(), SCH_REFERENCE::GetFullRef(), SCH_REFERENCE::GetSheetPath(), SCH_REFERENCE::GetSymbol(), GROUP_COLLAPSED, GROUP_SINGLETON, groupMatch(), SCH_SHEET_PATH::IsContainedWithin(), SCH_REFERENCE::IsMultiUnit(), m_excludeDNP, m_filter, m_groupingEnabled, m_includeExcluded, m_path, m_rebuildsEnabled, m_rows, m_scope, m_symbolsList, Sort(), unitMatch(), and WildCompareString().

Referenced by ApplyBomPreset(), DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset(), DIALOG_SYMBOL_FIELDS_TABLE::OnColSort(), DIALOG_SYMBOL_FIELDS_TABLE::OnColumnItemToggled(), DIALOG_SYMBOL_FIELDS_TABLE::OnExcludeDNPToggled(), DIALOG_SYMBOL_FIELDS_TABLE::OnFilterText(), DIALOG_SYMBOL_FIELDS_TABLE::OnGroupSymbolsToggled(), DIALOG_SYMBOL_FIELDS_TABLE::OnRegroupSymbols(), DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsAdded(), DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsChanged(), DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsRemoved(), DIALOG_SYMBOL_FIELDS_TABLE::OnSchSheetChanged(), DIALOG_SYMBOL_FIELDS_TABLE::OnShowExcludedToggled(), DIALOG_SYMBOL_FIELDS_TABLE::PreviewRefresh(), and DIALOG_SYMBOL_FIELDS_TABLE::UpdateScope().

RemoveColumn()

void FIELDS_EDITOR_GRID_DATA_MODEL::RemoveColumn

(

int

aCol

)

Definition at line 69 of file fields_data_model.cpp.

References SCH_REFERENCE_LIST::GetCount(), m_cols, m_dataStore, and m_symbolsList.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnRemoveField().

RemoveReferences()

void FIELDS_EDITOR_GRID_DATA_MODEL::RemoveReferences

(

const SCH_REFERENCE_LIST &

aRefs

)

Definition at line 993 of file fields_data_model.cpp.

References SCH_REFERENCE_LIST::FindRefByFullPath(), m_dataStore, m_symbolsList, and SCH_REFERENCE_LIST::RemoveItem().

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsRemoved().

RemoveSymbol()

void FIELDS_EDITOR_GRID_DATA_MODEL::RemoveSymbol

(

const SCH_SYMBOL &

aSymbol

)

Definition at line 976 of file fields_data_model.cpp.

References SCH_REFERENCE_LIST::begin(), SCH_REFERENCE_LIST::end(), SCH_REFERENCE_LIST::erase(), m_dataStore, m_symbolsList, and EDA_ITEM::m_Uuid.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsRemoved().

RenameColumn()

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

Definition at line 81 of file fields_data_model.cpp.

References SCH_REFERENCE_LIST::GetCount(), m_cols, m_dataStore, m_symbolsList, and EDA_ITEM::m_Uuid.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnRenameField().

setAttributeValue()

void FIELDS_EDITOR_GRID_DATA_MODEL::setAttributeValue ( SCH_SYMBOL &  aSymbol, const wxString &  aAttributeName, const wxString &  aValue  )

private

Definition at line 507 of file fields_data_model.cpp.

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

Referenced by ApplyData().

SetColLabelValue()

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

inlineoverride

Definition at line 115 of file fields_data_model.h.

References m_cols.

Referenced by ApplyBomPreset(), and DIALOG_SYMBOL_FIELDS_TABLE::OnColLabelChange().

SetExcludeDNP()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetExcludeDNP ( bool  exclude )

inline

Definition at line 219 of file fields_data_model.h.

References m_excludeDNP.

Referenced by ApplyBomPreset(), and DIALOG_SYMBOL_FIELDS_TABLE::OnExcludeDNPToggled().

SetFieldsOrder()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetFieldsOrder

(

const std::vector< wxString > &

aNewOrder

)

Definition at line 123 of file fields_data_model.cpp.

References m_cols.

Referenced by ApplyBomPreset().

SetFilter()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetFilter ( const wxString &  aFilter )

inline

Definition at line 200 of file fields_data_model.h.

References m_filter.

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

SetGroupColumn()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetGroupColumn ( int  aCol, bool  group  )

inline

Definition at line 222 of file fields_data_model.h.

References group, and m_cols.

Referenced by ApplyBomPreset(), and DIALOG_SYMBOL_FIELDS_TABLE::OnColumnItemToggled().

SetGroupingEnabled()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetGroupingEnabled ( bool  group )

inline

Definition at line 209 of file fields_data_model.h.

References group, and m_groupingEnabled.

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

SetIncludeExcludedFromBOM()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetIncludeExcludedFromBOM ( bool  include )

inline

Definition at line 216 of file fields_data_model.h.

References m_includeExcluded.

Referenced by ApplyBomPreset(), and DIALOG_SYMBOL_FIELDS_TABLE::OnShowExcludedToggled().

SetPath()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetPath ( const SCH_SHEET_PATH &  aPath )

inline

Definition at line 206 of file fields_data_model.h.

References m_path.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnSchSheetChanged(), and DIALOG_SYMBOL_FIELDS_TABLE::UpdateScope().

SetScope()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetScope ( SCOPE  aScope )

inline

Definition at line 203 of file fields_data_model.h.

References m_scope.

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::UpdateScope().

SetShowColumn()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetShowColumn ( int  aCol, bool  show  )

inline

Definition at line 234 of file fields_data_model.h.

References m_cols.

Referenced by ApplyBomPreset(), DIALOG_SYMBOL_FIELDS_TABLE::OnColumnItemToggled(), and DIALOG_SYMBOL_FIELDS_TABLE::SetupAllColumnProperties().

SetSorting()

void FIELDS_EDITOR_GRID_DATA_MODEL::SetSorting ( int  aCol, bool  ascending  )

inline

Definition at line 172 of file fields_data_model.h.

References m_cols, m_sortAscending, and m_sortColumn.

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

SetValue()

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

override

Definition at line 244 of file fields_data_model.cpp.

References ColIsAttribute(), ColIsReference(), SCH_REFERENCE::GetSymbol(), IsTextVar(), m_cols, m_dataStore, m_edited, DATA_MODEL_ROW::m_Refs, m_rows, and EDA_ITEM::m_Uuid.

Sort()

void FIELDS_EDITOR_GRID_DATA_MODEL::Sort ( )

private

Definition at line 339 of file fields_data_model.cpp.

References CollapseForSort(), ExpandAfterSort(), and m_rows.

Referenced by RebuildRows().

storeReferenceFields()

void FIELDS_EDITOR_GRID_DATA_MODEL::storeReferenceFields ( SCH_REFERENCE &  aRef )

private

unitMatch()

bool FIELDS_EDITOR_GRID_DATA_MODEL::unitMatch ( const SCH_REFERENCE &  lhRef, const SCH_REFERENCE &  rhRef  )

private

Definition at line 373 of file fields_data_model.cpp.

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

Referenced by ExpandRow(), and RebuildRows().

updateDataStoreSymbolField()

void FIELDS_EDITOR_GRID_DATA_MODEL::updateDataStoreSymbolField ( const SCH_SYMBOL &  aSymbol, const wxString &  aFieldName  )

private

Definition at line 53 of file fields_data_model.cpp.

References getAttributeValue(), SCH_SYMBOL::GetFieldByName(), isAttribute(), IsTextVar(), m_dataStore, and EDA_ITEM::m_Uuid.

Referenced by AddColumn(), and UpdateReferences().

UpdateReferences()

void FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences

(

const SCH_REFERENCE_LIST &

aRefs

)

Definition at line 1011 of file fields_data_model.cpp.

References SCH_REFERENCE_LIST::AddItem(), SCH_REFERENCE_LIST::Contains(), m_cols, m_symbolsList, and updateDataStoreSymbolField().

Referenced by DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsChanged().

Member Data Documentation

ITEM_NUMBER_VARIABLE

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

static

Definition at line 92 of file fields_data_model.h.

Referenced by ColIsItemNumber(), and DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames().

m_cols

std::vector<DATA_MODEL_COL> FIELDS_EDITOR_GRID_DATA_MODEL::m_cols

protected

Definition at line 294 of file fields_data_model.h.

Referenced by AddColumn(), ApplyBomPreset(), ApplyData(), ColIsAttribute(), ColIsItemNumber(), ColIsQuantity(), ColIsReference(), ColIsValue(), Export(), GetColFieldName(), GetColLabelValue(), GetFieldNameCol(), GetFieldsOrdered(), GetGroupColumn(), GetNumberCols(), GetShowColumn(), GetValue(), groupMatch(), MoveColumn(), RemoveColumn(), RenameColumn(), SetColLabelValue(), SetFieldsOrder(), SetGroupColumn(), SetShowColumn(), SetSorting(), SetValue(), and UpdateReferences().

m_dataStore

std::map<KIID, std::map<wxString, wxString> > FIELDS_EDITOR_GRID_DATA_MODEL::m_dataStore

protected

Definition at line 300 of file fields_data_model.h.

Referenced by AddReferences(), ApplyData(), GetDataWidth(), GetValue(), groupMatch(), RemoveColumn(), RemoveReferences(), RemoveSymbol(), RenameColumn(), SetValue(), and updateDataStoreSymbolField().

m_edited

bool FIELDS_EDITOR_GRID_DATA_MODEL::m_edited

protected

Definition at line 283 of file fields_data_model.h.

Referenced by ApplyData(), IsEdited(), and SetValue().

m_excludeDNP

bool FIELDS_EDITOR_GRID_DATA_MODEL::m_excludeDNP

protected

Definition at line 290 of file fields_data_model.h.

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

m_filter

wxString FIELDS_EDITOR_GRID_DATA_MODEL::m_filter

protected

Definition at line 286 of file fields_data_model.h.

Referenced by GetFilter(), RebuildRows(), and SetFilter().

m_groupingEnabled

bool FIELDS_EDITOR_GRID_DATA_MODEL::m_groupingEnabled

protected

Definition at line 289 of file fields_data_model.h.

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

m_includeExcluded

bool FIELDS_EDITOR_GRID_DATA_MODEL::m_includeExcluded

protected

Definition at line 291 of file fields_data_model.h.

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

m_path

SCH_SHEET_PATH FIELDS_EDITOR_GRID_DATA_MODEL::m_path

protected

Definition at line 288 of file fields_data_model.h.

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

m_rebuildsEnabled

bool FIELDS_EDITOR_GRID_DATA_MODEL::m_rebuildsEnabled

protected

Definition at line 292 of file fields_data_model.h.

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

m_rows

std::vector<DATA_MODEL_ROW> FIELDS_EDITOR_GRID_DATA_MODEL::m_rows

protected

Definition at line 295 of file fields_data_model.h.

Referenced by CollapseForSort(), CollapseRow(), ExpandAfterSort(), ExpandCollapseRow(), ExpandRow(), Export(), GetExportValue(), GetNumberRows(), GetRowFlags(), GetRowReferences(), GetValue(), RebuildRows(), SetValue(), and Sort().

m_scope

enum SCOPE FIELDS_EDITOR_GRID_DATA_MODEL::m_scope

protected

Definition at line 287 of file fields_data_model.h.

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

m_sortAscending

bool FIELDS_EDITOR_GRID_DATA_MODEL::m_sortAscending

protected

Definition at line 285 of file fields_data_model.h.

Referenced by GetSortAsc(), and SetSorting().

m_sortColumn

int FIELDS_EDITOR_GRID_DATA_MODEL::m_sortColumn

protected

Definition at line 284 of file fields_data_model.h.

Referenced by GetSortCol(), and SetSorting().

m_symbolsList

SCH_REFERENCE_LIST FIELDS_EDITOR_GRID_DATA_MODEL::m_symbolsList

protected

Definition at line 282 of file fields_data_model.h.

Referenced by AddColumn(), AddReferences(), ApplyData(), FIELDS_EDITOR_GRID_DATA_MODEL(), GetDataWidth(), RebuildRows(), RemoveColumn(), RemoveReferences(), RemoveSymbol(), RenameColumn(), and UpdateReferences().

QUANTITY_VARIABLE

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

static

Definition at line 91 of file fields_data_model.h.

Referenced by ColIsQuantity(), and DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames().

---

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

• fields_data_model.h
• fields_data_model.cpp