50#include <wx/textdlg.h>
51#include <wx/filedlg.h>
63#define COLUMN_MARGIN 3
65#define COLUMN_MARGIN 15
81 wxDataViewListCtrl* aFieldsCtrl,
92 int col =
m_grid->GetGridCursorCol();
97 _(
"Browse for footprint" ) );
98 menu.AppendSeparator();
103 _(
"Show datasheet in browser" ) );
104 menu.AppendSeparator();
112 int row =
m_grid->GetGridCursorRow();
113 int col =
m_grid->GetGridCursorCol();
118 wxString fpid =
m_grid->GetCellValue( row, col );
123 if( frame->ShowModal( &fpid,
m_dlg ) )
124 m_grid->SetCellValue( row, col, fpid );
131 wxString datasheet_uri =
m_grid->GetCellValue( row, col );
152 for( row = 0; row <
m_fieldsCtrl->GetItemCount(); row++ )
179 m_currentBomPreset( nullptr ),
180 m_lastSelectedBomPreset( nullptr ),
182 m_schSettings( parent->Schematic().Settings() ),
199 m_fieldsCtrl->AppendTextColumn(
_(
"Field" ), wxDATAVIEW_CELL_INERT, 0, wxALIGN_LEFT, 0 );
200 m_fieldsCtrl->AppendTextColumn(
_(
"Label" ), wxDATAVIEW_CELL_EDITABLE, 0, wxALIGN_LEFT, 0 );
201 m_fieldsCtrl->AppendToggleColumn(
_(
"Show" ), wxDATAVIEW_CELL_ACTIVATABLE, 0,
203 m_fieldsCtrl->AppendToggleColumn(
_(
"Group By" ), wxDATAVIEW_CELL_ACTIVATABLE, 0,
208 m_fieldsCtrl->AppendTextColumn(
_(
"Name" ), wxDATAVIEW_CELL_INERT, 0, wxALIGN_LEFT, 0 );
224 m_filter->SetDescriptiveText(
_(
"Filter" ) );
226 wxGridCellAttr* attr =
new wxGridCellAttr;
240 for(
int row = 0; row <
m_fieldsCtrl->GetItemCount(); ++row )
263 m_grid->UseNativeColHeader(
true );
267 m_grid->SetSelectionMode( wxGrid::wxGridSelectCells );
274 m_grid->SetDefaultRowSize(
m_grid->GetDefaultRowSize() + 4 );
300 field.
name = fieldName;
301 field.
show = !fieldName.StartsWith( wxT(
"__" ), &field.
name );
368 case SCOPE::SCOPE_SHEET_RECURSIVE:
m_radioRecursive->SetValue(
true );
break;
383 m_grid->Connect( wxEVT_GRID_COL_SORT,
385 m_grid->Connect( wxEVT_GRID_COL_MOVE,
401 m_grid->EnableEditing(
false );
412 wxGridCellAttr* attr =
new wxGridCellAttr;
413 attr->SetReadOnly(
false );
436 attr->SetAlignment( wxALIGN_RIGHT, wxALIGN_CENTER );
437 attr->SetRenderer(
new wxGridCellNumberRenderer() );
442 attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
443 attr->SetRenderer(
new wxGridCellBoolRenderer() );
454 attr->SetEditor(
m_grid->GetDefaultEditor() );
463 wxSize defaultDlgSize = ConvertDialogToPixels( wxSize( 600, 300 ) );
466 m_grid->AutoSizeColumns(
false );
468 bool sortAscending =
true;
470 for(
int col = 0; col <
m_grid->GetNumberCols(); ++col )
507 int maxWidth = defaultDlgSize.x / 3;
509 m_grid->SetColSize( col, std::clamp( textWidth, 100, maxWidth ) );
519 m_grid->SetSortingColumn( sortCol, sortAscending );
526 m_grid->Disconnect( wxEVT_GRID_COL_SORT,
529 m_grid->Disconnect( wxEVT_GRID_COL_SORT,
534 m_grid->PopEventHandler(
true );
542 if( !wxDialog::TransferDataFromWindow() )
552 if( selection.GetSize() == 1 )
571 if( ref.GetSymbol() == symbol )
596 m_grid->GoToCell( row, valueCol );
598 m_grid->GoToCell( row, refCol );
599 else if( anyCol != -1 )
600 m_grid->GoToCell( row, anyCol );
621 if( !wxDialog::TransferDataFromWindow() )
635 commit.
Push( wxS(
"Symbol Fields Table Edit" ) );
649 bool show,
bool groupBy,
bool addedByUser )
661 wxVector<wxVariant> fieldsCtrlRow;
662 std::string key( aFieldName.ToUTF8() );
665 fieldsCtrlRow.push_back( wxVariant( aFieldName ) );
666 fieldsCtrlRow.push_back( wxVariant( aLabelValue ) );
667 fieldsCtrlRow.push_back( wxVariant( show ) );
668 fieldsCtrlRow.push_back( wxVariant( groupBy ) );
669 fieldsCtrlRow.push_back( wxVariant( aFieldName ) );
673 wxGridTableMessage msg(
m_dataModel, wxGRIDTABLE_NOTIFY_COLS_APPENDED, 1 );
674 m_grid->ProcessTableMessage( msg );
680 auto addMandatoryField =
681 [&](
FIELD_T fieldId,
bool show,
bool groupBy )
690 addMandatoryField( FIELD_T::REFERENCE,
true,
true );
691 addMandatoryField( FIELD_T::VALUE,
true,
true );
692 addMandatoryField( FIELD_T::FOOTPRINT,
true,
true );
693 addMandatoryField( FIELD_T::DATASHEET,
true,
false );
694 addMandatoryField( FIELD_T::DESCRIPTION,
false,
false );
701 std::set<wxString> userFieldNames;
709 if( !field.IsMandatory() && !field.IsPrivate() )
710 userFieldNames.insert( field.GetName() );
714 for(
const wxString& fieldName : userFieldNames )
721 if( userFieldNames.count( templateFieldname.m_Name ) == 0 )
732 wxTextEntryDialog dlg(
this,
_(
"New field name:" ),
_(
"Add Field" ) );
734 if( dlg.ShowModal() != wxID_OK )
737 wxString fieldName = dlg.GetValue();
739 if( fieldName.IsEmpty() )
749 DisplayError(
this, wxString::Format(
_(
"Field name '%s' already in use." ),
779 DisplayError(
this, wxString::Format(
_(
"The first %d fields are mandatory." ),
788 wxString confirm_msg = wxString::Format(
_(
"Are you sure you want to remove the field '%s'?" ),
791 if( !
IsOK(
this, confirm_msg ) )
808 wxGridTableMessage msg(
m_dataModel, wxGRIDTABLE_NOTIFY_COLS_DELETED, col, 1 );
810 m_grid->ProcessTableMessage( msg );
839 wxCHECK_RET( col != -1, wxS(
"Existing field name missing from data model" ) );
841 wxTextEntryDialog dlg(
this,
_(
"New field name:" ),
_(
"Rename Field" ) );
843 if( dlg.ShowModal() != wxID_OK )
846 wxString newFieldName = dlg.GetValue();
849 if( newFieldName == fieldName )
855 wxString confirm_msg = wxString::Format(
_(
"Field name %s already exists." ),
883 wxPoint pos = aEvent.GetPosition();
884 wxRect ctrlRect =
m_filter->GetScreenRect();
885 int buttonWidth = ctrlRect.GetHeight();
888 if(
m_filter->IsSearchButtonVisible() && pos.x < buttonWidth )
889 SetCursor( wxCURSOR_ARROW );
890 else if(
m_filter->IsCancelButtonVisible() && pos.x > ctrlRect.GetWidth() - buttonWidth )
891 SetCursor( wxCURSOR_ARROW );
893 SetCursor( wxCURSOR_IBEAM );
899 wxDataViewItem item =
event.GetItem();
901 int col =
event.GetColumn();
916 m_grid->ShowCol( dataCol );
918 m_grid->HideCol( dataCol );
932 DisplayError(
this,
_(
"The Quantity column cannot be grouped by." ) );
940 DisplayError(
this,
_(
"The Item Number column cannot be grouped by." ) );
994 int sortCol = aEvent.GetCol();
1007 if(
m_grid->IsSortingBy( sortCol ) )
1010 ascending = !
m_grid->IsSortOrderAscending();
1028 int origPos = aEvent.GetCol();
1033 for(
int i = 0; i <
m_grid->GetNumberCols(); i++ )
1035 if(
m_grid->IsColShown( i ) )
1045 int newPos =
m_grid->GetColPos( origPos );
1048 if( newPos < origPos )
1069 wxDataViewItem item = aEvent.GetItem();
1095 int col = aEvent.GetRowOrCol();
1136 m_grid->ClearSelection();
1139 m_grid->SetGridCursor( event.GetRow(), event.GetCol() );
1156 std::set<SCH_REFERENCE> refs;
1157 std::set<SCH_ITEM*> symbols;
1160 if( aEvent.Selecting() )
1162 for(
int i = aEvent.GetTopRow(); i <= aEvent.GetBottomRow(); i++ )
1169 symbols.insert( ref.GetSymbol() );
1176 if( refs.size() > 0 )
1180 wxString symbol_path = refs.begin()->GetFullPath();
1194 std::vector<SCH_ITEM*> items( symbols.begin(), symbols.end() );
1196 if( refs.size() > 0 )
1197 selTool->
SyncSelection( refs.begin()->GetSheetPath(),
nullptr, items );
1310 wxFileDialog saveDlg(
this,
_(
"Bill of Materials Output File" ),
path, fn.GetFullName(),
1313 if( saveDlg.ShowModal() == wxID_CANCEL )
1317 wxFileName file = wxFileName( saveDlg.GetPath() );
1318 wxString defaultPath = fn.GetPathWithSep();
1320 msg.Printf(
_(
"Do you want to use a path relative to\n'%s'?" ), defaultPath );
1322 wxMessageDialog dialog(
this, msg,
_(
"BOM Output File" ),
1323 wxYES_NO | wxICON_QUESTION | wxYES_DEFAULT );
1325 if( dialog.ShowModal() == wxID_YES )
1327 if( !file.MakeRelativeTo( defaultPath ) )
1329 wxMessageBox(
_(
"Cannot make path relative (target volume different from schematic "
1331 _(
"BOM Output File" ), wxOK | wxICON_ERROR );
1344 _(
"Changes have not yet been saved. Export unsaved data?" ),
"",
1345 _(
"OK" ),
_(
"Cancel" ) )
1355 std::function<bool( wxString* )> textResolver =
1356 [&]( wxString* token ) ->
bool
1366 if(
path.IsEmpty() )
1368 DisplayError(
this,
_(
"No output file specified in Export tab." ) );
1375 wxFileName outputFile = wxFileName::FileName(
path );
1382 msg.Printf(
_(
"Could not open/create path '%s'." ), outputFile.GetPath() );
1387 wxFFile out( outputFile.GetFullPath(),
"wb" );
1389 if( !out.IsOpened() )
1391 msg.Printf(
_(
"Could not create BOM output '%s'." ), outputFile.GetFullPath() );
1400 msg.Printf(
_(
"Could not write BOM output '%s'." ), outputFile.GetFullPath() );
1407 msg.Printf(
_(
"Wrote BOM output to '%s'" ), outputFile.GetFullPath() );
1415 EndModal( wxID_CANCEL );
1460 if( modelField.show )
1467 if( modelField.groupBy )
1471 EndModal( wxID_OK );
1531 for(
int i = 0; i <
m_grid->GetNumberCols(); i++ )
1533 if(
m_grid->IsColShown( i ) )
1542 wxCommandEvent* evt =
new wxCommandEvent( EDA_EVT_CLOSE_DIALOG_SYMBOL_FIELDS_TABLE, wxID_ANY );
1544 if( wxWindow* parent = GetParent() )
1545 wxQueueEvent( parent, evt );
1551 std::vector<BOM_PRESET> ret;
1553 for(
const std::pair<const wxString, BOM_PRESET>& pair :
m_bomPresets )
1555 if( !pair.second.readOnly )
1556 ret.emplace_back( pair.second );
1568 for(
const BOM_PRESET& preset : aPresetList )
1586 wxCommandEvent
dummy;
1631 int default_idx = 0;
1633 for( std::pair<const wxString, BOM_PRESET>& pair :
m_bomPresets )
1636 static_cast<void*
>( &pair.second ) );
1662 [&](
const std::pair<const wxString, BOM_PRESET>& aPair )
1664 const BOM_PRESET& preset = aPair.second;
1667 if( !( preset.sortAsc == current.sortAsc
1668 && preset.filterString == current.filterString
1669 && preset.groupSymbols == current.groupSymbols
1670 && preset.excludeDNP == current.excludeDNP
1671 && preset.includeExcludedFromBOM
1672 == current.includeExcludedFromBOM ) )
1686 if( preset.sortField != wxGetTranslation( current.
sortField ) )
1690 std::vector<BOM_FIELD>
A,
B;
1692 for(
const BOM_FIELD& field : preset.fieldsOrdered )
1694 if( field.show || field.groupBy )
1695 A.emplace_back( field );
1700 if( field.show || field.groupBy )
1701 B.emplace_back( field );
1707 if( it != m_bomPresets.end() )
1711 bool do_translate = it->second.
readOnly;
1712 wxString
text = do_translate ? wxGetTranslation( it->first ) : it->first;
1713 m_cbBomPresets->SetStringSelection(
text );
1717 m_cbBomPresets->SetSelection( m_cbBomPresets->GetCount() - 3 );
1720 m_currentBomPreset =
static_cast<BOM_PRESET*
>(
1721 m_cbBomPresets->GetClientData( m_cbBomPresets->GetSelection() ) );
1731 wxString ui_label = aName;
1733 for( std::pair<const wxString, BOM_PRESET>& pair :
m_bomPresets )
1735 if( pair.first != aName )
1738 if( pair.second.readOnly ==
true )
1739 ui_label = wxGetTranslation( aName );
1763 auto resetSelection =
1772 if( index == count - 3 )
1778 else if( index == count - 2 )
1786 wxTextEntryDialog dlg(
this,
_(
"BOM preset name:" ),
_(
"Save BOM Preset" ),
name );
1788 if( dlg.ShowModal() != wxID_OK )
1794 name = dlg.GetValue();
1812 wxMessageBox(
_(
"Default presets cannot be modified.\nPlease use a different name." ),
1813 _(
"Error" ), wxOK | wxICON_ERROR,
this );
1820 if( !
IsOK(
this,
_(
"Overwrite existing preset?" ) ) )
1839 else if( index == count - 1 )
1842 wxArrayString headers;
1843 std::vector<wxArrayString> items;
1845 headers.Add(
_(
"Presets" ) );
1847 for( std::pair<const wxString, BOM_PRESET>& pair :
m_bomPresets )
1849 if( !pair.second.readOnly )
1852 item.Add( pair.first );
1853 items.emplace_back( item );
1865 if( idx != wxNOT_FOUND )
1912 for(
int i = 0; i <
m_dataModel->GetColsCount(); i++ )
1917 for(
int j = 0; j <
m_fieldsCtrl->GetItemCount(); j++ )
1932 for(
int i = 0; i <
m_fieldsCtrl->GetItemCount(); i++ )
1939 wxASSERT_MSG(
true,
"Fields control has a field not found in the data model." );
1944 std::string fieldNameStr( fieldName.ToUTF8() );
1949 m_grid->SetColLabelValue( col, label );
1986 std::vector<BOM_FMT_PRESET> ret;
1988 for(
const std::pair<const wxString, BOM_FMT_PRESET>& pair :
m_bomFmtPresets )
1990 if( !pair.second.readOnly )
1991 ret.emplace_back( pair.second );
2021 wxCommandEvent
dummy;
2065 int default_idx = 0;
2067 for( std::pair<const wxString, BOM_FMT_PRESET>& pair :
m_bomFmtPresets )
2070 static_cast<void*
>( &pair.second ) );
2097 [&](
const std::pair<const wxString, BOM_FMT_PRESET>& aPair )
2099 return ( aPair.second.fieldDelimiter == current.fieldDelimiter
2100 && aPair.second.stringDelimiter == current.stringDelimiter
2101 && aPair.second.refDelimiter == current.refDelimiter
2102 && aPair.second.refRangeDelimiter == current.refRangeDelimiter
2103 && aPair.second.keepTabs == current.keepTabs
2104 && aPair.second.keepLineBreaks == current.keepLineBreaks );
2111 bool do_translate = it->second.readOnly;
2112 wxString
text = do_translate ? wxGetTranslation( it->first ) : it->first;
2132 wxString ui_label = aName;
2134 for( std::pair<const wxString, BOM_FMT_PRESET>& pair :
m_bomFmtPresets )
2136 if( pair.first != aName )
2139 if( pair.second.readOnly ==
true )
2140 ui_label = wxGetTranslation( aName );
2165 auto resetSelection =
2174 if( index == count - 3 )
2180 else if( index == count - 2 )
2188 wxTextEntryDialog dlg(
this,
_(
"BOM preset name:" ),
_(
"Save BOM Preset" ),
name );
2190 if( dlg.ShowModal() != wxID_OK )
2196 name = dlg.GetValue();
2214 wxMessageBox(
_(
"Default presets cannot be modified.\nPlease use a different name." ),
2215 _(
"Error" ), wxOK | wxICON_ERROR,
this );
2222 if( !
IsOK(
this,
_(
"Overwrite existing preset?" ) ) )
2241 else if( index == count - 1 )
2244 wxArrayString headers;
2245 std::vector<wxArrayString> items;
2247 headers.Add(
_(
"Presets" ) );
2249 for( std::pair<const wxString, BOM_FMT_PRESET>& pair :
m_bomFmtPresets )
2251 if( !pair.second.readOnly )
2254 item.Add( pair.first );
2255 items.emplace_back( item );
2267 if( idx != wxNOT_FOUND )
2320 bool modified =
false;
2323 std::vector<BOM_PRESET> presets;
2325 for(
const std::pair<const wxString, BOM_PRESET>& pair :
m_bomPresets )
2327 if( !pair.second.readOnly )
2328 presets.emplace_back( pair.second );
2344 std::vector<BOM_FMT_PRESET> fmts;
2346 for(
const std::pair<const wxString, BOM_FMT_PRESET>& pair :
m_bomFmtPresets )
2348 if( !pair.second.readOnly )
2349 fmts.emplace_back( pair.second );
2370 std::vector<SCH_ITEM*>& aSchItem )
2387 AddField( field.GetCanonicalName(), field.GetName(),
true,
false, true );
2393 std::set<SCH_SYMBOL*> symbols;
2397 symbols.insert( ref.GetSymbol() );
2402 for(
SCH_FIELD& field : symbol->GetFields() )
2403 AddField( field.GetCanonicalName(), field.GetName(),
true,
false,
true );
2417 std::vector<SCH_ITEM*>& aSchItem )
2439 std::vector<SCH_ITEM*>& aSchItem )
2456 AddField( field.GetCanonicalName(), field.GetName(),
true,
false, true );
2462 std::set<SCH_SYMBOL*> symbols;
2466 symbols.insert( ref.GetSymbol() );
2471 for(
SCH_FIELD& field : symbol->GetFields() )
2472 AddField( field.GetCanonicalName(), field.GetName(),
true,
false,
true );
2501 wxEVT_GRID_RANGE_SELECTED,
2510 wxEVT_GRID_RANGE_SELECTED,
2522 for(
size_t i = 0; i < aCachedRefs.
GetCount(); i++ )
2549 if( basePath.Path() == instance.m_Path )
2557 subSheets.push_back( sheetPath );
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap, int aMinHeight)
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
int vertPixelsFromDU(int y) const
Convert an integer number of dialog units to pixels, vertically.
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
void SetupStandardButtons(std::map< int, wxString > aLabels={})
int horizPixelsFromDU(int x) const
Convert an integer number of dialog units to pixels, horizontally.
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
Class DIALOG_SYMBOL_FIELDS_TABLE_BASE.
wxRadioButton * m_radioRecursive
wxCheckBox * m_checkShowExcluded
wxCheckBox * m_checkKeepLineBreaks
STD_BITMAP_BUTTON * m_bRefreshPreview
wxRadioButton * m_radioOff
wxStaticText * m_bomPresetsLabel
wxCheckBox * m_checkKeepTabs
wxButton * m_buttonExport
STD_BITMAP_BUTTON * m_removeFieldButton
STD_BITMAP_BUTTON * m_browseButton
wxRadioButton * m_radioSelect
wxTextCtrl * m_textOutput
STD_BITMAP_BUTTON * m_bRefresh
STD_BITMAP_BUTTON * m_renameFieldButton
STD_BITMAP_BUTTON * m_addFieldButton
wxTextCtrl * m_textStringDelimiter
wxChoice * m_cbBomPresets
wxTextCtrl * m_outputFileName
wxSplitterWindow * m_splitterMainWindow
wxDataViewListCtrl * m_fieldsCtrl
wxCheckBox * m_checkExcludeDNP
wxRadioButton * m_radioCurrentSheet
wxTextCtrl * m_textFieldDelimiter
wxCheckBox * m_groupSymbolsBox
wxRadioButton * m_radioHighlight
wxStaticText * m_labelBomExportPresets
wxTextCtrl * m_textRefRangeDelimiter
wxRadioButton * m_radioProject
wxChoice * m_cbBomFmtPresets
wxTextCtrl * m_textRefDelimiter
void OnTableColSize(wxGridSizeEvent &event) override
void OnSaveAndContinue(wxCommandEvent &aEvent) override
void OnSchItemsRemoved(SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aSchItem) override
BOM_FMT_PRESET * m_currentBomFmtPreset
void OnPreviewRefresh(wxCommandEvent &event) override
void OnAddField(wxCommandEvent &event) override
SCH_REFERENCE_LIST getSheetSymbolReferences(SCH_SHEET &aSheet)
void SetUserBomPresets(std::vector< BOM_PRESET > &aPresetList)
void OnOk(wxCommandEvent &aEvent) override
void OnGroupSymbolsToggled(wxCommandEvent &event) override
void OnColumnItemToggled(wxDataViewEvent &event) override
void OnColMove(wxGridEvent &aEvent)
void OnSchItemsAdded(SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aSchItem) override
void loadDefaultBomFmtPresets()
std::map< wxString, BOM_PRESET > m_bomPresets
void OnSchItemsChanged(SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aSchItem) override
void ApplyBomFmtPreset(const wxString &aPresetName)
SCH_EDIT_FRAME * m_parent
bool TransferDataFromWindow() override
SCH_REFERENCE_LIST m_symbolsList
void SetupColumnProperties(int aCol)
FIELDS_EDITOR_GRID_DATA_MODEL * m_dataModel
void updateBomPresetSelection(const wxString &aName)
void OnTableItemContextMenu(wxGridEvent &event) override
void updateBomFmtPresetSelection(const wxString &aName)
void OnFilterText(wxCommandEvent &aEvent) override
void OnScopeChanged(wxCommandEvent &aEvent) override
std::map< FIELD_T, int > m_mandatoryFieldListIndexes
void OnRemoveField(wxCommandEvent &event) override
void OnTableCellClick(wxGridEvent &event) override
void OnShowExcludedToggled(wxCommandEvent &event) override
wxArrayString m_bomPresetMRU
void OnColLabelChange(wxDataViewEvent &aEvent)
void doApplyBomFmtPreset(const BOM_FMT_PRESET &aPreset)
void loadDefaultBomPresets()
void onBomPresetChanged(wxCommandEvent &aEvent)
void OnTableValueChanged(wxGridEvent &event) override
void OnExport(wxCommandEvent &aEvent) override
void OnClose(wxCloseEvent &aEvent) override
void OnSchSheetChanged(SCHEMATIC &aSch) override
void syncBomFmtPresetSelection()
void DisableSelectionEvents()
bool TransferDataToWindow() override
void OnTableRangeSelected(wxGridRangeSelectEvent &aEvent)
void EnableSelectionEvents()
std::vector< BOM_FMT_PRESET > GetUserBomFmtPresets() const
wxArrayString m_bomFmtPresetMRU
void OnCancel(wxCommandEvent &aEvent) override
void OnFilterMouseMoved(wxMouseEvent &event) override
std::map< wxString, BOM_FMT_PRESET > m_bomFmtPresets
DIALOG_SYMBOL_FIELDS_TABLE(SCH_EDIT_FRAME *parent, JOB_EXPORT_SCH_BOM *aJob=nullptr)
BOM_FMT_PRESET GetCurrentBomFmtSettings()
Returns a formatting configuration corresponding to the values in the UI controls of the dialog.
void savePresetsToSchematic()
void SetupAllColumnProperties()
void AddField(const wxString &displayName, const wxString &aCanonicalName, bool show, bool groupBy, bool addedByUser=false)
SCH_REFERENCE_LIST getSymbolReferences(SCH_SYMBOL *aSymbol, SCH_REFERENCE_LIST &aCachedRefs)
SCHEMATIC_SETTINGS & m_schSettings
void syncBomPresetSelection()
void OnSizeFieldList(wxSizeEvent &event) override
void doApplyBomPreset(const BOM_PRESET &aPreset)
void OnPageChanged(wxNotebookEvent &event) override
void SetUserBomFmtPresets(std::vector< BOM_FMT_PRESET > &aPresetList)
void OnRegroupSymbols(wxCommandEvent &aEvent) override
void OnColSort(wxGridEvent &aEvent)
JOB_EXPORT_SCH_BOM * m_job
virtual ~DIALOG_SYMBOL_FIELDS_TABLE()
std::vector< BOM_PRESET > GetUserBomPresets() const
void OnOutputFileBrowseClicked(wxCommandEvent &event) override
void LoadFieldNames()
Construct the rows of m_fieldsCtrl and the columns of m_dataModel from a union of all field names in ...
void onBomFmtPresetChanged(wxCommandEvent &aEvent)
void ApplyBomPreset(const wxString &aPresetName)
void OnExcludeDNPToggled(wxCommandEvent &event) override
void rebuildBomFmtPresetsWidget()
BOM_PRESET * m_lastSelectedBomPreset
void rebuildBomPresetsWidget()
BOM_PRESET * m_currentBomPreset
BOM_FMT_PRESET * m_lastSelectedBomFmtPreset
void OnRenameField(wxCommandEvent &event) override
A base class for most all the KiCad significant classes used in schematics and boards.
KICAD_T Type() const
Returns the type of object.
EDA_ITEM * GetParent() const
wxString GetTextSelection(int aColumn=0)
Return the selected text from aColumn in the wxListCtrl in the dialog.
void SetListLabel(const wxString &aLabel)
PANEL_FIELD_EDITOR m_FieldEditorPanel
int GetFieldNameCol(const wxString &aFieldName) const
wxString GetColFieldName(int aCol)
void ApplyBomPreset(const BOM_PRESET &preset)
std::vector< SCH_REFERENCE > GetRowReferences(int aRow) const
void SetGroupingEnabled(bool group)
bool ColIsItemNumber(int aCol)
int GetNumberCols() override
bool ColIsQuantity(int aCol)
bool GetGroupColumn(int aCol)
wxString GetColLabelValue(int aCol) override
BOM_PRESET GetBomSettings()
void SetScope(SCOPE aScope)
bool ColIsReference(int aCol)
bool GetGroupingEnabled()
void SetPath(const SCH_SHEET_PATH &aPath)
int GetNumberRows() override
void RenameColumn(int aCol, const wxString &newName)
wxString Export(const BOM_FMT_PRESET &settings)
void AddColumn(const wxString &aFieldName, const wxString &aLabel, bool aAddedByUser)
void SetSorting(int aCol, bool ascending)
void ExpandCollapseRow(int aRow)
void SetFilter(const wxString &aFilter)
void SetColAttr(wxGridCellAttr *aAttr, int aCol) override
static const wxString ITEM_NUMBER_VARIABLE
void SetIncludeExcludedFromBOM(bool include)
int GetDataWidth(int aCol)
void UpdateReferences(const SCH_REFERENCE_LIST &aRefs)
void ApplyData(SCH_COMMIT &aCommit)
void RemoveColumn(int aCol)
const wxString & GetFilter()
static const wxString QUANTITY_VARIABLE
bool ColIsValue(int aCol)
void SetGroupColumn(int aCol, bool group)
void SetExcludeDNP(bool exclude)
void RemoveSymbol(const SCH_SYMBOL &aSymbol)
std::vector< BOM_FIELD > GetFieldsOrdered()
bool ColIsAttribute(int aCol)
bool GetShowColumn(int aCol)
void SetColLabelValue(int aCol, const wxString &aLabel) override
void MoveColumn(int aCol, int aNewPos)
void RemoveReferences(const SCH_REFERENCE_LIST &aRefs)
bool GetIncludeExcludedFromBOM()
void SetShowColumn(int aCol, bool show)
void AddReferences(const SCH_REFERENCE_LIST &aRefs)
wxDataViewListCtrl * m_fieldsCtrl
void showPopupMenu(wxMenu &menu, wxGridEvent &aEvent) override
FIELDS_EDITOR_GRID_TRICKS(DIALOG_SHIM *aParent, WX_GRID *aGrid, wxDataViewListCtrl *aFieldsCtrl, FIELDS_EDITOR_GRID_DATA_MODEL *aDataModel)
void doPopupSelection(wxCommandEvent &event) override
FIELDS_EDITOR_GRID_DATA_MODEL * m_dataModel
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
virtual void doPopupSelection(wxCommandEvent &event)
virtual void showPopupMenu(wxMenu &menu, wxGridEvent &aEvent)
WX_GRID * m_grid
I don't own the grid, but he owns me.
bool m_includeExcludedFromBOM
std::vector< wxString > m_fieldsLabels
std::vector< wxString > m_fieldsOrdered
wxString GetSettingsDialogTitle() const override
wxString m_refRangeDelimiter
std::vector< wxString > m_fieldsGroupBy
wxString m_stringDelimiter
wxString m_fieldDelimiter
wxString m_bomFmtPresetName
void SetConfiguredOutputPath(const wxString &aPath)
Sets the configured output path for the job, this path is always saved to file.
wxString GetConfiguredOutputPath() const
Returns the configured output path for the job.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
static REPORTER & GetInstance()
static SEARCH_STACK * SchSearchS(PROJECT *aProject)
Accessor for Eeschema search stack.
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
wxString m_BomExportFileName
BOM_FMT_PRESET m_BomFmtSettings
List of stored BOM format presets.
TEMPLATES m_TemplateFieldNames
std::vector< BOM_PRESET > m_BomPresets
std::vector< BOM_FMT_PRESET > m_BomFmtPresets
BOM_PRESET m_BomSettings
List of stored BOM presets.
Holds all the data relating to one schematic.
void RemoveListener(SCHEMATIC_LISTENER *aListener)
Remove the specified listener.
wxString GetFileName() const
Helper to retrieve the filename from the root sheet screen.
SCH_SHEET_LIST Hierarchy() const
Return the full schematic flattened hierarchical sheet list.
void AddListener(SCHEMATIC_LISTENER *aListener)
Add a listener to the schematic to receive calls whenever something on the schematic has been modifie...
bool ResolveTextVar(const SCH_SHEET_PATH *aSheetPath, wxString *token, int aDepth) const
SCH_SHEET_PATH & CurrentSheet() const
void SyncView()
Mark all items for refresh.
EESCHEMA_SETTINGS * eeconfig() const
virtual void Push(const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
Execute the changes.
Handle actions specific to the schematic editor.
Schematic editor (Eeschema) main window.
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag and update other data struc...
SCH_SHEET_PATH & GetCurrentSheet() const
SCHEMATIC & Schematic() const
void SetCurrentSheet(const SCH_SHEET_PATH &aSheet)
bool SaveProject(bool aSaveAs=false)
Save the currently-open schematic (including its hierarchy) and associated project.
void FocusOnItem(SCH_ITEM *aItem)
Base class for any item which can be embedded within the SCHEMATIC container class,...
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
void AddItem(const SCH_REFERENCE &aItem)
A helper to define a symbol's reference designator in a schematic.
void Split()
Attempt to split the reference designator into a name (U) and number (1).
SCH_SYMBOL * GetSymbol() const
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets.
void GetSheetsWithinPath(std::vector< SCH_SHEET_PATH > &aSheets, const SCH_SHEET_PATH &aSheetPath) const
Add a SCH_SHEET_PATH object to aSheets for each sheet in the list that are contained within aSheetPat...
void GetSymbolsWithinPath(SCH_REFERENCE_LIST &aReferences, const SCH_SHEET_PATH &aSheetPath, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets that are contained wi...
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
const std::vector< SCH_SHEET_INSTANCE > & GetInstances() const
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly) const override
Populate a std::vector with SCH_FIELDs, sorted in ordinal order.
bool IsMissingLibSymbol() const
Check to see if the library symbol is set to the dummy library symbol.
bool IsPower() const override
const TEMPLATE_FIELDNAMES & GetTemplateFieldNames()
Return a template field name list for read only access.
void SetTable(wxGridTableBase *table, bool aTakeOwnership=false)
Hide wxGrid's SetTable() method with one which doesn't mess up the grid column widths when setting th...
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
const wxString ExpandEnvVarSubstitutions(const wxString &aString, const PROJECT *aProject)
Replace any environment variable & text variable references with their values.
wxString ExpandTextVars(const wxString &aSource, const PROJECT *aProject, int aFlags)
bool EnsureFileDirectoryExists(wxFileName *aTargetFullFileName, const wxString &aBaseFilename, REPORTER *aReporter)
Make aTargetFullFileName absolute and create the path of this file if it doesn't yet exist.
bool IsTextVar(const wxString &aSource)
Returns true if the string is a text var, e.g starts with ${.
wxString GetTextVars(const wxString &aSource)
Returns any variables unexpanded, e.g.
int OKOrCancelDialog(wxWindow *aParent, const wxString &aWarning, const wxString &aMessage, const wxString &aDetailedMessage, const wxString &aOKLabel, const wxString &aCancelLabel, bool *aApplyToAll)
Display a warning dialog with aMessage and returns the user response.
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
void DisplayError(wxWindow *aParent, const wxString &aText)
Display an error or warning message box with aMessage.
This file is part of the common library.
wxDEFINE_EVENT(EDA_EVT_CLOSE_DIALOG_SYMBOL_FIELDS_TABLE, wxCommandEvent)
bool GetAssociatedDocument(wxWindow *aParent, const wxString &aDocName, PROJECT *aProject, SEARCH_STACK *aPaths, EMBEDDED_FILES *aFiles)
Open a document (file) with the suitable browser.
This file is part of the common library.
#define DISPLAY_NAME_COLUMN
#define FIELD_NAME_COLUMN
#define SHOW_FIELD_COLUMN
@ FRAME_FOOTPRINT_CHOOSER
@ GRIDTRICKS_FIRST_SHOWHIDE
@ GRIDTRICKS_FIRST_CLIENT_ID
static const std::string CsvFileExtension
static wxString CsvFileWildcard()
KICOMMON_API wxFont GetInfoFont(wxWindow *aWindow)
KICOMMON_API wxSize GetTextSize(const wxString &aSingleLine, wxWindow *aWindow)
Return the size of aSingleLine of text when it is rendered in aWindow using whatever font is currentl...
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
std::vector< FAB_LAYER_COLOR > dummy
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
static BOM_FMT_PRESET CSV()
static std::vector< BOM_FMT_PRESET > BuiltInPresets()
wxString refRangeDelimiter
static BOM_PRESET DefaultEditing()
std::vector< BOM_FIELD > fieldsOrdered
bool includeExcludedFromBOM
static std::vector< BOM_PRESET > BuiltInPresets()
std::map< std::string, int > field_widths
A simple container for sheet instance information.
Hold a name of a symbol's field, field value, and default visibility.
Definition for symbol library class.
wxString GetDefaultFieldName(FIELD_T aFieldId, bool aTranslateForHI)
Return a default symbol field name for a mandatory field type.
FIELD_T
The set of all field indices assuming an array like sequence that a SCH_COMPONENT or LIB_PART can hol...
wxString GetCanonicalFieldName(FIELD_T aFieldType)
Definition of file extensions used in Kicad.