KiCad PCB EDA Suite
Loading...
Searching...
No Matches
dialog_symbol_fields_table.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2017 Oliver Walters
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25
26#include <common.h>
27#include <base_units.h>
28#include <bitmaps.h>
29#include <symbol_library.h>
30#include <confirm.h>
31#include <eda_doc.h>
32#include <wildcards_and_files_ext.h>
33#include <schematic_settings.h>
34#include <general.h>
35#include <grid_tricks.h>
36#include <string_utils.h>
37#include <kiface_base.h>
38#include <sch_commit.h>
39#include <sch_edit_frame.h>
40#include <sch_reference_list.h>
41#include <tools/sch_editor_control.h>
42#include <kiplatform/ui.h>
43#include <widgets/grid_text_button_helpers.h>
44#include <widgets/bitmap_button.h>
45#include <widgets/std_bitmap_button.h>
46#include <widgets/wx_grid.h>
47#include <widgets/grid_checkbox.h>
48#include <wx/debug.h>
49#include <wx/ffile.h>
50#include <wx/grid.h>
51#include <wx/textdlg.h>
52#include <wx/filedlg.h>
53#include <wx/msgdlg.h>
54#include <dialogs/eda_view_switcher.h>
55#include "dialog_symbol_fields_table.h"
56#include <fields_data_model.h>
57#include <eda_list_dialog.h>
58#include <project_sch.h>
59#include <jobs/job_export_sch_bom.h>
60
61wxDEFINE_EVENT( EDA_EVT_CLOSE_DIALOG_SYMBOL_FIELDS_TABLE, wxCommandEvent );
62
63#ifdef __WXMAC__
64#define COLUMN_MARGIN 3
65#else
66#define COLUMN_MARGIN 15
67#endif
68
69using SCOPE = FIELDS_EDITOR_GRID_DATA_MODEL::SCOPE;
70
71
72enum
73{
74 MYID_SELECT_FOOTPRINT = GRIDTRICKS_FIRST_CLIENT_ID,
75 MYID_SHOW_DATASHEET
76};
77
78class FIELDS_EDITOR_GRID_TRICKS : public GRID_TRICKS
79{
80public:
81 FIELDS_EDITOR_GRID_TRICKS( DIALOG_SHIM* aParent, WX_GRID* aGrid, wxDataViewListCtrl* aFieldsCtrl,
82 FIELDS_EDITOR_GRID_DATA_MODEL* aDataModel, EMBEDDED_FILES* aFiles ) :
83 GRID_TRICKS( aGrid ),
84 m_dlg( aParent ),
85 m_fieldsCtrl( aFieldsCtrl ),
86 m_dataModel( aDataModel ),
87 m_files( aFiles )
88 {}
89
90protected:
91 void showPopupMenu( wxMenu& menu, wxGridEvent& aEvent ) override
92 {
93 int col = m_grid->GetGridCursorCol();
94
95 if( m_dataModel->GetColFieldName( col ) == GetCanonicalFieldName( FIELD_T::FOOTPRINT ) )
96 {
97 menu.Append( MYID_SELECT_FOOTPRINT, _( "Select Footprint..." ), _( "Browse for footprint" ) );
98 menu.AppendSeparator();
99 }
100 else if( m_dataModel->GetColFieldName( col ) == GetCanonicalFieldName( FIELD_T::DATASHEET ) )
101 {
102 menu.Append( MYID_SHOW_DATASHEET, _( "Show Datasheet" ), _( "Show datasheet in browser" ) );
103 menu.AppendSeparator();
104 }
105
106 GRID_TRICKS::showPopupMenu( menu, aEvent );
107 }
108
109 void doPopupSelection( wxCommandEvent& event ) override
110 {
111 int row = m_grid->GetGridCursorRow();
112 int col = m_grid->GetGridCursorCol();
113
114 if( event.GetId() == MYID_SELECT_FOOTPRINT )
115 {
116 // pick a footprint using the footprint picker.
117 wxString fpid = m_grid->GetCellValue( row, col );
118
119 if( KIWAY_PLAYER* frame = m_dlg->Kiway().Player( FRAME_FOOTPRINT_CHOOSER, true, m_dlg ) )
120 {
121 if( frame->ShowModal( &fpid, m_dlg ) )
122 m_grid->SetCellValue( row, col, fpid );
123
124 frame->Destroy();
125 }
126 }
127 else if (event.GetId() == MYID_SHOW_DATASHEET )
128 {
129 wxString datasheet_uri = m_grid->GetCellValue( row, col );
130 GetAssociatedDocument( m_dlg, datasheet_uri, &m_dlg->Prj(),
131 PROJECT_SCH::SchSearchS( &m_dlg->Prj() ), { m_files } );
132 }
133 else
134 {
135 // We have grid tricks events to show/hide the columns from the popup menu
136 // and we need to make sure the data model is updated to match the grid,
137 // so do it through our code instead
138 if( event.GetId() >= GRIDTRICKS_FIRST_SHOWHIDE )
139 {
140 // Pop-up column order is the order of the shown fields, not the
141 // fieldsCtrl order
142 col = event.GetId() - GRIDTRICKS_FIRST_SHOWHIDE;
143
144 bool show = !m_dataModel->GetShowColumn( col );
145
146 // Convert data model column to by iterating over m_fieldsCtrl rows
147 // and finding the matching field name
148 wxString fieldName = m_dataModel->GetColFieldName( col );
149
150 for( row = 0; row < m_fieldsCtrl->GetItemCount(); row++ )
151 {
152 if( m_fieldsCtrl->GetTextValue( row, FIELD_NAME_COLUMN ) == fieldName )
153 {
154 if( m_grid->CommitPendingChanges( false ) )
155 m_fieldsCtrl->SetToggleValue( show, row, SHOW_FIELD_COLUMN );
156
157 break;
158 }
159 }
160 }
161 else
162 {
163 GRID_TRICKS::doPopupSelection( event );
164 }
165 }
166 }
167
168private:
169 DIALOG_SHIM* m_dlg;
170 wxDataViewListCtrl* m_fieldsCtrl;
171 FIELDS_EDITOR_GRID_DATA_MODEL* m_dataModel;
172 EMBEDDED_FILES* m_files;
173};
174
175
176DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE( SCH_EDIT_FRAME* parent,
177 JOB_EXPORT_SCH_BOM* aJob ) :
178 DIALOG_SYMBOL_FIELDS_TABLE_BASE( parent ),
179 m_currentBomPreset( nullptr ),
180 m_lastSelectedBomPreset( nullptr ),
181 m_parent( parent ),
182 m_schSettings( parent->Schematic().Settings() ),
183 m_job( aJob )
184{
185 // Get all symbols from the list of schematic sheets
186 m_parent->Schematic().Hierarchy().GetSymbols( m_symbolsList, false );
187
188 m_bRefresh->SetBitmap( KiBitmapBundle( BITMAPS::small_refresh ) );
189 m_bRefreshPreview->SetBitmap( KiBitmapBundle( BITMAPS::small_refresh ) );
190 m_browseButton->SetBitmap( KiBitmapBundle( BITMAPS::small_folder ) );
191
192 m_addFieldButton->SetBitmap( KiBitmapBundle( BITMAPS::small_plus ) );
193 m_removeFieldButton->SetBitmap( KiBitmapBundle( BITMAPS::small_trash ) );
194 m_renameFieldButton->SetBitmap( KiBitmapBundle( BITMAPS::small_edit ) );
195
196 m_fieldsCtrl->AppendTextColumn( _( "Field" ), wxDATAVIEW_CELL_INERT, 0, wxALIGN_LEFT, 0 );
197 m_fieldsCtrl->AppendTextColumn( _( "Column Label" ), wxDATAVIEW_CELL_EDITABLE, 0, wxALIGN_LEFT, 0 );
198
199 // The two next columns look better when on 2 lines
200 // Unfortunately this is not handled on WXMSW
201#ifdef __WXMSW__
202 m_fieldsCtrl->AppendToggleColumn( _( "Show Column" ), wxDATAVIEW_CELL_ACTIVATABLE, 0, wxALIGN_CENTER, 0 );
203 m_fieldsCtrl->AppendToggleColumn( _( "Group By" ), wxDATAVIEW_CELL_ACTIVATABLE, 0, wxALIGN_CENTER, 0 );
204#else
205 m_fieldsCtrl->AppendToggleColumn( _( "Show\nColumn" ), wxDATAVIEW_CELL_ACTIVATABLE, 0, wxALIGN_CENTER, 0 );
206 m_fieldsCtrl->AppendToggleColumn( _( "Group\nBy" ), wxDATAVIEW_CELL_ACTIVATABLE, 0, wxALIGN_CENTER, 0 );
207#endif
208
209 // GTK asserts if the number of columns doesn't match the data, but we still don't want
210 // to display the canonical names. So we'll insert a column for them, but keep it 0 width.
211 m_fieldsCtrl->AppendTextColumn( _( "Name" ), wxDATAVIEW_CELL_INERT, 0, wxALIGN_LEFT, 0 );
212
213 // SetWidth( wxCOL_WIDTH_AUTOSIZE ) fails here on GTK, so we calculate the title sizes and
214 // set the column widths ourselves.
215 wxDataViewColumn* column = m_fieldsCtrl->GetColumn( SHOW_FIELD_COLUMN );
216#ifdef __WXMSW__
217 m_showColWidth = KIUI::GetTextSize( column->GetTitle(), m_fieldsCtrl ).x,
218#else
219 m_showColWidth = std::max( KIUI::GetTextSize( column->GetTitle().Before( '\n' ), m_fieldsCtrl ).x,
220 KIUI::GetTextSize( column->GetTitle().After( '\n' ), m_fieldsCtrl ).x );
221#endif
222 m_showColWidth += COLUMN_MARGIN;
223 column->SetMinWidth( m_showColWidth );
224
225 column = m_fieldsCtrl->GetColumn( GROUP_BY_COLUMN );
226#ifdef __WXMSW__
227 m_groupByColWidth = KIUI::GetTextSize( column->GetTitle(), m_fieldsCtrl ).x,
228#else
229 m_groupByColWidth = std::max( KIUI::GetTextSize( column->GetTitle().Before( '\n' ), m_fieldsCtrl ).x,
230 KIUI::GetTextSize( column->GetTitle().After( '\n' ), m_fieldsCtrl ).x );
231#endif
232 m_groupByColWidth += COLUMN_MARGIN;
233 column->SetMinWidth( m_groupByColWidth );
234
235 // The fact that we're a list should keep the control from reserving space for the
236 // expander buttons... but it doesn't. Fix by forcing the indent to 0.
237 m_fieldsCtrl->SetIndent( 0 );
238
239 m_filter->SetDescriptiveText( _( "Filter" ) );
240
241 wxGridCellAttr* attr = new wxGridCellAttr;
242 attr->SetEditor( new GRID_CELL_URL_EDITOR( this, PROJECT_SCH::SchSearchS( &Prj() ),
243 { &m_parent->Schematic() } ) );
244 m_dataModel = new FIELDS_EDITOR_GRID_DATA_MODEL( m_symbolsList, attr );
245
246 LoadFieldNames(); // loads rows into m_fieldsCtrl and columns into m_dataModel
247
248 // Now that the fields are loaded we can set the initial location of the splitter
249 // based on the list width. Again, SetWidth( wxCOL_WIDTH_AUTOSIZE ) fails us on GTK.
250 m_fieldNameColWidth = 0;
251 m_labelColWidth = 0;
252
253 for( int row = 0; row < m_fieldsCtrl->GetItemCount(); ++row )
254 {
255 const wxString& displayName = m_fieldsCtrl->GetTextValue( row, DISPLAY_NAME_COLUMN );
256 m_fieldNameColWidth = std::max( m_fieldNameColWidth, KIUI::GetTextSize( displayName, m_fieldsCtrl ).x );
257
258 const wxString& label = m_fieldsCtrl->GetTextValue( row, LABEL_COLUMN );
259 m_labelColWidth = std::max( m_labelColWidth, KIUI::GetTextSize( label, m_fieldsCtrl ).x );
260 }
261
262 int colWidth = std::max( m_fieldNameColWidth, m_labelColWidth ) + 30;
263
264 int fieldsMinWidth = colWidth + colWidth + m_groupByColWidth + m_showColWidth;
265
266 m_fieldsCtrl->GetColumn( DISPLAY_NAME_COLUMN )->SetWidth( m_fieldNameColWidth );
267 m_fieldsCtrl->GetColumn( LABEL_COLUMN )->SetWidth( m_labelColWidth );
268
269 // This is used for data only. Don't show it to the user.
270 m_fieldsCtrl->GetColumn( FIELD_NAME_COLUMN )->SetHidden( true );
271
272 m_splitterMainWindow->SetMinimumPaneSize( fieldsMinWidth );
273 m_splitterMainWindow->SetSashPosition( fieldsMinWidth + 40 );
274
275 m_grid->UseNativeColHeader( true );
276 m_grid->SetTable( m_dataModel, true );
277
278 // must be done after SetTable(), which appears to re-set it
279 m_grid->SetSelectionMode( wxGrid::wxGridSelectCells );
280
281 // add Cut, Copy, and Paste to wxGrid
282 m_grid->PushEventHandler( new FIELDS_EDITOR_GRID_TRICKS( this, m_grid, m_fieldsCtrl,
283 m_dataModel, &m_parent->Schematic() ) );
284
285 // Load our BOM view presets
286 SetUserBomPresets( m_schSettings.m_BomPresets );
287
288 BOM_PRESET preset = m_schSettings.m_BomSettings;
289
290 if( m_job )
291 {
292 SetTitle( m_job->GetSettingsDialogTitle() );
293
294 preset.name = m_job->m_bomPresetName;
295 preset.excludeDNP = m_job->m_excludeDNP;
296 preset.includeExcludedFromBOM = m_job->m_includeExcludedFromBOM;
297 preset.filterString = m_job->m_filterString;
298 preset.sortAsc = m_job->m_sortAsc;
299 preset.sortField = m_job->m_sortField;
300 preset.groupSymbols = ( m_job->m_fieldsGroupBy.size() > 0 );
301
302 preset.fieldsOrdered.clear();
303
304 size_t i = 0;
305
306 for( const wxString& fieldName : m_job->m_fieldsOrdered )
307 {
308 BOM_FIELD field;
309 field.name = fieldName;
310 field.show = !fieldName.StartsWith( wxT( "__" ), &field.name );
311 field.groupBy = alg::contains( m_job->m_fieldsGroupBy, field.name );
312
313 if( ( m_job->m_fieldsLabels.size() > i ) && !m_job->m_fieldsLabels[i].IsEmpty() )
314 field.label = m_job->m_fieldsLabels[i];
315 else if( IsGeneratedField( field.name ) )
316 field.label = GetGeneratedFieldDisplayName( field.name );
317 else
318 field.label = field.name;
319
320 preset.fieldsOrdered.emplace_back( field );
321 i++;
322 }
323 }
324
325 // DIALOG_SHIM needs a unique hash_key because classname will be the same for both job and
326 // non-job versions (which have different sizes).
327 m_hash_key = TO_UTF8( GetTitle() );
328
329 ApplyBomPreset( preset );
330 syncBomPresetSelection();
331
332 // Load BOM export format presets
333 SetUserBomFmtPresets( m_schSettings.m_BomFmtPresets );
334 BOM_FMT_PRESET fmtPreset = m_schSettings.m_BomFmtSettings;
335
336 if( m_job )
337 {
338 fmtPreset.name = m_job->m_bomFmtPresetName;
339 fmtPreset.fieldDelimiter = m_job->m_fieldDelimiter;
340 fmtPreset.keepLineBreaks = m_job->m_keepLineBreaks;
341 fmtPreset.keepTabs = m_job->m_keepTabs;
342 fmtPreset.refDelimiter = m_job->m_refDelimiter;
343 fmtPreset.refRangeDelimiter = m_job->m_refRangeDelimiter;
344 fmtPreset.stringDelimiter = m_job->m_stringDelimiter;
345 }
346
347 ApplyBomFmtPreset( fmtPreset );
348 syncBomFmtPresetSelection();
349
350 SetInitialFocus( m_grid );
351 m_grid->ClearSelection();
352
353 SetupStandardButtons();
354
355 finishDialogSettings();
356
357 EESCHEMA_SETTINGS* cfg = m_parent->eeconfig();
358 EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR& panelCfg = cfg->m_FieldEditorPanel;
359
360 wxSize dlgSize( panelCfg.width > 0 ? panelCfg.width : horizPixelsFromDU( 600 ),
361 panelCfg.height > 0 ? panelCfg.height : vertPixelsFromDU( 300 ) );
362 SetSize( dlgSize );
363
364 m_nbPages->SetSelection( cfg->m_FieldEditorPanel.page );
365
366 switch( cfg->m_FieldEditorPanel.selection_mode )
367 {
368 case 0: m_radioHighlight->SetValue( true ); break;
369 case 1: m_radioSelect->SetValue( true ); break;
370 case 2: m_radioOff->SetValue( true ); break;
371 }
372
373 switch( cfg->m_FieldEditorPanel.scope )
374 {
375 case SCOPE::SCOPE_ALL: m_radioProject->SetValue( true ); break;
376 case SCOPE::SCOPE_SHEET: m_radioCurrentSheet->SetValue( true ); break;
377 case SCOPE::SCOPE_SHEET_RECURSIVE: m_radioRecursive->SetValue( true ); break;
378 }
379
380 if( m_job )
381 m_outputFileName->SetValue( m_job->GetConfiguredOutputPath() );
382 else
383 m_outputFileName->SetValue( m_schSettings.m_BomExportFileName );
384
385 Center();
386
387 // Connect Events
388 m_grid->Connect( wxEVT_GRID_COL_SORT, wxGridEventHandler( DIALOG_SYMBOL_FIELDS_TABLE::OnColSort ),
389 nullptr, this );
390 m_grid->Connect( wxEVT_GRID_COL_MOVE, wxGridEventHandler( DIALOG_SYMBOL_FIELDS_TABLE::OnColMove ),
391 nullptr, this );
392 m_cbBomPresets->Bind( wxEVT_CHOICE, &DIALOG_SYMBOL_FIELDS_TABLE::onBomPresetChanged, this );
393 m_cbBomFmtPresets->Bind( wxEVT_CHOICE, &DIALOG_SYMBOL_FIELDS_TABLE::onBomFmtPresetChanged, this );
394 m_fieldsCtrl->Bind( wxEVT_DATAVIEW_ITEM_VALUE_CHANGED, &DIALOG_SYMBOL_FIELDS_TABLE::OnColLabelChange,
395 this );
396
397 if( !m_job )
398 {
399 // Start listening for schematic changes
400 m_parent->Schematic().AddListener( this );
401 }
402 else
403 {
404 // Don't allow editing
405 m_grid->EnableEditing( false );
406 m_buttonApply->Hide();
407 m_buttonExport->Hide();
408
409 SetupStandardButtons();
410 }
411}
412
413
414void DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties( int aCol )
415{
416 wxGridCellAttr* attr = new wxGridCellAttr;
417 attr->SetReadOnly( false );
418
419 // Set some column types to specific editors
420 if( m_dataModel->ColIsReference( aCol ) )
421 {
422 attr->SetReadOnly();
423 m_dataModel->SetColAttr( attr, aCol );
424 }
425 else if( m_dataModel->GetColFieldName( aCol ) == GetCanonicalFieldName( FIELD_T::FOOTPRINT ) )
426 {
427 attr->SetEditor( new GRID_CELL_FPID_EDITOR( this, wxEmptyString ) );
428 m_dataModel->SetColAttr( attr, aCol );
429 }
430 else if( m_dataModel->GetColFieldName( aCol ) == GetCanonicalFieldName( FIELD_T::DATASHEET ) )
431 {
432 // set datasheet column viewer button
433 attr->SetEditor( new GRID_CELL_URL_EDITOR( this, PROJECT_SCH::SchSearchS( &Prj() ),
434 { &m_parent->Schematic() } ) );
435 m_dataModel->SetColAttr( attr, aCol );
436 }
437 else if( m_dataModel->ColIsQuantity( aCol ) || m_dataModel->ColIsItemNumber( aCol ) )
438 {
439 attr->SetReadOnly();
440 attr->SetAlignment( wxALIGN_RIGHT, wxALIGN_CENTER );
441 attr->SetRenderer( new wxGridCellNumberRenderer() );
442 m_dataModel->SetColAttr( attr, aCol );
443 }
444 else if( m_dataModel->ColIsAttribute( aCol ) )
445 {
446 attr->SetAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
447 attr->SetRenderer( new GRID_CELL_CHECKBOX_RENDERER() );
448 attr->SetReadOnly(); // not really; we delegate interactivity to GRID_TRICKS
449 m_dataModel->SetColAttr( attr, aCol );
450 }
451 else if( IsGeneratedField( m_dataModel->GetColFieldName( aCol ) ) )
452 {
453 attr->SetReadOnly();
454 m_dataModel->SetColAttr( attr, aCol );
455 }
456 else
457 {
458 attr->SetEditor( m_grid->GetDefaultEditor() );
459 m_dataModel->SetColAttr( attr, aCol );
460 }
461}
462
463
464void DIALOG_SYMBOL_FIELDS_TABLE::SetupAllColumnProperties()
465{
466 EESCHEMA_SETTINGS* cfg = m_parent->eeconfig();
467 wxSize defaultDlgSize = ConvertDialogToPixels( wxSize( 600, 300 ) );
468
469 // Restore column sorting order and widths
470 m_grid->AutoSizeColumns( false );
471 int sortCol = 0;
472 bool sortAscending = true;
473
474 for( int col = 0; col < m_grid->GetNumberCols(); ++col )
475 {
476 SetupColumnProperties( col );
477
478 if( col == m_dataModel->GetSortCol() )
479 {
480 sortCol = col;
481 sortAscending = m_dataModel->GetSortAsc();
482 }
483 }
484
485 // sync m_grid's column visibilities to Show checkboxes in m_fieldsCtrl
486 for( int i = 0; i < m_fieldsCtrl->GetItemCount(); ++i )
487 {
488 int col = m_dataModel->GetFieldNameCol( m_fieldsCtrl->GetTextValue( i, FIELD_NAME_COLUMN ) );
489
490 if( col == -1 )
491 continue;
492
493 bool show = m_fieldsCtrl->GetToggleValue( i, SHOW_FIELD_COLUMN );
494 m_dataModel->SetShowColumn( col, show );
495
496 if( show )
497 {
498 m_grid->ShowCol( col );
499
500 std::string key( m_dataModel->GetColFieldName( col ).ToUTF8() );
501
502 if( cfg->m_FieldEditorPanel.field_widths.count( key )
503 && ( cfg->m_FieldEditorPanel.field_widths.at( key ) > 0 ) )
504 {
505 m_grid->SetColSize( col, cfg->m_FieldEditorPanel.field_widths.at( key ) );
506 }
507 else
508 {
509 int textWidth = m_dataModel->GetDataWidth( col ) + COLUMN_MARGIN;
510 int maxWidth = defaultDlgSize.x / 3;
511
512 m_grid->SetColSize( col, std::clamp( textWidth, 100, maxWidth ) );
513 }
514 }
515 else
516 {
517 m_grid->HideCol( col );
518 }
519 }
520
521 m_dataModel->SetSorting( sortCol, sortAscending );
522 m_grid->SetSortingColumn( sortCol, sortAscending );
523}
524
525
526DIALOG_SYMBOL_FIELDS_TABLE::~DIALOG_SYMBOL_FIELDS_TABLE()
527{
528 // Disconnect Events
529 m_grid->Disconnect( wxEVT_GRID_COL_SORT, wxGridEventHandler( DIALOG_SYMBOL_FIELDS_TABLE::OnColSort ),
530 nullptr, this );
531 m_grid->Disconnect( wxEVT_GRID_COL_SORT, wxGridEventHandler( DIALOG_SYMBOL_FIELDS_TABLE::OnColMove ),
532 nullptr, this );
533
534 // Delete the GRID_TRICKS.
535 m_grid->PopEventHandler( true );
536
537 // we gave ownership of m_dataModel to the wxGrid...
538}
539
540
541bool DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow()
542{
543 if( !wxDialog::TransferDataFromWindow() )
544 return false;
545
546 TOOL_MANAGER* toolMgr = m_parent->GetToolManager();
547 SCH_SELECTION_TOOL* selectionTool = toolMgr->GetTool<SCH_SELECTION_TOOL>();
548 SCH_SELECTION& selection = selectionTool->GetSelection();
549 SCH_SYMBOL* symbol = nullptr;
550
551 UpdateScope();
552
553 if( selection.GetSize() == 1 )
554 {
555 EDA_ITEM* item = selection.Front();
556
557 if( item->Type() == SCH_SYMBOL_T )
558 symbol = (SCH_SYMBOL*) item;
559 else if( item->GetParent() && item->GetParent()->Type() == SCH_SYMBOL_T )
560 symbol = (SCH_SYMBOL*) item->GetParent();
561 }
562
563 if( symbol )
564 {
565 for( int row = 0; row < m_dataModel->GetNumberRows(); ++row )
566 {
567 std::vector<SCH_REFERENCE> references = m_dataModel->GetRowReferences( row );
568 bool found = false;
569
570 for( const SCH_REFERENCE& ref : references )
571 {
572 if( ref.GetSymbol() == symbol )
573 {
574 found = true;
575 break;
576 }
577 }
578
579 if( found )
580 {
581 // Find the value column and the reference column if they're shown
582 int valueCol = -1;
583 int refCol = -1;
584 int anyCol = -1;
585
586 for( int col = 0; col < m_dataModel->GetNumberCols(); col++ )
587 {
588 if( m_dataModel->ColIsValue( col ) )
589 valueCol = col;
590 else if( m_dataModel->ColIsReference( col ) )
591 refCol = col;
592 else if( anyCol == -1 && m_dataModel->GetShowColumn( col ) )
593 anyCol = col;
594 }
595
596 if( valueCol != -1 && m_dataModel->GetShowColumn( valueCol ) )
597 m_grid->GoToCell( row, valueCol );
598 else if( refCol != -1 && m_dataModel->GetShowColumn( refCol ) )
599 m_grid->GoToCell( row, refCol );
600 else if( anyCol != -1 )
601 m_grid->GoToCell( row, anyCol );
602
603 break;
604 }
605 }
606 }
607
608 // We don't want table range selection events to happen until we've loaded the data or we
609 // we'll clear our selection as the grid is built before the code above can get the
610 // user's current selection.
611 EnableSelectionEvents();
612
613 return true;
614}
615
616
617bool DIALOG_SYMBOL_FIELDS_TABLE::TransferDataFromWindow()
618{
619 if( !m_grid->CommitPendingChanges() )
620 return false;
621
622 if( !wxDialog::TransferDataFromWindow() )
623 return false;
624
625 if( m_job )
626 {
627 // and exit, don't even dream of saving changes from the data model
628 return true;
629 }
630
631 SCH_COMMIT commit( m_parent );
632 SCH_SHEET_PATH currentSheet = m_parent->GetCurrentSheet();
633
634 m_dataModel->ApplyData( commit, m_schSettings.m_TemplateFieldNames );
635
636 commit.Push( wxS( "Symbol Fields Table Edit" ) );
637
638 // Reset the view to where we left the user
639 m_parent->SetCurrentSheet( currentSheet );
640 m_parent->SyncView();
641 m_parent->Refresh();
642
643 m_parent->OnModify();
644
645 return true;
646}
647
648
649void DIALOG_SYMBOL_FIELDS_TABLE::AddField( const wxString& aFieldName, const wxString& aLabelValue,
650 bool show, bool groupBy, bool addedByUser )
651{
652 // Users can add fields with variable names that match the special names in the grid,
653 // e.g. ${QUANTITY} so make sure we don't add them twice
654 for( int i = 0; i < m_fieldsCtrl->GetItemCount(); i++ )
655 {
656 if( m_fieldsCtrl->GetTextValue( i, FIELD_NAME_COLUMN ) == aFieldName )
657 return;
658 }
659
660 m_dataModel->AddColumn( aFieldName, aLabelValue, addedByUser );
661
662 wxVector<wxVariant> fieldsCtrlRow;
663 std::string key( aFieldName.ToUTF8() );
664
665 // Don't change these to emplace_back: some versions of wxWidgets don't support it
666 fieldsCtrlRow.push_back( wxVariant( aFieldName ) );
667 fieldsCtrlRow.push_back( wxVariant( aLabelValue ) );
668 fieldsCtrlRow.push_back( wxVariant( show ) );
669 fieldsCtrlRow.push_back( wxVariant( groupBy ) );
670 fieldsCtrlRow.push_back( wxVariant( aFieldName ) );
671
672 m_fieldsCtrl->AppendItem( fieldsCtrlRow );
673
674 wxGridTableMessage msg( m_dataModel, wxGRIDTABLE_NOTIFY_COLS_APPENDED, 1 );
675 m_grid->ProcessTableMessage( msg );
676}
677
678
679void DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames()
680{
681 auto addMandatoryField =
682 [&]( FIELD_T fieldId, bool show, bool groupBy )
683 {
684 m_mandatoryFieldListIndexes[fieldId] = m_fieldsCtrl->GetItemCount();
685
686 AddField( GetCanonicalFieldName( fieldId ),
687 GetDefaultFieldName( fieldId, DO_TRANSLATE ), show, groupBy );
688 };
689
690 // Add mandatory fields first show groupBy
691 addMandatoryField( FIELD_T::REFERENCE, true, true );
692 addMandatoryField( FIELD_T::VALUE, true, true );
693 addMandatoryField( FIELD_T::FOOTPRINT, true, true );
694 addMandatoryField( FIELD_T::DATASHEET, true, false );
695 addMandatoryField( FIELD_T::DESCRIPTION, false, false );
696
697 // Generated fields present only in the fields table
698 AddField( FIELDS_EDITOR_GRID_DATA_MODEL::QUANTITY_VARIABLE, _( "Qty" ), true, false );
699 AddField( FIELDS_EDITOR_GRID_DATA_MODEL::ITEM_NUMBER_VARIABLE, _( "#" ), true, false );
700
701 // User fields next
702 std::set<wxString> userFieldNames;
703
704 for( int ii = 0; ii < (int) m_symbolsList.GetCount(); ++ii )
705 {
706 SCH_SYMBOL* symbol = m_symbolsList[ii].GetSymbol();
707
708 for( const SCH_FIELD& field : symbol->GetFields() )
709 {
710 if( !field.IsMandatory() && !field.IsPrivate() )
711 userFieldNames.insert( field.GetName() );
712 }
713 }
714
715 for( const wxString& fieldName : userFieldNames )
716 AddField( fieldName, GetGeneratedFieldDisplayName( fieldName ), true, false );
717
718 // Add any templateFieldNames which aren't already present in the userFieldNames
719 for( const TEMPLATE_FIELDNAME& tfn : m_schSettings.m_TemplateFieldNames.GetTemplateFieldNames() )
720 {
721 if( userFieldNames.count( tfn.m_Name ) == 0 )
722 AddField( tfn.m_Name, GetGeneratedFieldDisplayName( tfn.m_Name ), false, false );
723 }
724}
725
726
727void DIALOG_SYMBOL_FIELDS_TABLE::OnAddField( wxCommandEvent& event )
728{
729 wxTextEntryDialog dlg( this, _( "New field name:" ), _( "Add Field" ) );
730
731 if( dlg.ShowModal() != wxID_OK )
732 return;
733
734 wxString fieldName = dlg.GetValue();
735
736 if( fieldName.IsEmpty() )
737 {
738 DisplayError( this, _( "Field must have a name." ) );
739 return;
740 }
741
742 for( int i = 0; i < m_dataModel->GetNumberCols(); ++i )
743 {
744 if( fieldName == m_dataModel->GetColFieldName( i ) )
745 {
746 DisplayError( this, wxString::Format( _( "Field name '%s' already in use." ), fieldName ) );
747 return;
748 }
749 }
750
751 AddField( fieldName, GetGeneratedFieldDisplayName( fieldName ), true, false, true );
752
753 SetupColumnProperties( m_dataModel->GetColsCount() - 1 );
754
755 syncBomPresetSelection();
756 OnModify();
757}
758
759
760void DIALOG_SYMBOL_FIELDS_TABLE::OnRemoveField( wxCommandEvent& event )
761{
762 int col = -1;
763 int row = m_fieldsCtrl->GetSelectedRow();
764
765 if( row == -1 )
766 {
767 wxBell();
768 return;
769 }
770
771 for( FIELD_T id : MANDATORY_FIELDS )
772 {
773 if( m_mandatoryFieldListIndexes[id] == row )
774 {
775 DisplayError( this, wxString::Format( _( "The first %d fields are mandatory." ),
776 (int) m_mandatoryFieldListIndexes.size() ) );
777 return;
778 }
779 }
780
781 wxString fieldName = m_fieldsCtrl->GetTextValue( row, FIELD_NAME_COLUMN );
782 wxString displayName = m_fieldsCtrl->GetTextValue( row, DISPLAY_NAME_COLUMN );
783
784 wxString confirm_msg = wxString::Format( _( "Are you sure you want to remove the field '%s'?" ),
785 displayName );
786
787 if( !IsOK( this, confirm_msg ) )
788 return;
789
790 for( int i = 0; i < m_dataModel->GetNumberCols(); ++i )
791 {
792 if( fieldName == m_dataModel->GetColFieldName( i ) )
793 col = i;
794 }
795
796 m_fieldsCtrl->DeleteItem( row );
797 m_dataModel->RemoveColumn( col );
798
799 // Make selection and update the state of "Remove field..." button via
800 // OnFieldsCtrlSelectionChanged().
801 // Safe to decrement row index because we always have mandatory fields.
802 m_fieldsCtrl->SelectRow( --row );
803
804 wxGridTableMessage msg( m_dataModel, wxGRIDTABLE_NOTIFY_COLS_DELETED, col, 1 );
805
806 m_grid->ProcessTableMessage( msg );
807
808 syncBomPresetSelection();
809 OnModify();
810}
811
812
813void DIALOG_SYMBOL_FIELDS_TABLE::OnRenameField( wxCommandEvent& event )
814{
815 int row = m_fieldsCtrl->GetSelectedRow();
816
817 if( row == -1 )
818 {
819 wxBell();
820 return;
821 }
822
823 for( FIELD_T id : MANDATORY_FIELDS )
824 {
825 if( m_mandatoryFieldListIndexes[id] == row )
826 {
827 DisplayError( this, wxString::Format( _( "The first %d fields are mandatory and names cannot be changed." ),
828 (int) m_mandatoryFieldListIndexes.size() ) );
829 return;
830 }
831 }
832
833 wxString fieldName = m_fieldsCtrl->GetTextValue( row, FIELD_NAME_COLUMN );
834
835 int col = m_dataModel->GetFieldNameCol( fieldName );
836 wxCHECK_RET( col != -1, wxS( "Existing field name missing from data model" ) );
837
838 wxTextEntryDialog dlg( this, _( "New field name:" ), _( "Rename Field" ), fieldName );
839
840 if( dlg.ShowModal() != wxID_OK )
841 return;
842
843 wxString newFieldName = dlg.GetValue();
844
845 // No change, no-op
846 if( newFieldName == fieldName )
847 return;
848
849 // New field name already exists
850 if( m_dataModel->GetFieldNameCol( newFieldName ) != -1 )
851 {
852 wxString confirm_msg = wxString::Format( _( "Field name %s already exists." ), newFieldName );
853 DisplayError( this, confirm_msg );
854 return;
855 }
856
857 m_dataModel->RenameColumn( col, newFieldName );
858 m_fieldsCtrl->SetTextValue( newFieldName, row, DISPLAY_NAME_COLUMN );
859 m_fieldsCtrl->SetTextValue( newFieldName, row, FIELD_NAME_COLUMN );
860 m_fieldsCtrl->SetTextValue( newFieldName, row, LABEL_COLUMN );
861
862 syncBomPresetSelection();
863 OnModify();
864}
865
866
867void DIALOG_SYMBOL_FIELDS_TABLE::OnFilterText( wxCommandEvent& aEvent )
868{
869 m_dataModel->SetFilter( m_filter->GetValue() );
870 m_dataModel->RebuildRows();
871 m_grid->ForceRefresh();
872
873 syncBomPresetSelection();
874}
875
876
877void DIALOG_SYMBOL_FIELDS_TABLE::OnFilterMouseMoved( wxMouseEvent& aEvent )
878{
879 wxPoint pos = aEvent.GetPosition();
880 wxRect ctrlRect = m_filter->GetScreenRect();
881 int buttonWidth = ctrlRect.GetHeight(); // Presume buttons are square
882
883 // TODO: restore cursor when mouse leaves the filter field (or is it a MSW bug?)
884 if( m_filter->IsSearchButtonVisible() && pos.x < buttonWidth )
885 SetCursor( wxCURSOR_ARROW );
886 else if( m_filter->IsCancelButtonVisible() && pos.x > ctrlRect.GetWidth() - buttonWidth )
887 SetCursor( wxCURSOR_ARROW );
888 else
889 SetCursor( wxCURSOR_IBEAM );
890}
891
892
893void DIALOG_SYMBOL_FIELDS_TABLE::OnColumnItemToggled( wxDataViewEvent& event )
894{
895 wxDataViewItem item = event.GetItem();
896 int row = m_fieldsCtrl->ItemToRow( item );
897 int col = event.GetColumn();
898
899 switch ( col )
900 {
901 case SHOW_FIELD_COLUMN:
902 {
903 wxString name = m_fieldsCtrl->GetTextValue( row, FIELD_NAME_COLUMN );
904 bool value = m_fieldsCtrl->GetToggleValue( row, col );
905 int dataCol = m_dataModel->GetFieldNameCol( name );
906
907 m_dataModel->SetShowColumn( dataCol, value );
908
909 if( dataCol != -1 )
910 {
911 if( value )
912 m_grid->ShowCol( dataCol );
913 else
914 m_grid->HideCol( dataCol );
915 }
916
917 break;
918 }
919
920 case GROUP_BY_COLUMN:
921 {
922 wxString name = m_fieldsCtrl->GetTextValue( row, FIELD_NAME_COLUMN );
923 bool value = m_fieldsCtrl->GetToggleValue( row, col );
924 int dataCol = m_dataModel->GetFieldNameCol( name );
925
926 if( m_dataModel->ColIsQuantity( dataCol ) && value )
927 {
928 DisplayError( this, _( "The Quantity column cannot be grouped by." ) );
929
930 value = false;
931 m_fieldsCtrl->SetToggleValue( value, row, col );
932 }
933
934 if( m_dataModel->ColIsItemNumber( dataCol ) && value )
935 {
936 DisplayError( this, _( "The Item Number column cannot be grouped by." ) );
937
938 value = false;
939 m_fieldsCtrl->SetToggleValue( value, row, col );
940 }
941
942 wxString fieldName = m_fieldsCtrl->GetTextValue( row, FIELD_NAME_COLUMN );
943
944 m_dataModel->SetGroupColumn( m_dataModel->GetFieldNameCol( fieldName ), value );
945 m_dataModel->RebuildRows();
946 m_grid->ForceRefresh();
947 break;
948 }
949
950 default:
951 break;
952 }
953
954 syncBomPresetSelection();
955}
956
957
958void DIALOG_SYMBOL_FIELDS_TABLE::OnGroupSymbolsToggled( wxCommandEvent& event )
959{
960 m_dataModel->SetGroupingEnabled( m_groupSymbolsBox->GetValue() );
961 m_dataModel->RebuildRows();
962 m_grid->ForceRefresh();
963
964 syncBomPresetSelection();
965}
966
967
968void DIALOG_SYMBOL_FIELDS_TABLE::OnExcludeDNPToggled( wxCommandEvent& event )
969{
970 m_dataModel->SetExcludeDNP( m_checkExcludeDNP->GetValue() );
971 m_dataModel->RebuildRows();
972 m_grid->ForceRefresh();
973
974 syncBomPresetSelection();
975}
976
977
978void DIALOG_SYMBOL_FIELDS_TABLE::OnShowExcludedToggled( wxCommandEvent& event )
979{
980 m_dataModel->SetIncludeExcludedFromBOM( m_checkShowExcluded->GetValue() );
981 m_dataModel->RebuildRows();
982 m_grid->ForceRefresh();
983
984 syncBomPresetSelection();
985}
986
987
988void DIALOG_SYMBOL_FIELDS_TABLE::OnColSort( wxGridEvent& aEvent )
989{
990 int sortCol = aEvent.GetCol();
991 std::string key( m_dataModel->GetColFieldName( sortCol ).ToUTF8() );
992 bool ascending;
993
994 // Don't sort by item number, it is generated by the sort
995 if( m_dataModel->ColIsItemNumber( sortCol ) )
996 {
997 aEvent.Veto();
998 return;
999 }
1000
1001 // This is bonkers, but wxWidgets doesn't tell us ascending/descending in the event, and
1002 // if we ask it will give us pre-event info.
1003 if( m_grid->IsSortingBy( sortCol ) )
1004 {
1005 // same column; invert ascending
1006 ascending = !m_grid->IsSortOrderAscending();
1007 }
1008 else
1009 {
1010 // different column; start with ascending
1011 ascending = true;
1012 }
1013
1014 m_dataModel->SetSorting( sortCol, ascending );
1015 m_dataModel->RebuildRows();
1016 m_grid->ForceRefresh();
1017
1018 syncBomPresetSelection();
1019}
1020
1021
1022void DIALOG_SYMBOL_FIELDS_TABLE::OnColMove( wxGridEvent& aEvent )
1023{
1024 int origPos = aEvent.GetCol();
1025
1026 // Save column widths since the setup function uses the saved config values
1027 EESCHEMA_SETTINGS* cfg = m_parent->eeconfig();
1028
1029 for( int i = 0; i < m_grid->GetNumberCols(); i++ )
1030 {
1031 if( m_grid->IsColShown( i ) )
1032 {
1033 std::string fieldName( m_dataModel->GetColFieldName( i ).ToUTF8() );
1034 cfg->m_FieldEditorPanel.field_widths[fieldName] = m_grid->GetColSize( i );
1035 }
1036 }
1037
1038 CallAfter(
1039 [origPos, this]()
1040 {
1041 int newPos = m_grid->GetColPos( origPos );
1042
1043#ifdef __WXMAC__
1044 if( newPos < origPos )
1045 newPos += 1;
1046#endif
1047
1048 m_dataModel->MoveColumn( origPos, newPos );
1049
1050 // "Unmove" the column since we've moved the column internally
1051 m_grid->ResetColPos();
1052
1053 // We need to reset all the column attr's to the correct column order
1054 SetupAllColumnProperties();
1055
1056 m_grid->ForceRefresh();
1057 } );
1058
1059 syncBomPresetSelection();
1060}
1061
1062
1063void DIALOG_SYMBOL_FIELDS_TABLE::OnColLabelChange( wxDataViewEvent& aEvent )
1064{
1065 wxDataViewItem item = aEvent.GetItem();
1066 int row = m_fieldsCtrl->ItemToRow( item );
1067 wxString label = m_fieldsCtrl->GetTextValue( row, LABEL_COLUMN );
1068 wxString fieldName = m_fieldsCtrl->GetTextValue( row, FIELD_NAME_COLUMN );
1069 int col = m_dataModel->GetFieldNameCol( fieldName );
1070
1071 if( col != -1 )
1072 {
1073 m_dataModel->SetColLabelValue( col, label );
1074 m_grid->SetColLabelValue( col, label );
1075 }
1076
1077 syncBomPresetSelection();
1078
1079 aEvent.Skip();
1080
1081 m_grid->ForceRefresh();
1082}
1083
1084
1085void DIALOG_SYMBOL_FIELDS_TABLE::OnTableValueChanged( wxGridEvent& aEvent )
1086{
1087 m_grid->ForceRefresh();
1088 OnModify();
1089}
1090
1091
1092void DIALOG_SYMBOL_FIELDS_TABLE::OnTableColSize( wxGridSizeEvent& aEvent )
1093{
1094 int col = aEvent.GetRowOrCol();
1095 std::string key( m_dataModel->GetColFieldName( col ).ToUTF8() );
1096
1097 aEvent.Skip();
1098
1099 m_grid->ForceRefresh();
1100}
1101
1102
1103void DIALOG_SYMBOL_FIELDS_TABLE::OnRegroupSymbols( wxCommandEvent& aEvent )
1104{
1105 m_dataModel->RebuildRows();
1106 m_grid->ForceRefresh();
1107}
1108
1109
1110void DIALOG_SYMBOL_FIELDS_TABLE::OnScopeChanged( wxCommandEvent& aEvent )
1111{
1112 UpdateScope();
1113}
1114
1115
1116void DIALOG_SYMBOL_FIELDS_TABLE::UpdateScope()
1117{
1118 m_dataModel->SetPath( m_parent->GetCurrentSheet() );
1119
1120 if( m_radioProject->GetValue() )
1121 m_dataModel->SetScope( FIELDS_EDITOR_GRID_DATA_MODEL::SCOPE::SCOPE_ALL );
1122 else if( m_radioCurrentSheet->GetValue() )
1123 m_dataModel->SetScope( FIELDS_EDITOR_GRID_DATA_MODEL::SCOPE::SCOPE_SHEET );
1124 else if( m_radioRecursive->GetValue() )
1125 m_dataModel->SetScope( FIELDS_EDITOR_GRID_DATA_MODEL::SCOPE::SCOPE_SHEET_RECURSIVE );
1126
1127 m_dataModel->RebuildRows();
1128}
1129
1130
1131void DIALOG_SYMBOL_FIELDS_TABLE::OnTableCellClick( wxGridEvent& event )
1132{
1133 if( m_dataModel->ColIsReference( event.GetCol() ) )
1134 {
1135 m_grid->ClearSelection();
1136
1137 m_dataModel->ExpandCollapseRow( event.GetRow() );
1138 m_grid->SetGridCursor( event.GetRow(), event.GetCol() );
1139 }
1140 else
1141 {
1142 event.Skip();
1143 }
1144}
1145
1146
1147void DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected( wxGridRangeSelectEvent& aEvent )
1148{
1149 // Cross-probing should only work in Edit page
1150 if( m_nbPages->GetSelection() != 0 )
1151 return;
1152
1153 // Multi-select can grab the rows that are expanded child refs, and also the row
1154 // containing the list of all child refs. Make sure we add refs/symbols uniquely
1155 std::set<SCH_REFERENCE> refs;
1156 std::set<SCH_ITEM*> symbols;
1157
1158 // This handler handles selecting and deselecting
1159 if( aEvent.Selecting() )
1160 {
1161 for( int i = aEvent.GetTopRow(); i <= aEvent.GetBottomRow(); i++ )
1162 {
1163 for( const SCH_REFERENCE& ref : m_dataModel->GetRowReferences( i ) )
1164 refs.insert( ref );
1165 }
1166
1167 for( const SCH_REFERENCE& ref : refs )
1168 symbols.insert( ref.GetSymbol() );
1169 }
1170
1171 if( m_radioHighlight->GetValue() )
1172 {
1173 SCH_EDITOR_CONTROL* editor = m_parent->GetToolManager()->GetTool<SCH_EDITOR_CONTROL>();
1174
1175 if( refs.size() > 0 )
1176 {
1177 // Use of full path based on UUID allows select of not yet annotated or duplicated
1178 // symbols
1179 wxString symbol_path = refs.begin()->GetFullPath();
1180
1181 // Focus only handles one item at this time
1182 editor->FindSymbolAndItem( &symbol_path, nullptr, true, HIGHLIGHT_SYMBOL,
1183 wxEmptyString );
1184 }
1185 else
1186 {
1187 m_parent->ClearFocus();
1188 }
1189 }
1190 else if( m_radioSelect->GetValue() )
1191 {
1192 SCH_SELECTION_TOOL* selTool = m_parent->GetToolManager()->GetTool<SCH_SELECTION_TOOL>();
1193 std::vector<SCH_ITEM*> items( symbols.begin(), symbols.end() );
1194
1195 if( refs.size() > 0 )
1196 selTool->SyncSelection( refs.begin()->GetSheetPath(), nullptr, items );
1197 else
1198 selTool->ClearSelection();
1199 }
1200}
1201
1202
1203void DIALOG_SYMBOL_FIELDS_TABLE::OnTableItemContextMenu( wxGridEvent& event )
1204{
1205 // TODO: Option to select footprint if FOOTPRINT column selected
1206
1207 event.Skip();
1208}
1209
1210
1211void DIALOG_SYMBOL_FIELDS_TABLE::OnSizeFieldList( wxSizeEvent& event )
1212{
1213 int width = KIPLATFORM::UI::GetUnobscuredSize( m_fieldsCtrl ).x - m_showColWidth - m_groupByColWidth;
1214
1215#ifdef __WXMAC__
1216 // TODO: something in wxWidgets 3.1.x pads checkbox columns with extra space. (It used to
1217 // also be that the width of the column would get set too wide (to 30), but that's patched in
1218 // our local wxWidgets fork.)
1219 width -= 50;
1220#endif
1221
1222 m_fieldNameColWidth = width / 2;
1223 m_labelColWidth = width = m_fieldNameColWidth;
1224
1225 // GTK loses its head and messes these up when resizing the splitter bar:
1226 m_fieldsCtrl->GetColumn( SHOW_FIELD_COLUMN )->SetWidth( m_showColWidth );
1227 m_fieldsCtrl->GetColumn( GROUP_BY_COLUMN )->SetWidth( m_groupByColWidth );
1228
1229 m_fieldsCtrl->GetColumn( FIELD_NAME_COLUMN )->SetHidden( true );
1230 m_fieldsCtrl->GetColumn( DISPLAY_NAME_COLUMN )->SetWidth( m_fieldNameColWidth );
1231 m_fieldsCtrl->GetColumn( LABEL_COLUMN )->SetWidth( m_labelColWidth );
1232
1233 m_fieldsCtrl->Refresh(); // To refresh checkboxes on Windows.
1234
1235 event.Skip();
1236}
1237
1238
1239void DIALOG_SYMBOL_FIELDS_TABLE::OnSaveAndContinue( wxCommandEvent& aEvent )
1240{
1241 if( TransferDataFromWindow() )
1242 {
1243 m_parent->SaveProject();
1244 ClearModify();
1245 }
1246}
1247
1248
1249void DIALOG_SYMBOL_FIELDS_TABLE::OnPageChanged( wxNotebookEvent& event )
1250{
1251 PreviewRefresh();
1252}
1253
1254
1255void DIALOG_SYMBOL_FIELDS_TABLE::OnPreviewRefresh( wxCommandEvent& event )
1256{
1257 PreviewRefresh();
1258 syncBomFmtPresetSelection();
1259}
1260
1261
1262void DIALOG_SYMBOL_FIELDS_TABLE::PreviewRefresh()
1263{
1264 m_dataModel->RebuildRows();
1265 m_textOutput->SetValue( m_dataModel->Export( GetCurrentBomFmtSettings() ) );
1266}
1267
1268
1269BOM_FMT_PRESET DIALOG_SYMBOL_FIELDS_TABLE::GetCurrentBomFmtSettings()
1270{
1271 BOM_FMT_PRESET current;
1272
1273 current.name = m_cbBomFmtPresets->GetStringSelection();
1274 current.fieldDelimiter = m_textFieldDelimiter->GetValue();
1275 current.stringDelimiter = m_textStringDelimiter->GetValue();
1276 current.refDelimiter = m_textRefDelimiter->GetValue();
1277 current.refRangeDelimiter = m_textRefRangeDelimiter->GetValue();
1278 current.keepTabs = m_checkKeepTabs->GetValue();
1279 current.keepLineBreaks = m_checkKeepLineBreaks->GetValue();
1280
1281 return current;
1282}
1283
1284
1285void DIALOG_SYMBOL_FIELDS_TABLE::ShowEditTab()
1286{
1287 m_nbPages->SetSelection( 0 );
1288}
1289
1290
1291void DIALOG_SYMBOL_FIELDS_TABLE::ShowExportTab()
1292{
1293 m_nbPages->SetSelection( 1 );
1294}
1295
1296
1297void DIALOG_SYMBOL_FIELDS_TABLE::OnOutputFileBrowseClicked( wxCommandEvent& event )
1298{
1299 // Build the absolute path of current output directory to preselect it in the file browser.
1300 wxString path = ExpandEnvVarSubstitutions( m_outputFileName->GetValue(), &Prj() );
1301 path = Prj().AbsolutePath( path );
1302
1303
1304 // Calculate the export filename
1305 wxFileName fn( Prj().AbsolutePath( m_parent->Schematic().GetFileName() ) );
1306 fn.SetExt( FILEEXT::CsvFileExtension );
1307
1308 wxFileDialog saveDlg( this, _( "Bill of Materials Output File" ), path, fn.GetFullName(),
1309 FILEEXT::CsvFileWildcard(), wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
1310
1311 if( saveDlg.ShowModal() == wxID_CANCEL )
1312 return;
1313
1314
1315 wxFileName file = wxFileName( saveDlg.GetPath() );
1316 wxString defaultPath = fn.GetPathWithSep();
1317
1318 if( IsOK( this, wxString::Format( _( "Do you want to use a path relative to\n'%s'?" ), defaultPath ) ) )
1319 {
1320 if( !file.MakeRelativeTo( defaultPath ) )
1321 {
1322 DisplayErrorMessage( this, _( "Cannot make path relative (target volume different from schematic "
1323 "file volume)!" ) );
1324 }
1325 }
1326
1327 m_outputFileName->SetValue( file.GetFullPath() );
1328}
1329
1330
1331void DIALOG_SYMBOL_FIELDS_TABLE::OnExport( wxCommandEvent& aEvent )
1332{
1333 if( m_dataModel->IsEdited() )
1334 {
1335 if( OKOrCancelDialog( nullptr, _( "Unsaved data" ),
1336 _( "Changes have not yet been saved. Export unsaved data?" ), "",
1337 _( "OK" ), _( "Cancel" ) )
1338 == wxID_CANCEL )
1339 {
1340 return;
1341 }
1342 }
1343
1344 // Create output directory if it does not exist (also transform it in absolute form).
1345 // Bail if it fails.
1346
1347 std::function<bool( wxString* )> textResolver =
1348 [&]( wxString* token ) -> bool
1349 {
1350 SCHEMATIC& schematic = m_parent->Schematic();
1351
1352 // Handles m_board->GetTitleBlock() *and* m_board->GetProject()
1353 return schematic.ResolveTextVar( &schematic.CurrentSheet(), token, 0 );
1354 };
1355
1356 wxString path = m_outputFileName->GetValue();
1357
1358 if( path.IsEmpty() )
1359 {
1360 DisplayError( this, _( "No output file specified in Export tab." ) );
1361 return;
1362 }
1363
1364 path = ExpandTextVars( path, &textResolver );
1365 path = ExpandEnvVarSubstitutions( path, nullptr );
1366
1367 wxFileName outputFile = wxFileName::FileName( path );
1368 wxString msg;
1369
1370 if( !EnsureFileDirectoryExists( &outputFile,
1371 Prj().AbsolutePath( m_parent->Schematic().GetFileName() ),
1372 &NULL_REPORTER::GetInstance() ) )
1373 {
1374 msg.Printf( _( "Could not open/create path '%s'." ), outputFile.GetPath() );
1375 DisplayError( this, msg );
1376 return;
1377 }
1378
1379 wxFFile out( outputFile.GetFullPath(), "wb" );
1380
1381 if( !out.IsOpened() )
1382 {
1383 msg.Printf( _( "Could not create BOM output '%s'." ), outputFile.GetFullPath() );
1384 DisplayError( this, msg );
1385 return;
1386 }
1387
1388 PreviewRefresh();
1389
1390 if( !out.Write( m_textOutput->GetValue() ) )
1391 {
1392 msg.Printf( _( "Could not write BOM output '%s'." ), outputFile.GetFullPath() );
1393 DisplayError( this, msg );
1394 return;
1395 }
1396
1397 // close the file before we tell the user it's done with the info modal :workflow meme:
1398 out.Close();
1399 msg.Printf( _( "Wrote BOM output to '%s'" ), outputFile.GetFullPath() );
1400 DisplayInfoMessage( this, msg );
1401}
1402
1403
1404void DIALOG_SYMBOL_FIELDS_TABLE::OnCancel( wxCommandEvent& aEvent )
1405{
1406 if( m_job )
1407 EndModal( wxID_CANCEL );
1408 else
1409 Close();
1410}
1411
1412
1413void DIALOG_SYMBOL_FIELDS_TABLE::OnOk( wxCommandEvent& aEvent )
1414{
1415 TransferDataFromWindow();
1416
1417 if( m_job )
1418 {
1419 m_job->SetConfiguredOutputPath( m_outputFileName->GetValue() );
1420
1421 if( m_currentBomFmtPreset )
1422 m_job->m_bomFmtPresetName = m_currentBomFmtPreset->name;
1423 else
1424 m_job->m_bomFmtPresetName = wxEmptyString;
1425
1426 if( m_currentBomPreset )
1427 m_job->m_bomPresetName = m_currentBomPreset->name;
1428 else
1429 m_job->m_bomPresetName = wxEmptyString;
1430
1431 BOM_FMT_PRESET fmtSettings = GetCurrentBomFmtSettings();
1432 m_job->m_fieldDelimiter = fmtSettings.fieldDelimiter;
1433 m_job->m_stringDelimiter = fmtSettings.stringDelimiter;
1434 m_job->m_refDelimiter = fmtSettings.refDelimiter;
1435 m_job->m_refRangeDelimiter = fmtSettings.refRangeDelimiter;
1436 m_job->m_keepTabs = fmtSettings.keepTabs;
1437 m_job->m_keepLineBreaks = fmtSettings.keepLineBreaks;
1438
1439 BOM_PRESET presetFields = m_dataModel->GetBomSettings();
1440 m_job->m_sortAsc = presetFields.sortAsc;
1441 m_job->m_excludeDNP = presetFields.excludeDNP;
1442 m_job->m_includeExcludedFromBOM = presetFields.includeExcludedFromBOM;
1443 m_job->m_filterString = presetFields.filterString;
1444 m_job->m_sortField = presetFields.sortField;
1445
1446 m_job->m_fieldsOrdered.clear();
1447 m_job->m_fieldsLabels.clear();
1448 m_job->m_fieldsGroupBy.clear();
1449
1450 for( const BOM_FIELD& modelField : m_dataModel->GetFieldsOrdered() )
1451 {
1452 if( modelField.show )
1453 m_job->m_fieldsOrdered.emplace_back( modelField.name );
1454 else
1455 m_job->m_fieldsOrdered.emplace_back( wxT( "__" ) + modelField.name );
1456
1457 m_job->m_fieldsLabels.emplace_back( modelField.label );
1458
1459 if( modelField.groupBy )
1460 m_job->m_fieldsGroupBy.emplace_back( modelField.name );
1461 }
1462
1463 EndModal( wxID_OK );
1464 }
1465 else
1466 {
1467 Close();
1468 }
1469}
1470
1471
1472void DIALOG_SYMBOL_FIELDS_TABLE::OnClose( wxCloseEvent& aEvent )
1473{
1474 if( m_job )
1475 {
1476 aEvent.Skip();
1477 return;
1478 }
1479
1480 // This is a cancel, so commit quietly as we're going to throw the results away anyway.
1481 m_grid->CommitPendingChanges( true );
1482
1483 if( m_dataModel->IsEdited() && aEvent.CanVeto() )
1484 {
1485 if( !HandleUnsavedChanges( this, _( "Save changes?" ),
1486 [&]() -> bool
1487 {
1488 return TransferDataFromWindow();
1489 } ) )
1490 {
1491 aEvent.Veto();
1492 return;
1493 }
1494 }
1495
1496 // Stop listening to schematic events
1497 m_parent->Schematic().RemoveListener( this );
1498
1499 // Save all our settings since we're really closing
1500 savePresetsToSchematic();
1501 m_schSettings.m_BomExportFileName = m_outputFileName->GetValue();
1502
1503 EESCHEMA_SETTINGS* cfg = m_parent->eeconfig();
1504
1505 cfg->m_FieldEditorPanel.width = GetSize().x;
1506 cfg->m_FieldEditorPanel.height = GetSize().y;
1507 cfg->m_FieldEditorPanel.page = m_nbPages->GetSelection();
1508
1509 if( m_radioHighlight->GetValue() )
1510 cfg->m_FieldEditorPanel.selection_mode = 0;
1511 else if( m_radioSelect->GetValue() )
1512 cfg->m_FieldEditorPanel.selection_mode = 1;
1513 else if( m_radioOff->GetValue() )
1514 cfg->m_FieldEditorPanel.selection_mode = 2;
1515
1516 if( m_radioProject->GetValue() )
1517 cfg->m_FieldEditorPanel.scope = SCOPE::SCOPE_ALL;
1518 else if( m_radioCurrentSheet->GetValue() )
1519 cfg->m_FieldEditorPanel.scope = SCOPE::SCOPE_SHEET;
1520 else if( m_radioRecursive->GetValue() )
1521 cfg->m_FieldEditorPanel.scope = SCOPE::SCOPE_SHEET_RECURSIVE;
1522
1523 for( int i = 0; i < m_grid->GetNumberCols(); i++ )
1524 {
1525 if( m_grid->IsColShown( i ) )
1526 {
1527 std::string fieldName( m_dataModel->GetColFieldName( i ).ToUTF8() );
1528 cfg->m_FieldEditorPanel.field_widths[fieldName] = m_grid->GetColSize( i );
1529 }
1530 }
1531
1532 m_parent->ClearFocus();
1533
1534 wxCommandEvent* evt = new wxCommandEvent( EDA_EVT_CLOSE_DIALOG_SYMBOL_FIELDS_TABLE, wxID_ANY );
1535
1536 if( wxWindow* parent = GetParent() )
1537 wxQueueEvent( parent, evt );
1538}
1539
1540
1541std::vector<BOM_PRESET> DIALOG_SYMBOL_FIELDS_TABLE::GetUserBomPresets() const
1542{
1543 std::vector<BOM_PRESET> ret;
1544
1545 for( const std::pair<const wxString, BOM_PRESET>& pair : m_bomPresets )
1546 {
1547 if( !pair.second.readOnly )
1548 ret.emplace_back( pair.second );
1549 }
1550
1551 return ret;
1552}
1553
1554
1555void DIALOG_SYMBOL_FIELDS_TABLE::SetUserBomPresets( std::vector<BOM_PRESET>& aPresetList )
1556{
1557 // Reset to defaults
1558 loadDefaultBomPresets();
1559
1560 for( const BOM_PRESET& preset : aPresetList )
1561 {
1562 if( m_bomPresets.count( preset.name ) )
1563 continue;
1564
1565 m_bomPresets[preset.name] = preset;
1566
1567 m_bomPresetMRU.Add( preset.name );
1568 }
1569
1570 rebuildBomPresetsWidget();
1571}
1572
1573
1574void DIALOG_SYMBOL_FIELDS_TABLE::ApplyBomPreset( const wxString& aPresetName )
1575{
1576 updateBomPresetSelection( aPresetName );
1577
1578 wxCommandEvent dummy;
1579 onBomPresetChanged( dummy );
1580}
1581
1582
1583void DIALOG_SYMBOL_FIELDS_TABLE::ApplyBomPreset( const BOM_PRESET& aPreset )
1584{
1585 if( m_bomPresets.count( aPreset.name ) )
1586 m_currentBomPreset = &m_bomPresets[aPreset.name];
1587 else
1588 m_currentBomPreset = nullptr;
1589
1590 if( m_currentBomPreset && !m_currentBomPreset->readOnly )
1591 m_lastSelectedBomPreset = m_currentBomPreset;
1592 else
1593 m_lastSelectedBomPreset = nullptr;
1594
1595 updateBomPresetSelection( aPreset.name );
1596 doApplyBomPreset( aPreset );
1597}
1598
1599
1600void DIALOG_SYMBOL_FIELDS_TABLE::loadDefaultBomPresets()
1601{
1602 m_bomPresets.clear();
1603 m_bomPresetMRU.clear();
1604
1605 // Load the read-only defaults
1606 for( const BOM_PRESET& preset : BOM_PRESET::BuiltInPresets() )
1607 {
1608 m_bomPresets[preset.name] = preset;
1609 m_bomPresets[preset.name].readOnly = true;
1610
1611 m_bomPresetMRU.Add( preset.name );
1612 }
1613}
1614
1615
1616void DIALOG_SYMBOL_FIELDS_TABLE::rebuildBomPresetsWidget()
1617{
1618 m_cbBomPresets->Clear();
1619
1620 // Build the layers preset list.
1621 // By default, the presetAllLayers will be selected
1622 int idx = 0;
1623 int default_idx = 0;
1624
1625 for( std::pair<const wxString, BOM_PRESET>& pair : m_bomPresets )
1626 {
1627 m_cbBomPresets->Append( wxGetTranslation( pair.first ),
1628 static_cast<void*>( &pair.second ) );
1629
1630 if( pair.first == BOM_PRESET::DefaultEditing().name )
1631 default_idx = idx;
1632
1633 idx++;
1634 }
1635
1636 m_cbBomPresets->Append( wxT( "---" ) );
1637 m_cbBomPresets->Append( _( "Save preset..." ) );
1638 m_cbBomPresets->Append( _( "Delete preset..." ) );
1639
1640 // At least the built-in presets should always be present
1641 wxASSERT( !m_bomPresets.empty() );
1642
1643 // Default preset: all Boms
1644 m_cbBomPresets->SetSelection( default_idx );
1645 m_currentBomPreset = static_cast<BOM_PRESET*>( m_cbBomPresets->GetClientData( default_idx ) );
1646}
1647
1648
1649void DIALOG_SYMBOL_FIELDS_TABLE::syncBomPresetSelection()
1650{
1651 BOM_PRESET current = m_dataModel->GetBomSettings();
1652
1653 auto it = std::find_if( m_bomPresets.begin(), m_bomPresets.end(),
1654 [&]( const std::pair<const wxString, BOM_PRESET>& aPair )
1655 {
1656 const BOM_PRESET& preset = aPair.second;
1657
1658 // Check the simple settings first
1659 if( !( preset.sortAsc == current.sortAsc
1660 && preset.filterString == current.filterString
1661 && preset.groupSymbols == current.groupSymbols
1662 && preset.excludeDNP == current.excludeDNP
1663 && preset.includeExcludedFromBOM == current.includeExcludedFromBOM ) )
1664 {
1665 return false;
1666 }
1667
1668 // We should compare preset.name and current.name. Unfortunately current.name is
1669 // empty because m_dataModel->GetBomSettings() does not store the .name member.
1670 // So use sortField member as a (not very efficient) auxiliary filter.
1671 // As a further complication, sortField can be translated in m_bomPresets list, so
1672 // current.sortField needs to be translated.
1673 // Probably this not efficient and error prone test should be removed (JPC).
1674 if( preset.sortField != wxGetTranslation( current.sortField ) )
1675 return false;
1676
1677 // Only compare shown or grouped fields
1678 std::vector<BOM_FIELD> A, B;
1679
1680 for( const BOM_FIELD& field : preset.fieldsOrdered )
1681 {
1682 if( field.show || field.groupBy )
1683 A.emplace_back( field );
1684 }
1685
1686 for( const BOM_FIELD& field : current.fieldsOrdered )
1687 {
1688 if( field.show || field.groupBy )
1689 B.emplace_back( field );
1690 }
1691
1692 return A == B;
1693 } );
1694
1695 if( it != m_bomPresets.end() )
1696 {
1697 // Select the right m_cbBomPresets item.
1698 // but these items are translated if they are predefined items.
1699 bool do_translate = it->second.readOnly;
1700 wxString text = do_translate ? wxGetTranslation( it->first ) : it->first;
1701 m_cbBomPresets->SetStringSelection( text );
1702 }
1703 else
1704 {
1705 m_cbBomPresets->SetSelection( m_cbBomPresets->GetCount() - 3 ); // separator
1706 }
1707
1708 m_currentBomPreset = static_cast<BOM_PRESET*>( m_cbBomPresets->GetClientData( m_cbBomPresets->GetSelection() ) );
1709}
1710
1711
1712void DIALOG_SYMBOL_FIELDS_TABLE::updateBomPresetSelection( const wxString& aName )
1713{
1714 // Look at m_userBomPresets to know if aName is a read only preset, or a user preset.
1715 // Read-only presets have translated names in UI, so we have to use a translated name
1716 // in UI selection. But for a user preset name we search for the untranslated aName.
1717 wxString ui_label = aName;
1718
1719 for( std::pair<const wxString, BOM_PRESET>& pair : m_bomPresets )
1720 {
1721 if( pair.first != aName )
1722 continue;
1723
1724 if( pair.second.readOnly == true )
1725 ui_label = wxGetTranslation( aName );
1726
1727 break;
1728 }
1729
1730 int idx = m_cbBomPresets->FindString( ui_label );
1731
1732 if( idx >= 0 && m_cbBomPresets->GetSelection() != idx )
1733 {
1734 m_cbBomPresets->SetSelection( idx );
1735 m_currentBomPreset = static_cast<BOM_PRESET*>( m_cbBomPresets->GetClientData( idx ) );
1736 }
1737 else if( idx < 0 )
1738 {
1739 m_cbBomPresets->SetSelection( m_cbBomPresets->GetCount() - 3 ); // separator
1740 }
1741}
1742
1743
1744void DIALOG_SYMBOL_FIELDS_TABLE::onBomPresetChanged( wxCommandEvent& aEvent )
1745{
1746 int count = m_cbBomPresets->GetCount();
1747 int index = m_cbBomPresets->GetSelection();
1748
1749 auto resetSelection =
1750 [&]()
1751 {
1752 if( m_currentBomPreset )
1753 m_cbBomPresets->SetStringSelection( m_currentBomPreset->name );
1754 else
1755 m_cbBomPresets->SetSelection( m_cbBomPresets->GetCount() - 3 );
1756 };
1757
1758 if( index == count - 3 )
1759 {
1760 // Separator: reject the selection
1761 resetSelection();
1762 return;
1763 }
1764 else if( index == count - 2 )
1765 {
1766 // Save current state to new preset
1767 wxString name;
1768
1769 if( m_lastSelectedBomPreset )
1770 name = m_lastSelectedBomPreset->name;
1771
1772 wxTextEntryDialog dlg( this, _( "BOM preset name:" ), _( "Save BOM Preset" ), name );
1773
1774 if( dlg.ShowModal() != wxID_OK )
1775 {
1776 resetSelection();
1777 return;
1778 }
1779
1780 name = dlg.GetValue();
1781 bool exists = m_bomPresets.count( name );
1782
1783 if( !exists )
1784 {
1785 m_bomPresets[name] = m_dataModel->GetBomSettings();
1786 m_bomPresets[name].readOnly = false;
1787 m_bomPresets[name].name = name;
1788 }
1789
1790 BOM_PRESET* preset = &m_bomPresets[name];
1791
1792 if( !exists )
1793 {
1794 index = m_cbBomPresets->Insert( name, index - 1, static_cast<void*>( preset ) );
1795 }
1796 else if( preset->readOnly )
1797 {
1798 wxMessageBox( _( "Default presets cannot be modified.\nPlease use a different name." ),
1799 _( "Error" ), wxOK | wxICON_ERROR, this );
1800 resetSelection();
1801 return;
1802 }
1803 else
1804 {
1805 // Ask the user if they want to overwrite the existing preset
1806 if( !IsOK( this, _( "Overwrite existing preset?" ) ) )
1807 {
1808 resetSelection();
1809 return;
1810 }
1811
1812 *preset = m_dataModel->GetBomSettings();
1813 preset->name = name;
1814
1815 index = m_cbBomPresets->FindString( name );
1816
1817 if( m_bomPresetMRU.Index( name ) != wxNOT_FOUND )
1818 m_bomPresetMRU.Remove( name );
1819 }
1820
1821 m_currentBomPreset = preset;
1822 m_cbBomPresets->SetSelection( index );
1823 m_bomPresetMRU.Insert( name, 0 );
1824
1825 return;
1826 }
1827 else if( index == count - 1 )
1828 {
1829 // Delete a preset
1830 wxArrayString headers;
1831 std::vector<wxArrayString> items;
1832
1833 headers.Add( _( "Presets" ) );
1834
1835 for( const auto& [name, preset] : m_bomPresets )
1836 {
1837 if( !preset.readOnly )
1838 {
1839 wxArrayString item;
1840 item.Add( name );
1841 items.emplace_back( item );
1842 }
1843 }
1844
1845 EDA_LIST_DIALOG dlg( this, _( "Delete Preset" ), headers, items );
1846 dlg.SetListLabel( _( "Select preset:" ) );
1847
1848 if( dlg.ShowModal() == wxID_OK )
1849 {
1850 wxString presetName = dlg.GetTextSelection();
1851 int idx = m_cbBomPresets->FindString( presetName );
1852
1853 if( idx != wxNOT_FOUND )
1854 {
1855 m_bomPresets.erase( presetName );
1856
1857 m_cbBomPresets->Delete( idx );
1858 m_currentBomPreset = nullptr;
1859 }
1860
1861 if( m_bomPresetMRU.Index( presetName ) != wxNOT_FOUND )
1862 m_bomPresetMRU.Remove( presetName );
1863 }
1864
1865 resetSelection();
1866 return;
1867 }
1868
1869 BOM_PRESET* preset = static_cast<BOM_PRESET*>( m_cbBomPresets->GetClientData( index ) );
1870 m_currentBomPreset = preset;
1871
1872 m_lastSelectedBomPreset = ( !preset || preset->readOnly ) ? nullptr : preset;
1873
1874 if( preset )
1875 {
1876 doApplyBomPreset( *preset );
1877 syncBomPresetSelection();
1878 m_currentBomPreset = preset;
1879
1880 if( !m_currentBomPreset->name.IsEmpty() )
1881 {
1882 if( m_bomPresetMRU.Index( preset->name ) != wxNOT_FOUND )
1883 m_bomPresetMRU.Remove( preset->name );
1884
1885 m_bomPresetMRU.Insert( preset->name, 0 );
1886 }
1887 }
1888}
1889
1890
1891void DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset( const BOM_PRESET& aPreset )
1892{
1893 // Disable rebuilds while we're applying the preset otherwise we'll be
1894 // rebuilding the model constantly while firing off wx events
1895 m_dataModel->DisableRebuilds();
1896
1897 // Basically, we apply the BOM preset to the data model and then
1898 // update our UI to reflect resulting the data model state, not the preset.
1899 m_dataModel->ApplyBomPreset( aPreset );
1900
1901 // BOM Presets can add, but not remove, columns, so make sure the field control
1902 // grid has all of them before starting
1903 for( int i = 0; i < m_dataModel->GetColsCount(); i++ )
1904 {
1905 const wxString& fieldName( m_dataModel->GetColFieldName( i ) );
1906 bool found = false;
1907
1908 for( int j = 0; j < m_fieldsCtrl->GetItemCount(); j++ )
1909 {
1910 if( m_fieldsCtrl->GetTextValue( j, FIELD_NAME_COLUMN ) == fieldName )
1911 {
1912 found = true;
1913 break;
1914 }
1915 }
1916
1917 // Properties like label, etc. will be added in the next loop
1918 if( !found )
1919 AddField( fieldName, GetGeneratedFieldDisplayName( fieldName ), false, false );
1920 }
1921
1922 // Sync all fields
1923 for( int i = 0; i < m_fieldsCtrl->GetItemCount(); i++ )
1924 {
1925 const wxString& fieldName( m_fieldsCtrl->GetTextValue( i, FIELD_NAME_COLUMN ) );
1926 int col = m_dataModel->GetFieldNameCol( fieldName );
1927
1928 if( col == -1 )
1929 {
1930 wxASSERT_MSG( true, "Fields control has a field not found in the data model." );
1931 continue;
1932 }
1933
1934 EESCHEMA_SETTINGS* cfg = m_parent->eeconfig();
1935 std::string fieldNameStr( fieldName.ToUTF8() );
1936
1937 // Set column labels
1938 const wxString& label = m_dataModel->GetColLabelValue( col );
1939 m_fieldsCtrl->SetTextValue( label, i, LABEL_COLUMN );
1940 m_grid->SetColLabelValue( col, label );
1941
1942 if( cfg->m_FieldEditorPanel.field_widths.count( fieldNameStr ) )
1943 m_grid->SetColSize( col, cfg->m_FieldEditorPanel.field_widths.at( fieldNameStr ) );
1944
1945 // Set shown columns
1946 bool show = m_dataModel->GetShowColumn( col );
1947 m_fieldsCtrl->SetToggleValue( show, i, SHOW_FIELD_COLUMN );
1948
1949 if( show )
1950 m_grid->ShowCol( col );
1951 else
1952 m_grid->HideCol( col );
1953
1954 // Set grouped columns
1955 bool groupBy = m_dataModel->GetGroupColumn( col );
1956 m_fieldsCtrl->SetToggleValue( groupBy, i, GROUP_BY_COLUMN );
1957 }
1958
1959 m_grid->SetSortingColumn( m_dataModel->GetSortCol(), m_dataModel->GetSortAsc() );
1960 m_groupSymbolsBox->SetValue( m_dataModel->GetGroupingEnabled() );
1961 m_filter->ChangeValue( m_dataModel->GetFilter() );
1962 m_checkExcludeDNP->SetValue( m_dataModel->GetExcludeDNP() );
1963 m_checkShowExcluded->SetValue( m_dataModel->GetIncludeExcludedFromBOM() );
1964
1965 SetupAllColumnProperties();
1966
1967 // This will rebuild all rows and columns in the model such that the order
1968 // and labels are right, then we refresh the shown grid data to match
1969 m_dataModel->EnableRebuilds();
1970 m_dataModel->RebuildRows();
1971 m_grid->ForceRefresh();
1972}
1973
1974
1975std::vector<BOM_FMT_PRESET> DIALOG_SYMBOL_FIELDS_TABLE::GetUserBomFmtPresets() const
1976{
1977 std::vector<BOM_FMT_PRESET> ret;
1978
1979 for( const auto& [name, preset] : m_bomFmtPresets )
1980 {
1981 if( !preset.readOnly )
1982 ret.emplace_back( preset );
1983 }
1984
1985 return ret;
1986}
1987
1988
1989void DIALOG_SYMBOL_FIELDS_TABLE::SetUserBomFmtPresets( std::vector<BOM_FMT_PRESET>& aPresetList )
1990{
1991 // Reset to defaults
1992 loadDefaultBomFmtPresets();
1993
1994 for( const BOM_FMT_PRESET& preset : aPresetList )
1995 {
1996 if( m_bomFmtPresets.count( preset.name ) )
1997 continue;
1998
1999 m_bomFmtPresets[preset.name] = preset;
2000
2001 m_bomFmtPresetMRU.Add( preset.name );
2002 }
2003
2004 rebuildBomFmtPresetsWidget();
2005}
2006
2007
2008void DIALOG_SYMBOL_FIELDS_TABLE::ApplyBomFmtPreset( const wxString& aPresetName )
2009{
2010 updateBomFmtPresetSelection( aPresetName );
2011
2012 wxCommandEvent dummy;
2013 onBomFmtPresetChanged( dummy );
2014}
2015
2016
2017void DIALOG_SYMBOL_FIELDS_TABLE::ApplyBomFmtPreset( const BOM_FMT_PRESET& aPreset )
2018{
2019 m_currentBomFmtPreset = nullptr;
2020 m_lastSelectedBomFmtPreset = nullptr;
2021
2022 if( m_bomFmtPresets.count( aPreset.name ) )
2023 m_currentBomFmtPreset = &m_bomFmtPresets[aPreset.name];
2024
2025 if( m_currentBomFmtPreset && !m_currentBomFmtPreset->readOnly )
2026 m_lastSelectedBomFmtPreset =m_currentBomFmtPreset;
2027
2028 updateBomFmtPresetSelection( aPreset.name );
2029 doApplyBomFmtPreset( aPreset );
2030}
2031
2032
2033void DIALOG_SYMBOL_FIELDS_TABLE::loadDefaultBomFmtPresets()
2034{
2035 m_bomFmtPresets.clear();
2036 m_bomFmtPresetMRU.clear();
2037
2038 // Load the read-only defaults
2039 for( const BOM_FMT_PRESET& preset : BOM_FMT_PRESET::BuiltInPresets() )
2040 {
2041 m_bomFmtPresets[preset.name] = preset;
2042 m_bomFmtPresets[preset.name].readOnly = true;
2043
2044 m_bomFmtPresetMRU.Add( preset.name );
2045 }
2046}
2047
2048
2049void DIALOG_SYMBOL_FIELDS_TABLE::rebuildBomFmtPresetsWidget()
2050{
2051 m_cbBomFmtPresets->Clear();
2052
2053 // Build the layers preset list.
2054 // By default, the presetAllLayers will be selected
2055 int idx = 0;
2056 int default_idx = 0;
2057
2058 for( std::pair<const wxString, BOM_FMT_PRESET>& pair : m_bomFmtPresets )
2059 {
2060 m_cbBomFmtPresets->Append( wxGetTranslation( pair.first ),
2061 static_cast<void*>( &pair.second ) );
2062
2063 if( pair.first == BOM_FMT_PRESET::CSV().name )
2064 default_idx = idx;
2065
2066 idx++;
2067 }
2068
2069 m_cbBomFmtPresets->Append( wxT( "---" ) );
2070 m_cbBomFmtPresets->Append( _( "Save preset..." ) );
2071 m_cbBomFmtPresets->Append( _( "Delete preset..." ) );
2072
2073 // At least the built-in presets should always be present
2074 wxASSERT( !m_bomFmtPresets.empty() );
2075
2076 // Default preset: all Boms
2077 m_cbBomFmtPresets->SetSelection( default_idx );
2078 m_currentBomFmtPreset = static_cast<BOM_FMT_PRESET*>( m_cbBomFmtPresets->GetClientData( default_idx ) );
2079}
2080
2081
2082void DIALOG_SYMBOL_FIELDS_TABLE::syncBomFmtPresetSelection()
2083{
2084 BOM_FMT_PRESET current = GetCurrentBomFmtSettings();
2085
2086 auto it = std::find_if( m_bomFmtPresets.begin(), m_bomFmtPresets.end(),
2087 [&]( const std::pair<const wxString, BOM_FMT_PRESET>& aPair )
2088 {
2089 return ( aPair.second.fieldDelimiter == current.fieldDelimiter
2090 && aPair.second.stringDelimiter == current.stringDelimiter
2091 && aPair.second.refDelimiter == current.refDelimiter
2092 && aPair.second.refRangeDelimiter == current.refRangeDelimiter
2093 && aPair.second.keepTabs == current.keepTabs
2094 && aPair.second.keepLineBreaks == current.keepLineBreaks );
2095 } );
2096
2097 if( it != m_bomFmtPresets.end() )
2098 {
2099 // Select the right m_cbBomFmtPresets item.
2100 // but these items are translated if they are predefined items.
2101 bool do_translate = it->second.readOnly;
2102 wxString text = do_translate ? wxGetTranslation( it->first ) : it->first;
2103
2104 m_cbBomFmtPresets->SetStringSelection( text );
2105 }
2106 else
2107 {
2108 m_cbBomFmtPresets->SetSelection( m_cbBomFmtPresets->GetCount() - 3 ); // separator
2109 }
2110
2111 int idx = m_cbBomFmtPresets->GetSelection();
2112 m_currentBomFmtPreset = static_cast<BOM_FMT_PRESET*>( m_cbBomFmtPresets->GetClientData( idx ) );
2113}
2114
2115
2116void DIALOG_SYMBOL_FIELDS_TABLE::updateBomFmtPresetSelection( const wxString& aName )
2117{
2118 // look at m_userBomFmtPresets to know if aName is a read only preset, or a user preset.
2119 // Read only presets have translated names in UI, so we have to use
2120 // a translated name in UI selection.
2121 // But for a user preset name we should search for aName (not translated)
2122 wxString ui_label = aName;
2123
2124 for( const auto& [name, preset] : m_bomFmtPresets )
2125 {
2126 if( name != aName )
2127 continue;
2128
2129 if( preset.readOnly )
2130 ui_label = wxGetTranslation( aName );
2131
2132 break;
2133 }
2134
2135 int idx = m_cbBomFmtPresets->FindString( ui_label );
2136
2137 if( idx >= 0 && m_cbBomFmtPresets->GetSelection() != idx )
2138 {
2139 m_cbBomFmtPresets->SetSelection( idx );
2140 m_currentBomFmtPreset = static_cast<BOM_FMT_PRESET*>( m_cbBomFmtPresets->GetClientData( idx ) );
2141 }
2142 else if( idx < 0 )
2143 {
2144 m_cbBomFmtPresets->SetSelection( m_cbBomFmtPresets->GetCount() - 3 ); // separator
2145 }
2146}
2147
2148
2149void DIALOG_SYMBOL_FIELDS_TABLE::onBomFmtPresetChanged( wxCommandEvent& aEvent )
2150{
2151 int count = m_cbBomFmtPresets->GetCount();
2152 int index = m_cbBomFmtPresets->GetSelection();
2153
2154 auto resetSelection =
2155 [&]()
2156 {
2157 if( m_currentBomFmtPreset )
2158 m_cbBomFmtPresets->SetStringSelection( m_currentBomFmtPreset->name );
2159 else
2160 m_cbBomFmtPresets->SetSelection( m_cbBomFmtPresets->GetCount() - 3 );
2161 };
2162
2163 if( index == count - 3 )
2164 {
2165 // Separator: reject the selection
2166 resetSelection();
2167 return;
2168 }
2169 else if( index == count - 2 )
2170 {
2171 // Save current state to new preset
2172 wxString name;
2173
2174 if( m_lastSelectedBomFmtPreset )
2175 name = m_lastSelectedBomFmtPreset->name;
2176
2177 wxTextEntryDialog dlg( this, _( "BOM preset name:" ), _( "Save BOM Preset" ), name );
2178
2179 if( dlg.ShowModal() != wxID_OK )
2180 {
2181 resetSelection();
2182 return;
2183 }
2184
2185 name = dlg.GetValue();
2186 bool exists = m_bomFmtPresets.count( name );
2187
2188 if( !exists )
2189 {
2190 m_bomFmtPresets[name] = GetCurrentBomFmtSettings();
2191 m_bomFmtPresets[name].readOnly = false;
2192 m_bomFmtPresets[name].name = name;
2193 }
2194
2195 BOM_FMT_PRESET* preset = &m_bomFmtPresets[name];
2196
2197 if( !exists )
2198 {
2199 index = m_cbBomFmtPresets->Insert( name, index - 1, static_cast<void*>( preset ) );
2200 }
2201 else if( preset->readOnly )
2202 {
2203 wxMessageBox( _( "Default presets cannot be modified.\nPlease use a different name." ),
2204 _( "Error" ), wxOK | wxICON_ERROR, this );
2205 resetSelection();
2206 return;
2207 }
2208 else
2209 {
2210 // Ask the user if they want to overwrite the existing preset
2211 if( !IsOK( this, _( "Overwrite existing preset?" ) ) )
2212 {
2213 resetSelection();
2214 return;
2215 }
2216
2217 *preset = GetCurrentBomFmtSettings();
2218 preset->name = name;
2219
2220 index = m_cbBomFmtPresets->FindString( name );
2221
2222 if( m_bomFmtPresetMRU.Index( name ) != wxNOT_FOUND )
2223 m_bomFmtPresetMRU.Remove( name );
2224 }
2225
2226 m_currentBomFmtPreset = preset;
2227 m_cbBomFmtPresets->SetSelection( index );
2228 m_bomFmtPresetMRU.Insert( name, 0 );
2229
2230 return;
2231 }
2232 else if( index == count - 1 )
2233 {
2234 // Delete a preset
2235 wxArrayString headers;
2236 std::vector<wxArrayString> items;
2237
2238 headers.Add( _( "Presets" ) );
2239
2240 for( std::pair<const wxString, BOM_FMT_PRESET>& pair : m_bomFmtPresets )
2241 {
2242 if( !pair.second.readOnly )
2243 {
2244 wxArrayString item;
2245 item.Add( pair.first );
2246 items.emplace_back( item );
2247 }
2248 }
2249
2250 EDA_LIST_DIALOG dlg( this, _( "Delete Preset" ), headers, items );
2251 dlg.SetListLabel( _( "Select preset:" ) );
2252
2253 if( dlg.ShowModal() == wxID_OK )
2254 {
2255 wxString presetName = dlg.GetTextSelection();
2256 int idx = m_cbBomFmtPresets->FindString( presetName );
2257
2258 if( idx != wxNOT_FOUND )
2259 {
2260 m_bomFmtPresets.erase( presetName );
2261
2262 m_cbBomFmtPresets->Delete( idx );
2263 m_currentBomFmtPreset = nullptr;
2264 }
2265
2266 if( m_bomFmtPresetMRU.Index( presetName ) != wxNOT_FOUND )
2267 m_bomFmtPresetMRU.Remove( presetName );
2268 }
2269
2270 resetSelection();
2271 return;
2272 }
2273
2274 auto* preset = static_cast<BOM_FMT_PRESET*>( m_cbBomFmtPresets->GetClientData( index ) );
2275 m_currentBomFmtPreset = preset;
2276
2277 m_lastSelectedBomFmtPreset = ( !preset || preset->readOnly ) ? nullptr : preset;
2278
2279 if( preset )
2280 {
2281 doApplyBomFmtPreset( *preset );
2282 syncBomFmtPresetSelection();
2283 m_currentBomFmtPreset = preset;
2284
2285 if( !m_currentBomFmtPreset->name.IsEmpty() )
2286 {
2287 if( m_bomFmtPresetMRU.Index( preset->name ) != wxNOT_FOUND )
2288 m_bomFmtPresetMRU.Remove( preset->name );
2289
2290 m_bomFmtPresetMRU.Insert( preset->name, 0 );
2291 }
2292 }
2293}
2294
2295
2296void DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomFmtPreset( const BOM_FMT_PRESET& aPreset )
2297{
2298 m_textFieldDelimiter->ChangeValue( aPreset.fieldDelimiter );
2299 m_textStringDelimiter->ChangeValue( aPreset.stringDelimiter );
2300 m_textRefDelimiter->ChangeValue( aPreset.refDelimiter );
2301 m_textRefRangeDelimiter->ChangeValue( aPreset.refRangeDelimiter );
2302 m_checkKeepTabs->SetValue( aPreset.keepTabs );
2303 m_checkKeepLineBreaks->SetValue( aPreset.keepLineBreaks );
2304
2305
2306 // Refresh the preview if that's the current page
2307 if( m_nbPages->GetSelection() == 1 )
2308 PreviewRefresh();
2309}
2310
2311
2312void DIALOG_SYMBOL_FIELDS_TABLE::savePresetsToSchematic()
2313{
2314 bool modified = false;
2315
2316 // Save our BOM presets
2317 std::vector<BOM_PRESET> presets;
2318
2319 for( const auto& [name, preset] : m_bomPresets )
2320 {
2321 if( !preset.readOnly )
2322 presets.emplace_back( preset );
2323 }
2324
2325 if( m_schSettings.m_BomPresets != presets )
2326 {
2327 modified = true;
2328 m_schSettings.m_BomPresets = presets;
2329 }
2330
2331 if( m_schSettings.m_BomSettings != m_dataModel->GetBomSettings() )
2332 {
2333 modified = true;
2334 m_schSettings.m_BomSettings = m_dataModel->GetBomSettings();
2335 }
2336
2337 // Save our BOM Format presets
2338 std::vector<BOM_FMT_PRESET> fmts;
2339
2340 for( const auto& [name, preset] : m_bomFmtPresets )
2341 {
2342 if( !preset.readOnly )
2343 fmts.emplace_back( preset );
2344 }
2345
2346 if( m_schSettings.m_BomFmtPresets != fmts )
2347 {
2348 modified = true;
2349 m_schSettings.m_BomFmtPresets = fmts;
2350 }
2351
2352 if( m_schSettings.m_BomFmtSettings != GetCurrentBomFmtSettings() )
2353 {
2354 modified = true;
2355 m_schSettings.m_BomFmtSettings = GetCurrentBomFmtSettings();
2356 }
2357
2358 if( modified )
2359 m_parent->OnModify();
2360}
2361
2362
2363void DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsAdded( SCHEMATIC& aSch,
2364 std::vector<SCH_ITEM*>& aSchItem )
2365{
2366 SCH_REFERENCE_LIST allRefs;
2367 m_parent->Schematic().Hierarchy().GetSymbols( allRefs );
2368
2369 for( SCH_ITEM* item : aSchItem )
2370 {
2371 if( item->Type() == SCH_SYMBOL_T )
2372 {
2373 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
2374
2375 // Don't add power symbols
2376 if( !symbol->IsMissingLibSymbol() && symbol->IsPower() )
2377 continue;
2378
2379 // Add all fields again in case this symbol has a new one
2380 for( SCH_FIELD& field : symbol->GetFields() )
2381 AddField( field.GetCanonicalName(), field.GetName(), true, false, true );
2382
2383 m_dataModel->AddReferences( getSymbolReferences( symbol, allRefs ) );
2384 }
2385 else if( item->Type() == SCH_SHEET_T )
2386 {
2387 std::set<SCH_SYMBOL*> symbols;
2388 SCH_REFERENCE_LIST refs = getSheetSymbolReferences( *static_cast<SCH_SHEET*>( item ) );
2389
2390 for( SCH_REFERENCE& ref : refs )
2391 symbols.insert( ref.GetSymbol() );
2392
2393 for( SCH_SYMBOL* symbol : symbols )
2394 {
2395 // Add all fields again in case this symbol has a new one
2396 for( SCH_FIELD& field : symbol->GetFields() )
2397 AddField( field.GetCanonicalName(), field.GetName(), true, false, true );
2398 }
2399
2400 m_dataModel->AddReferences( refs );
2401 }
2402 }
2403
2404 DisableSelectionEvents();
2405 m_dataModel->RebuildRows();
2406 EnableSelectionEvents();
2407}
2408
2409
2410void DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsRemoved( SCHEMATIC& aSch,
2411 std::vector<SCH_ITEM*>& aSchItem )
2412{
2413 for( SCH_ITEM* item : aSchItem )
2414 {
2415 if( item->Type() == SCH_SYMBOL_T )
2416 m_dataModel->RemoveSymbol( *static_cast<SCH_SYMBOL*>( item ) );
2417 else if( item->Type() == SCH_SHEET_T )
2418 m_dataModel->RemoveReferences( getSheetSymbolReferences( *static_cast<SCH_SHEET*>( item ) ) );
2419 }
2420
2421 DisableSelectionEvents();
2422 m_dataModel->RebuildRows();
2423 EnableSelectionEvents();
2424}
2425
2426
2427void DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsChanged( SCHEMATIC& aSch,
2428 std::vector<SCH_ITEM*>& aSchItem )
2429{
2430 SCH_REFERENCE_LIST allRefs;
2431 m_parent->Schematic().Hierarchy().GetSymbols( allRefs );
2432
2433 for( SCH_ITEM* item : aSchItem )
2434 {
2435 if( item->Type() == SCH_SYMBOL_T )
2436 {
2437 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
2438
2439 // Don't add power symbols
2440 if( !symbol->IsMissingLibSymbol() && symbol->IsPower() )
2441 continue;
2442
2443 // Add all fields again in case this symbol has a new one
2444 for( SCH_FIELD& field : symbol->GetFields() )
2445 AddField( field.GetCanonicalName(), field.GetName(), true, false, true );
2446
2447 m_dataModel->UpdateReferences( getSymbolReferences( symbol, allRefs ) );
2448 }
2449 else if( item->Type() == SCH_SHEET_T )
2450 {
2451 std::set<SCH_SYMBOL*> symbols;
2452 SCH_REFERENCE_LIST refs = getSheetSymbolReferences( *static_cast<SCH_SHEET*>( item ) );
2453
2454 for( SCH_REFERENCE& ref : refs )
2455 symbols.insert( ref.GetSymbol() );
2456
2457 for( SCH_SYMBOL* symbol : symbols )
2458 {
2459 // Add all fields again in case this symbol has a new one
2460 for( SCH_FIELD& field : symbol->GetFields() )
2461 AddField( field.GetCanonicalName(), field.GetName(), true, false, true );
2462 }
2463
2464 m_dataModel->UpdateReferences( refs );
2465 }
2466 }
2467
2468 DisableSelectionEvents();
2469 m_dataModel->RebuildRows();
2470 EnableSelectionEvents();
2471}
2472
2473
2474void DIALOG_SYMBOL_FIELDS_TABLE::OnSchSheetChanged( SCHEMATIC& aSch )
2475{
2476 m_dataModel->SetPath( aSch.CurrentSheet() );
2477
2478 if( m_dataModel->GetScope() != FIELDS_EDITOR_GRID_DATA_MODEL::SCOPE::SCOPE_ALL )
2479 {
2480 DisableSelectionEvents();
2481 m_dataModel->RebuildRows();
2482 EnableSelectionEvents();
2483 }
2484}
2485
2486
2487void DIALOG_SYMBOL_FIELDS_TABLE::EnableSelectionEvents()
2488{
2489 m_grid->Connect( wxEVT_GRID_RANGE_SELECTED,
2490 wxGridRangeSelectEventHandler( DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected ),
2491 nullptr, this );
2492}
2493
2494
2495void DIALOG_SYMBOL_FIELDS_TABLE::DisableSelectionEvents()
2496{
2497 m_grid->Disconnect( wxEVT_GRID_RANGE_SELECTED,
2498 wxGridRangeSelectEventHandler( DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected ),
2499 nullptr, this );
2500}
2501
2502
2503SCH_REFERENCE_LIST
2504DIALOG_SYMBOL_FIELDS_TABLE::getSymbolReferences( SCH_SYMBOL* aSymbol,
2505 SCH_REFERENCE_LIST& aCachedRefs )
2506{
2507 SCH_REFERENCE_LIST symbolRefs;
2508
2509 for( size_t i = 0; i < aCachedRefs.GetCount(); i++ )
2510 {
2511 SCH_REFERENCE& ref = aCachedRefs[i];
2512
2513 if( ref.GetSymbol() == aSymbol )
2514 {
2515 ref.Split(); // Figures out if we are annotated or not
2516 symbolRefs.AddItem( ref );
2517 }
2518 }
2519
2520 return symbolRefs;
2521}
2522
2523
2524SCH_REFERENCE_LIST DIALOG_SYMBOL_FIELDS_TABLE::getSheetSymbolReferences( SCH_SHEET& aSheet )
2525{
2526 SCH_SHEET_LIST allSheets = m_parent->Schematic().Hierarchy();
2527 SCH_REFERENCE_LIST sheetRefs;
2528
2529 // We need to operate on all instances of the sheet
2530 for( const SCH_SHEET_INSTANCE& instance : aSheet.GetInstances() )
2531 {
2532 // For every sheet instance we need to get the current schematic sheet
2533 // instance that matches that particular sheet path from the root
2534 for( SCH_SHEET_PATH& basePath : allSheets )
2535 {
2536 if( basePath.Path() == instance.m_Path )
2537 {
2538 SCH_SHEET_PATH sheetPath = basePath;
2539 sheetPath.push_back( &aSheet );
2540
2541 // Create a list of all sheets in this path, starting with the path
2542 // of the sheet that we just deleted, then all of its subsheets
2543 SCH_SHEET_LIST subSheets;
2544 subSheets.push_back( sheetPath );
2545 allSheets.GetSheetsWithinPath( subSheets, sheetPath );
2546
2547 subSheets.GetSymbolsWithinPath( sheetRefs, sheetPath, false, false );
2548 break;
2549 }
2550 }
2551 }
2552
2553 for( SCH_REFERENCE& ref : sheetRefs )
2554 ref.Split();
2555
2556 return sheetRefs;
2557}
name
const char * name
Definition: DXF_plotter.cpp:62
base_units.h
KiBitmapBundle
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap, int aMinHeight)
Definition: bitmap.cpp:110
bitmap_button.h
BITMAPS::text
@ text
BITMAPS::editor
@ editor
BITMAPS::path
@ path
DIALOG_SHIM
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
Definition: dialog_shim.h:61
DIALOG_SHIM::vertPixelsFromDU
int vertPixelsFromDU(int y) const
Convert an integer number of dialog units to pixels, vertically.
Definition: dialog_shim.cpp:220
DIALOG_SHIM::SetInitialFocus
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:75
DIALOG_SHIM::SetupStandardButtons
void SetupStandardButtons(std::map< int, wxString > aLabels={})
Definition: dialog_shim.cpp:1105
DIALOG_SHIM::m_hash_key
std::string m_hash_key
Definition: dialog_shim.h:236
DIALOG_SHIM::horizPixelsFromDU
int horizPixelsFromDU(int x) const
Convert an integer number of dialog units to pixels, horizontally.
Definition: dialog_shim.cpp:213
DIALOG_SHIM::ClearModify
void ClearModify()
Definition: dialog_shim.cpp:717
DIALOG_SHIM::OnModify
void OnModify()
Definition: dialog_shim.cpp:710
DIALOG_SHIM::finishDialogSettings
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
Definition: dialog_shim.cpp:195
DIALOG_SHIM::ShowModal
int ShowModal() override
Definition: dialog_shim.cpp:723
DIALOG_SYMBOL_FIELDS_TABLE_BASE
Class DIALOG_SYMBOL_FIELDS_TABLE_BASE.
Definition: dialog_symbol_fields_table_base.h:49
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_radioRecursive
wxRadioButton * m_radioRecursive
Definition: dialog_symbol_fields_table_base.h:78
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_checkShowExcluded
wxCheckBox * m_checkShowExcluded
Definition: dialog_symbol_fields_table_base.h:68
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_checkKeepLineBreaks
wxCheckBox * m_checkKeepLineBreaks
Definition: dialog_symbol_fields_table_base.h:93
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_bRefreshPreview
STD_BITMAP_BUTTON * m_bRefreshPreview
Definition: dialog_symbol_fields_table_base.h:101
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_radioOff
wxRadioButton * m_radioOff
Definition: dialog_symbol_fields_table_base.h:82
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_checkKeepTabs
wxCheckBox * m_checkKeepTabs
Definition: dialog_symbol_fields_table_base.h:92
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_buttonExport
wxButton * m_buttonExport
Definition: dialog_symbol_fields_table_base.h:103
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_nbPages
wxNotebook * m_nbPages
Definition: dialog_symbol_fields_table_base.h:53
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_removeFieldButton
STD_BITMAP_BUTTON * m_removeFieldButton
Definition: dialog_symbol_fields_table_base.h:60
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_browseButton
STD_BITMAP_BUTTON * m_browseButton
Definition: dialog_symbol_fields_table_base.h:99
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_radioSelect
wxRadioButton * m_radioSelect
Definition: dialog_symbol_fields_table_base.h:81
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_buttonApply
wxButton * m_buttonApply
Definition: dialog_symbol_fields_table_base.h:104
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_grid
WX_GRID * m_grid
Definition: dialog_symbol_fields_table_base.h:73
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_textOutput
wxTextCtrl * m_textOutput
Definition: dialog_symbol_fields_table_base.h:102
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_bRefresh
STD_BITMAP_BUTTON * m_bRefresh
Definition: dialog_symbol_fields_table_base.h:72
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_renameFieldButton
STD_BITMAP_BUTTON * m_renameFieldButton
Definition: dialog_symbol_fields_table_base.h:59
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_addFieldButton
STD_BITMAP_BUTTON * m_addFieldButton
Definition: dialog_symbol_fields_table_base.h:58
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_textStringDelimiter
wxTextCtrl * m_textStringDelimiter
Definition: dialog_symbol_fields_table_base.h:87
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_cbBomPresets
wxChoice * m_cbBomPresets
Definition: dialog_symbol_fields_table_base.h:63
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_outputFileName
wxTextCtrl * m_outputFileName
Definition: dialog_symbol_fields_table_base.h:98
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_splitterMainWindow
wxSplitterWindow * m_splitterMainWindow
Definition: dialog_symbol_fields_table_base.h:55
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_fieldsCtrl
wxDataViewListCtrl * m_fieldsCtrl
Definition: dialog_symbol_fields_table_base.h:57
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_filter
wxSearchCtrl * m_filter
Definition: dialog_symbol_fields_table_base.h:65
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_checkExcludeDNP
wxCheckBox * m_checkExcludeDNP
Definition: dialog_symbol_fields_table_base.h:67
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_radioCurrentSheet
wxRadioButton * m_radioCurrentSheet
Definition: dialog_symbol_fields_table_base.h:77
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_textFieldDelimiter
wxTextCtrl * m_textFieldDelimiter
Definition: dialog_symbol_fields_table_base.h:85
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_groupSymbolsBox
wxCheckBox * m_groupSymbolsBox
Definition: dialog_symbol_fields_table_base.h:70
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_radioHighlight
wxRadioButton * m_radioHighlight
Definition: dialog_symbol_fields_table_base.h:80
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_textRefRangeDelimiter
wxTextCtrl * m_textRefRangeDelimiter
Definition: dialog_symbol_fields_table_base.h:91
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_radioProject
wxRadioButton * m_radioProject
Definition: dialog_symbol_fields_table_base.h:76
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_cbBomFmtPresets
wxChoice * m_cbBomFmtPresets
Definition: dialog_symbol_fields_table_base.h:96
DIALOG_SYMBOL_FIELDS_TABLE_BASE::m_textRefDelimiter
wxTextCtrl * m_textRefDelimiter
Definition: dialog_symbol_fields_table_base.h:89
DIALOG_SYMBOL_FIELDS_TABLE::OnTableColSize
void OnTableColSize(wxGridSizeEvent &event) override
Definition: dialog_symbol_fields_table.cpp:1092
DIALOG_SYMBOL_FIELDS_TABLE::OnSaveAndContinue
void OnSaveAndContinue(wxCommandEvent &aEvent) override
Definition: dialog_symbol_fields_table.cpp:1239
DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsRemoved
void OnSchItemsRemoved(SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aSchItem) override
Definition: dialog_symbol_fields_table.cpp:2410
DIALOG_SYMBOL_FIELDS_TABLE::m_currentBomFmtPreset
BOM_FMT_PRESET * m_currentBomFmtPreset
Definition: dialog_symbol_fields_table.h:149
DIALOG_SYMBOL_FIELDS_TABLE::OnPreviewRefresh
void OnPreviewRefresh(wxCommandEvent &event) override
Definition: dialog_symbol_fields_table.cpp:1255
DIALOG_SYMBOL_FIELDS_TABLE::OnAddField
void OnAddField(wxCommandEvent &event) override
Definition: dialog_symbol_fields_table.cpp:727
DIALOG_SYMBOL_FIELDS_TABLE::getSheetSymbolReferences
SCH_REFERENCE_LIST getSheetSymbolReferences(SCH_SHEET &aSheet)
Definition: dialog_symbol_fields_table.cpp:2524
DIALOG_SYMBOL_FIELDS_TABLE::SetUserBomPresets
void SetUserBomPresets(std::vector< BOM_PRESET > &aPresetList)
Definition: dialog_symbol_fields_table.cpp:1555
DIALOG_SYMBOL_FIELDS_TABLE::OnOk
void OnOk(wxCommandEvent &aEvent) override
Definition: dialog_symbol_fields_table.cpp:1413
DIALOG_SYMBOL_FIELDS_TABLE::OnGroupSymbolsToggled
void OnGroupSymbolsToggled(wxCommandEvent &event) override
Definition: dialog_symbol_fields_table.cpp:958
DIALOG_SYMBOL_FIELDS_TABLE::OnColumnItemToggled
void OnColumnItemToggled(wxDataViewEvent &event) override
Definition: dialog_symbol_fields_table.cpp:893
DIALOG_SYMBOL_FIELDS_TABLE::OnColMove
void OnColMove(wxGridEvent &aEvent)
Definition: dialog_symbol_fields_table.cpp:1022
DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsAdded
void OnSchItemsAdded(SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aSchItem) override
Definition: dialog_symbol_fields_table.cpp:2363
DIALOG_SYMBOL_FIELDS_TABLE::loadDefaultBomFmtPresets
void loadDefaultBomFmtPresets()
Definition: dialog_symbol_fields_table.cpp:2033
DIALOG_SYMBOL_FIELDS_TABLE::m_bomPresets
std::map< wxString, BOM_PRESET > m_bomPresets
Definition: dialog_symbol_fields_table.h:143
DIALOG_SYMBOL_FIELDS_TABLE::OnSchItemsChanged
void OnSchItemsChanged(SCHEMATIC &aSch, std::vector< SCH_ITEM * > &aSchItem) override
Definition: dialog_symbol_fields_table.cpp:2427
DIALOG_SYMBOL_FIELDS_TABLE::ApplyBomFmtPreset
void ApplyBomFmtPreset(const wxString &aPresetName)
Definition: dialog_symbol_fields_table.cpp:2008
DIALOG_SYMBOL_FIELDS_TABLE::m_parent
SCH_EDIT_FRAME * m_parent
Definition: dialog_symbol_fields_table.h:153
DIALOG_SYMBOL_FIELDS_TABLE::TransferDataFromWindow
bool TransferDataFromWindow() override
Definition: dialog_symbol_fields_table.cpp:617
DIALOG_SYMBOL_FIELDS_TABLE::m_symbolsList
SCH_REFERENCE_LIST m_symbolsList
Definition: dialog_symbol_fields_table.h:163
DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties
void SetupColumnProperties(int aCol)
Definition: dialog_symbol_fields_table.cpp:414
DIALOG_SYMBOL_FIELDS_TABLE::m_dataModel
FIELDS_EDITOR_GRID_DATA_MODEL * m_dataModel
Definition: dialog_symbol_fields_table.h:164
DIALOG_SYMBOL_FIELDS_TABLE::updateBomPresetSelection
void updateBomPresetSelection(const wxString &aName)
Definition: dialog_symbol_fields_table.cpp:1712
DIALOG_SYMBOL_FIELDS_TABLE::OnTableItemContextMenu
void OnTableItemContextMenu(wxGridEvent &event) override
Definition: dialog_symbol_fields_table.cpp:1203
DIALOG_SYMBOL_FIELDS_TABLE::updateBomFmtPresetSelection
void updateBomFmtPresetSelection(const wxString &aName)
Definition: dialog_symbol_fields_table.cpp:2116
DIALOG_SYMBOL_FIELDS_TABLE::OnFilterText
void OnFilterText(wxCommandEvent &aEvent) override
Definition: dialog_symbol_fields_table.cpp:867
DIALOG_SYMBOL_FIELDS_TABLE::m_groupByColWidth
int m_groupByColWidth
Definition: dialog_symbol_fields_table.h:161
DIALOG_SYMBOL_FIELDS_TABLE::OnScopeChanged
void OnScopeChanged(wxCommandEvent &aEvent) override
Definition: dialog_symbol_fields_table.cpp:1110
DIALOG_SYMBOL_FIELDS_TABLE::m_mandatoryFieldListIndexes
std::map< FIELD_T, int > m_mandatoryFieldListIndexes
Definition: dialog_symbol_fields_table.h:156
DIALOG_SYMBOL_FIELDS_TABLE::OnRemoveField
void OnRemoveField(wxCommandEvent &event) override
Definition: dialog_symbol_fields_table.cpp:760
DIALOG_SYMBOL_FIELDS_TABLE::UpdateScope
void UpdateScope()
Definition: dialog_symbol_fields_table.cpp:1116
DIALOG_SYMBOL_FIELDS_TABLE::OnTableCellClick
void OnTableCellClick(wxGridEvent &event) override
Definition: dialog_symbol_fields_table.cpp:1131
DIALOG_SYMBOL_FIELDS_TABLE::OnShowExcludedToggled
void OnShowExcludedToggled(wxCommandEvent &event) override
Definition: dialog_symbol_fields_table.cpp:978
DIALOG_SYMBOL_FIELDS_TABLE::m_bomPresetMRU
wxArrayString m_bomPresetMRU
Definition: dialog_symbol_fields_table.h:146
DIALOG_SYMBOL_FIELDS_TABLE::OnColLabelChange
void OnColLabelChange(wxDataViewEvent &aEvent)
Definition: dialog_symbol_fields_table.cpp:1063
DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomFmtPreset
void doApplyBomFmtPreset(const BOM_FMT_PRESET &aPreset)
Definition: dialog_symbol_fields_table.cpp:2296
DIALOG_SYMBOL_FIELDS_TABLE::loadDefaultBomPresets
void loadDefaultBomPresets()
Definition: dialog_symbol_fields_table.cpp:1600
DIALOG_SYMBOL_FIELDS_TABLE::onBomPresetChanged
void onBomPresetChanged(wxCommandEvent &aEvent)
Definition: dialog_symbol_fields_table.cpp:1744
DIALOG_SYMBOL_FIELDS_TABLE::OnTableValueChanged
void OnTableValueChanged(wxGridEvent &event) override
Definition: dialog_symbol_fields_table.cpp:1085
DIALOG_SYMBOL_FIELDS_TABLE::OnExport
void OnExport(wxCommandEvent &aEvent) override
Definition: dialog_symbol_fields_table.cpp:1331
DIALOG_SYMBOL_FIELDS_TABLE::OnClose
void OnClose(wxCloseEvent &aEvent) override
Definition: dialog_symbol_fields_table.cpp:1472
DIALOG_SYMBOL_FIELDS_TABLE::OnSchSheetChanged
void OnSchSheetChanged(SCHEMATIC &aSch) override
Definition: dialog_symbol_fields_table.cpp:2474
DIALOG_SYMBOL_FIELDS_TABLE::syncBomFmtPresetSelection
void syncBomFmtPresetSelection()
Definition: dialog_symbol_fields_table.cpp:2082
DIALOG_SYMBOL_FIELDS_TABLE::m_showColWidth
int m_showColWidth
Definition: dialog_symbol_fields_table.h:160
DIALOG_SYMBOL_FIELDS_TABLE::ShowExportTab
void ShowExportTab()
Definition: dialog_symbol_fields_table.cpp:1291
DIALOG_SYMBOL_FIELDS_TABLE::DisableSelectionEvents
void DisableSelectionEvents()
Definition: dialog_symbol_fields_table.cpp:2495
DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow
bool TransferDataToWindow() override
Definition: dialog_symbol_fields_table.cpp:541
DIALOG_SYMBOL_FIELDS_TABLE::PreviewRefresh
void PreviewRefresh()
Definition: dialog_symbol_fields_table.cpp:1262
DIALOG_SYMBOL_FIELDS_TABLE::OnTableRangeSelected
void OnTableRangeSelected(wxGridRangeSelectEvent &aEvent)
Definition: dialog_symbol_fields_table.cpp:1147
DIALOG_SYMBOL_FIELDS_TABLE::EnableSelectionEvents
void EnableSelectionEvents()
Definition: dialog_symbol_fields_table.cpp:2487
DIALOG_SYMBOL_FIELDS_TABLE::GetUserBomFmtPresets
std::vector< BOM_FMT_PRESET > GetUserBomFmtPresets() const
Definition: dialog_symbol_fields_table.cpp:1975
DIALOG_SYMBOL_FIELDS_TABLE::m_bomFmtPresetMRU
wxArrayString m_bomFmtPresetMRU
Definition: dialog_symbol_fields_table.h:151
DIALOG_SYMBOL_FIELDS_TABLE::OnCancel
void OnCancel(wxCommandEvent &aEvent) override
Definition: dialog_symbol_fields_table.cpp:1404
DIALOG_SYMBOL_FIELDS_TABLE::OnFilterMouseMoved
void OnFilterMouseMoved(wxMouseEvent &event) override
Definition: dialog_symbol_fields_table.cpp:877
DIALOG_SYMBOL_FIELDS_TABLE::m_bomFmtPresets
std::map< wxString, BOM_FMT_PRESET > m_bomFmtPresets
Definition: dialog_symbol_fields_table.h:148
DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE
DIALOG_SYMBOL_FIELDS_TABLE(SCH_EDIT_FRAME *parent, JOB_EXPORT_SCH_BOM *aJob=nullptr)
Definition: dialog_symbol_fields_table.cpp:176
DIALOG_SYMBOL_FIELDS_TABLE::GetCurrentBomFmtSettings
BOM_FMT_PRESET GetCurrentBomFmtSettings()
Returns a formatting configuration corresponding to the values in the UI controls of the dialog.
Definition: dialog_symbol_fields_table.cpp:1269
DIALOG_SYMBOL_FIELDS_TABLE::savePresetsToSchematic
void savePresetsToSchematic()
Definition: dialog_symbol_fields_table.cpp:2312
DIALOG_SYMBOL_FIELDS_TABLE::SetupAllColumnProperties
void SetupAllColumnProperties()
Definition: dialog_symbol_fields_table.cpp:464
DIALOG_SYMBOL_FIELDS_TABLE::AddField
void AddField(const wxString &displayName, const wxString &aCanonicalName, bool show, bool groupBy, bool addedByUser=false)
Definition: dialog_symbol_fields_table.cpp:649
DIALOG_SYMBOL_FIELDS_TABLE::getSymbolReferences
SCH_REFERENCE_LIST getSymbolReferences(SCH_SYMBOL *aSymbol, SCH_REFERENCE_LIST &aCachedRefs)
Definition: dialog_symbol_fields_table.cpp:2504
DIALOG_SYMBOL_FIELDS_TABLE::m_labelColWidth
int m_labelColWidth
Definition: dialog_symbol_fields_table.h:159
DIALOG_SYMBOL_FIELDS_TABLE::m_schSettings
SCHEMATIC_SETTINGS & m_schSettings
Definition: dialog_symbol_fields_table.h:166
DIALOG_SYMBOL_FIELDS_TABLE::syncBomPresetSelection
void syncBomPresetSelection()
Definition: dialog_symbol_fields_table.cpp:1649
DIALOG_SYMBOL_FIELDS_TABLE::OnSizeFieldList
void OnSizeFieldList(wxSizeEvent &event) override
Definition: dialog_symbol_fields_table.cpp:1211
DIALOG_SYMBOL_FIELDS_TABLE::doApplyBomPreset
void doApplyBomPreset(const BOM_PRESET &aPreset)
Definition: dialog_symbol_fields_table.cpp:1891
DIALOG_SYMBOL_FIELDS_TABLE::ShowEditTab
void ShowEditTab()
Definition: dialog_symbol_fields_table.cpp:1285
DIALOG_SYMBOL_FIELDS_TABLE::OnPageChanged
void OnPageChanged(wxNotebookEvent &event) override
Definition: dialog_symbol_fields_table.cpp:1249
DIALOG_SYMBOL_FIELDS_TABLE::SetUserBomFmtPresets
void SetUserBomFmtPresets(std::vector< BOM_FMT_PRESET > &aPresetList)
Definition: dialog_symbol_fields_table.cpp:1989
DIALOG_SYMBOL_FIELDS_TABLE::OnRegroupSymbols
void OnRegroupSymbols(wxCommandEvent &aEvent) override
Definition: dialog_symbol_fields_table.cpp:1103
DIALOG_SYMBOL_FIELDS_TABLE::OnColSort
void OnColSort(wxGridEvent &aEvent)
Definition: dialog_symbol_fields_table.cpp:988
DIALOG_SYMBOL_FIELDS_TABLE::m_job
JOB_EXPORT_SCH_BOM * m_job
Definition: dialog_symbol_fields_table.h:168
DIALOG_SYMBOL_FIELDS_TABLE::~DIALOG_SYMBOL_FIELDS_TABLE
virtual ~DIALOG_SYMBOL_FIELDS_TABLE()
Definition: dialog_symbol_fields_table.cpp:526
DIALOG_SYMBOL_FIELDS_TABLE::GetUserBomPresets
std::vector< BOM_PRESET > GetUserBomPresets() const
Definition: dialog_symbol_fields_table.cpp:1541
DIALOG_SYMBOL_FIELDS_TABLE::OnOutputFileBrowseClicked
void OnOutputFileBrowseClicked(wxCommandEvent &event) override
Definition: dialog_symbol_fields_table.cpp:1297
DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames
void LoadFieldNames()
Construct the rows of m_fieldsCtrl and the columns of m_dataModel from a union of all field names in ...
Definition: dialog_symbol_fields_table.cpp:679
DIALOG_SYMBOL_FIELDS_TABLE::onBomFmtPresetChanged
void onBomFmtPresetChanged(wxCommandEvent &aEvent)
Definition: dialog_symbol_fields_table.cpp:2149
DIALOG_SYMBOL_FIELDS_TABLE::ApplyBomPreset
void ApplyBomPreset(const wxString &aPresetName)
Definition: dialog_symbol_fields_table.cpp:1574
DIALOG_SYMBOL_FIELDS_TABLE::OnExcludeDNPToggled
void OnExcludeDNPToggled(wxCommandEvent &event) override
Definition: dialog_symbol_fields_table.cpp:968
DIALOG_SYMBOL_FIELDS_TABLE::rebuildBomFmtPresetsWidget
void rebuildBomFmtPresetsWidget()
Definition: dialog_symbol_fields_table.cpp:2049
DIALOG_SYMBOL_FIELDS_TABLE::m_lastSelectedBomPreset
BOM_PRESET * m_lastSelectedBomPreset
Definition: dialog_symbol_fields_table.h:145
DIALOG_SYMBOL_FIELDS_TABLE::rebuildBomPresetsWidget
void rebuildBomPresetsWidget()
Definition: dialog_symbol_fields_table.cpp:1616
DIALOG_SYMBOL_FIELDS_TABLE::m_fieldNameColWidth
int m_fieldNameColWidth
Definition: dialog_symbol_fields_table.h:158
DIALOG_SYMBOL_FIELDS_TABLE::m_currentBomPreset
BOM_PRESET * m_currentBomPreset
Definition: dialog_symbol_fields_table.h:144
DIALOG_SYMBOL_FIELDS_TABLE::m_lastSelectedBomFmtPreset
BOM_FMT_PRESET * m_lastSelectedBomFmtPreset
Definition: dialog_symbol_fields_table.h:150
DIALOG_SYMBOL_FIELDS_TABLE::OnRenameField
void OnRenameField(wxCommandEvent &event) override
Definition: dialog_symbol_fields_table.cpp:813
EDA_DRAW_FRAME::ClearFocus
virtual void ClearFocus()
Definition: eda_draw_frame.h:318
EDA_ITEM
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:98
EDA_ITEM::Type
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:110
EDA_ITEM::GetParent
EDA_ITEM * GetParent() const
Definition: eda_item.h:112
EDA_LIST_DIALOG
A dialog which shows:
Definition: eda_list_dialog.h:43
EDA_LIST_DIALOG::GetTextSelection
wxString GetTextSelection(int aColumn=0)
Return the selected text from aColumn in the wxListCtrl in the dialog.
Definition: eda_list_dialog.cpp:200
EDA_LIST_DIALOG::SetListLabel
void SetListLabel(const wxString &aLabel)
Definition: eda_list_dialog.cpp:154
EESCHEMA_SETTINGS
Definition: eeschema_settings.h:59
EESCHEMA_SETTINGS::m_FieldEditorPanel
PANEL_FIELD_EDITOR m_FieldEditorPanel
Definition: eeschema_settings.h:350
EMBEDDED_FILES
Definition: embedded_files.h:41
FIELDS_EDITOR_GRID_DATA_MODEL
Definition: fields_data_model.h:74
FIELDS_EDITOR_GRID_DATA_MODEL::GetFieldNameCol
int GetFieldNameCol(const wxString &aFieldName) const
Definition: fields_data_model.cpp:116
FIELDS_EDITOR_GRID_DATA_MODEL::GetColFieldName
wxString GetColFieldName(int aCol)
Definition: fields_data_model.h:149
FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows
void RebuildRows()
Definition: fields_data_model.cpp:617
FIELDS_EDITOR_GRID_DATA_MODEL::ApplyBomPreset
void ApplyBomPreset(const BOM_PRESET &preset)
Definition: fields_data_model.cpp:910
FIELDS_EDITOR_GRID_DATA_MODEL::GetRowReferences
std::vector< SCH_REFERENCE > GetRowReferences(int aRow) const
Definition: fields_data_model.h:184
FIELDS_EDITOR_GRID_DATA_MODEL::SetGroupingEnabled
void SetGroupingEnabled(bool group)
Definition: fields_data_model.h:233
FIELDS_EDITOR_GRID_DATA_MODEL::ColIsItemNumber
bool ColIsItemNumber(int aCol)
Definition: fields_data_model.cpp:358
FIELDS_EDITOR_GRID_DATA_MODEL::GetNumberCols
int GetNumberCols() override
Definition: fields_data_model.h:134
FIELDS_EDITOR_GRID_DATA_MODEL::ColIsQuantity
bool ColIsQuantity(int aCol)
Definition: fields_data_model.cpp:351
FIELDS_EDITOR_GRID_DATA_MODEL::GetGroupColumn
bool GetGroupColumn(int aCol)
Definition: fields_data_model.h:252
FIELDS_EDITOR_GRID_DATA_MODEL::GetColLabelValue
wxString GetColLabelValue(int aCol) override
Definition: fields_data_model.h:143
FIELDS_EDITOR_GRID_DATA_MODEL::SCOPE
SCOPE
Definition: fields_data_model.h:77
FIELDS_EDITOR_GRID_DATA_MODEL::GetBomSettings
BOM_PRESET GetBomSettings()
Definition: fields_data_model.cpp:971
FIELDS_EDITOR_GRID_DATA_MODEL::SetScope
void SetScope(SCOPE aScope)
Definition: fields_data_model.h:227
FIELDS_EDITOR_GRID_DATA_MODEL::ColIsReference
bool ColIsReference(int aCol)
Definition: fields_data_model.cpp:337
FIELDS_EDITOR_GRID_DATA_MODEL::GetGroupingEnabled
bool GetGroupingEnabled()
Definition: fields_data_model.h:234
FIELDS_EDITOR_GRID_DATA_MODEL::SetPath
void SetPath(const SCH_SHEET_PATH &aPath)
Definition: fields_data_model.h:230
FIELDS_EDITOR_GRID_DATA_MODEL::GetNumberRows
int GetNumberRows() override
Definition: fields_data_model.h:133
FIELDS_EDITOR_GRID_DATA_MODEL::DisableRebuilds
void DisableRebuilds()
Definition: fields_data_model.cpp:611
FIELDS_EDITOR_GRID_DATA_MODEL::RenameColumn
void RenameColumn(int aCol, const wxString &newName)
Definition: fields_data_model.cpp:97
FIELDS_EDITOR_GRID_DATA_MODEL::GetExcludeDNP
bool GetExcludeDNP()
Definition: fields_data_model.h:244
FIELDS_EDITOR_GRID_DATA_MODEL::Export
wxString Export(const BOM_FMT_PRESET &settings)
Definition: fields_data_model.cpp:990
FIELDS_EDITOR_GRID_DATA_MODEL::AddColumn
void AddColumn(const wxString &aFieldName, const wxString &aLabel, bool aAddedByUser)
Definition: fields_data_model.cpp:37
FIELDS_EDITOR_GRID_DATA_MODEL::GetSortCol
int GetSortCol()
Definition: fields_data_model.h:203
FIELDS_EDITOR_GRID_DATA_MODEL::SetSorting
void SetSorting(int aCol, bool ascending)
Definition: fields_data_model.h:196
FIELDS_EDITOR_GRID_DATA_MODEL::ExpandCollapseRow
void ExpandCollapseRow(int aRow)
Definition: fields_data_model.cpp:770
FIELDS_EDITOR_GRID_DATA_MODEL::SetFilter
void SetFilter(const wxString &aFilter)
Definition: fields_data_model.h:224
FIELDS_EDITOR_GRID_DATA_MODEL::IsEdited
bool IsEdited()
Definition: fields_data_model.h:220
FIELDS_EDITOR_GRID_DATA_MODEL::GetScope
SCOPE GetScope()
Definition: fields_data_model.h:228
FIELDS_EDITOR_GRID_DATA_MODEL::EnableRebuilds
void EnableRebuilds()
Definition: fields_data_model.cpp:605
FIELDS_EDITOR_GRID_DATA_MODEL::SetColAttr
void SetColAttr(wxGridCellAttr *aAttr, int aCol) override
Definition: fields_data_model.h:279
FIELDS_EDITOR_GRID_DATA_MODEL::ITEM_NUMBER_VARIABLE
static const wxString ITEM_NUMBER_VARIABLE
Definition: fields_data_model.h:107
FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData
void ApplyData(SCH_COMMIT &aCommit, TEMPLATES &aTemplateFieldnames)
Definition: fields_data_model.cpp:804
FIELDS_EDITOR_GRID_DATA_MODEL::SetIncludeExcludedFromBOM
void SetIncludeExcludedFromBOM(bool include)
Definition: fields_data_model.h:240
FIELDS_EDITOR_GRID_DATA_MODEL::GetDataWidth
int GetDataWidth(int aCol)
Definition: fields_data_model.cpp:884
FIELDS_EDITOR_GRID_DATA_MODEL::UpdateReferences
void UpdateReferences(const SCH_REFERENCE_LIST &aRefs)
Definition: fields_data_model.cpp:1127
FIELDS_EDITOR_GRID_DATA_MODEL::RemoveColumn
void RemoveColumn(int aCol)
Definition: fields_data_model.cpp:85
FIELDS_EDITOR_GRID_DATA_MODEL::GetFilter
const wxString & GetFilter()
Definition: fields_data_model.h:225
FIELDS_EDITOR_GRID_DATA_MODEL::QUANTITY_VARIABLE
static const wxString QUANTITY_VARIABLE
Definition: fields_data_model.h:106
FIELDS_EDITOR_GRID_DATA_MODEL::ColIsValue
bool ColIsValue(int aCol)
Definition: fields_data_model.cpp:344
FIELDS_EDITOR_GRID_DATA_MODEL::SetGroupColumn
void SetGroupColumn(int aCol, bool group)
Definition: fields_data_model.h:246
FIELDS_EDITOR_GRID_DATA_MODEL::SetExcludeDNP
void SetExcludeDNP(bool exclude)
Definition: fields_data_model.h:243
FIELDS_EDITOR_GRID_DATA_MODEL::RemoveSymbol
void RemoveSymbol(const SCH_SYMBOL &aSymbol)
Definition: fields_data_model.cpp:1092
FIELDS_EDITOR_GRID_DATA_MODEL::GetFieldsOrdered
std::vector< BOM_FIELD > GetFieldsOrdered()
Definition: fields_data_model.cpp:128
FIELDS_EDITOR_GRID_DATA_MODEL::GetSortAsc
bool GetSortAsc()
Definition: fields_data_model.h:204
FIELDS_EDITOR_GRID_DATA_MODEL::ColIsAttribute
bool ColIsAttribute(int aCol)
Definition: fields_data_model.cpp:365
FIELDS_EDITOR_GRID_DATA_MODEL::GetShowColumn
bool GetShowColumn(int aCol)
Definition: fields_data_model.h:264
FIELDS_EDITOR_GRID_DATA_MODEL::SetColLabelValue
void SetColLabelValue(int aCol, const wxString &aLabel) override
Definition: fields_data_model.h:136
FIELDS_EDITOR_GRID_DATA_MODEL::MoveColumn
void MoveColumn(int aCol, int aNewPos)
Definition: fields_data_model.h:113
FIELDS_EDITOR_GRID_DATA_MODEL::RemoveReferences
void RemoveReferences(const SCH_REFERENCE_LIST &aRefs)
Definition: fields_data_model.cpp:1109
FIELDS_EDITOR_GRID_DATA_MODEL::GetIncludeExcludedFromBOM
bool GetIncludeExcludedFromBOM()
Definition: fields_data_model.h:241
FIELDS_EDITOR_GRID_DATA_MODEL::SetShowColumn
void SetShowColumn(int aCol, bool show)
Definition: fields_data_model.h:258
FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences
void AddReferences(const SCH_REFERENCE_LIST &aRefs)
Definition: fields_data_model.cpp:1066
FIELDS_EDITOR_GRID_TRICKS
Definition: dialog_symbol_fields_table.cpp:79
FIELDS_EDITOR_GRID_TRICKS::m_files
EMBEDDED_FILES * m_files
Definition: dialog_symbol_fields_table.cpp:172
FIELDS_EDITOR_GRID_TRICKS::m_fieldsCtrl
wxDataViewListCtrl * m_fieldsCtrl
Definition: dialog_symbol_fields_table.cpp:170
FIELDS_EDITOR_GRID_TRICKS::showPopupMenu
void showPopupMenu(wxMenu &menu, wxGridEvent &aEvent) override
Definition: dialog_symbol_fields_table.cpp:91
FIELDS_EDITOR_GRID_TRICKS::doPopupSelection
void doPopupSelection(wxCommandEvent &event) override
Definition: dialog_symbol_fields_table.cpp:109
FIELDS_EDITOR_GRID_TRICKS::m_dlg
DIALOG_SHIM * m_dlg
Definition: dialog_symbol_fields_table.cpp:169
FIELDS_EDITOR_GRID_TRICKS::m_dataModel
FIELDS_EDITOR_GRID_DATA_MODEL * m_dataModel
Definition: dialog_symbol_fields_table.cpp:171
FIELDS_EDITOR_GRID_TRICKS::FIELDS_EDITOR_GRID_TRICKS
FIELDS_EDITOR_GRID_TRICKS(DIALOG_SHIM *aParent, WX_GRID *aGrid, wxDataViewListCtrl *aFieldsCtrl, FIELDS_EDITOR_GRID_DATA_MODEL *aDataModel, EMBEDDED_FILES *aFiles)
Definition: dialog_symbol_fields_table.cpp:81
GRID_CELL_CHECKBOX_RENDERER
Definition: grid_checkbox.h:35
GRID_CELL_FPID_EDITOR
Definition: grid_text_button_helpers.h:96
GRID_CELL_URL_EDITOR
Definition: grid_text_button_helpers.h:120
GRID_TRICKS
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
Definition: grid_tricks.h:61
GRID_TRICKS::doPopupSelection
virtual void doPopupSelection(wxCommandEvent &event)
Definition: grid_tricks.cpp:430
GRID_TRICKS::showPopupMenu
virtual void showPopupMenu(wxMenu &menu, wxGridEvent &aEvent)
Definition: grid_tricks.cpp:359
GRID_TRICKS::m_grid
WX_GRID * m_grid
I don't own the grid, but he owns me.
Definition: grid_tricks.h:128
JOB_EXPORT_SCH_BOM
Definition: job_export_sch_bom.h:29
JOB_EXPORT_SCH_BOM::m_filterString
wxString m_filterString
Definition: job_export_sch_bom.h:56
JOB_EXPORT_SCH_BOM::m_bomPresetName
wxString m_bomPresetName
Definition: job_export_sch_bom.h:39
JOB_EXPORT_SCH_BOM::m_includeExcludedFromBOM
bool m_includeExcludedFromBOM
Definition: job_export_sch_bom.h:58
JOB_EXPORT_SCH_BOM::m_fieldsLabels
std::vector< wxString > m_fieldsLabels
Definition: job_export_sch_bom.h:52
JOB_EXPORT_SCH_BOM::m_fieldsOrdered
std::vector< wxString > m_fieldsOrdered
Definition: job_export_sch_bom.h:51
JOB_EXPORT_SCH_BOM::m_keepLineBreaks
bool m_keepLineBreaks
Definition: job_export_sch_bom.h:48
JOB_EXPORT_SCH_BOM::m_keepTabs
bool m_keepTabs
Definition: job_export_sch_bom.h:47
JOB_EXPORT_SCH_BOM::GetSettingsDialogTitle
wxString GetSettingsDialogTitle() const override
Definition: job_export_sch_bom.cpp:96
JOB_EXPORT_SCH_BOM::m_refDelimiter
wxString m_refDelimiter
Definition: job_export_sch_bom.h:45
JOB_EXPORT_SCH_BOM::m_refRangeDelimiter
wxString m_refRangeDelimiter
Definition: job_export_sch_bom.h:46
JOB_EXPORT_SCH_BOM::m_fieldsGroupBy
std::vector< wxString > m_fieldsGroupBy
Definition: job_export_sch_bom.h:53
JOB_EXPORT_SCH_BOM::m_sortAsc
bool m_sortAsc
Definition: job_export_sch_bom.h:55
JOB_EXPORT_SCH_BOM::m_stringDelimiter
wxString m_stringDelimiter
Definition: job_export_sch_bom.h:44
JOB_EXPORT_SCH_BOM::m_excludeDNP
bool m_excludeDNP
Definition: job_export_sch_bom.h:57
JOB_EXPORT_SCH_BOM::m_fieldDelimiter
wxString m_fieldDelimiter
Definition: job_export_sch_bom.h:43
JOB_EXPORT_SCH_BOM::m_sortField
wxString m_sortField
Definition: job_export_sch_bom.h:54
JOB_EXPORT_SCH_BOM::m_bomFmtPresetName
wxString m_bomFmtPresetName
Definition: job_export_sch_bom.h:40
JOB::SetConfiguredOutputPath
void SetConfiguredOutputPath(const wxString &aPath)
Sets the configured output path for the job, this path is always saved to file.
Definition: job.cpp:153
JOB::GetConfiguredOutputPath
wxString GetConfiguredOutputPath() const
Returns the configured output path for the job.
Definition: job.h:232
KIWAY_HOLDER::Prj
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Definition: kiway_holder.cpp:36
KIWAY_HOLDER::Kiway
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:55
KIWAY_PLAYER
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:65
KIWAY::Player
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:395
NULL_REPORTER::GetInstance
static REPORTER & GetInstance()
Definition: reporter.cpp:108
PROJECT_SCH::SchSearchS
static SEARCH_STACK * SchSearchS(PROJECT *aProject)
Accessor for Eeschema search stack.
Definition: project_sch.cpp:41
PROJECT::AbsolutePath
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.
Definition: project.cpp:373
SCHEMATIC_SETTINGS::m_BomExportFileName
wxString m_BomExportFileName
Definition: schematic_settings.h:97
SCHEMATIC_SETTINGS::m_BomFmtSettings
BOM_FMT_PRESET m_BomFmtSettings
List of stored BOM format presets.
Definition: schematic_settings.h:104
SCHEMATIC_SETTINGS::m_TemplateFieldNames
TEMPLATES m_TemplateFieldNames
Definition: schematic_settings.h:95
SCHEMATIC_SETTINGS::m_BomPresets
std::vector< BOM_PRESET > m_BomPresets
Definition: schematic_settings.h:101
SCHEMATIC_SETTINGS::m_BomFmtPresets
std::vector< BOM_FMT_PRESET > m_BomFmtPresets
Definition: schematic_settings.h:105
SCHEMATIC_SETTINGS::m_BomSettings
BOM_PRESET m_BomSettings
List of stored BOM presets.
Definition: schematic_settings.h:100
SCHEMATIC
Holds all the data relating to one schematic.
Definition: schematic.h:88
SCHEMATIC::RemoveListener
void RemoveListener(SCHEMATIC_LISTENER *aListener)
Remove the specified listener.
Definition: schematic.cpp:866
SCHEMATIC::GetFileName
wxString GetFileName() const
Helper to retrieve the filename from the root sheet screen.
Definition: schematic.cpp:350
SCHEMATIC::Hierarchy
SCH_SHEET_LIST Hierarchy() const
Return the full schematic flattened hierarchical sheet list.
Definition: schematic.cpp:258
SCHEMATIC::AddListener
void AddListener(SCHEMATIC_LISTENER *aListener)
Add a listener to the schematic to receive calls whenever something on the schematic has been modifie...
Definition: schematic.cpp:859
SCHEMATIC::ResolveTextVar
bool ResolveTextVar(const SCH_SHEET_PATH *aSheetPath, wxString *token, int aDepth) const
Definition: schematic.cpp:297
SCHEMATIC::CurrentSheet
SCH_SHEET_PATH & CurrentSheet() const
Definition: schematic.h:171
SCH_BASE_FRAME::SyncView
void SyncView()
Mark all items for refresh.
Definition: sch_base_frame.cpp:512
SCH_BASE_FRAME::eeconfig
EESCHEMA_SETTINGS * eeconfig() const
Definition: sch_base_frame.cpp:169
SCH_COMMIT
Definition: sch_commit.h:46
SCH_COMMIT::Push
virtual void Push(const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
Execute the changes.
Definition: sch_commit.cpp:489
SCH_EDITOR_CONTROL
Handle actions specific to the schematic editor.
Definition: sch_editor_control.h:39
SCH_EDIT_FRAME
Schematic editor (Eeschema) main window.
Definition: sch_edit_frame.h:128
SCH_EDIT_FRAME::OnModify
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag and update other data struc...
Definition: sch_edit_frame.cpp:1164
SCH_EDIT_FRAME::GetCurrentSheet
SCH_SHEET_PATH & GetCurrentSheet() const
Definition: sch_edit_frame.cpp:935
SCH_EDIT_FRAME::Schematic
SCHEMATIC & Schematic() const
Definition: sch_edit_frame.cpp:883
SCH_EDIT_FRAME::SetCurrentSheet
void SetCurrentSheet(const SCH_SHEET_PATH &aSheet)
Definition: sch_edit_frame.cpp:941
SCH_EDIT_FRAME::SaveProject
bool SaveProject(bool aSaveAs=false)
Save the currently-open schematic (including its hierarchy) and associated project.
Definition: eeschema/files-io.cpp:843
SCH_FIELD
Definition: sch_field.h:43
SCH_ITEM
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:168
SCH_REFERENCE_LIST
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
Definition: sch_reference_list.h:275
SCH_REFERENCE_LIST::GetCount
size_t GetCount() const
Definition: sch_reference_list.h:295
SCH_REFERENCE_LIST::AddItem
void AddItem(const SCH_REFERENCE &aItem)
Definition: sch_reference_list.h:300
SCH_REFERENCE
A helper to define a symbol's reference designator in a schematic.
Definition: sch_reference_list.h:78
SCH_REFERENCE::Split
void Split()
Attempt to split the reference designator into a name (U) and number (1).
Definition: sch_reference_list.cpp:798
SCH_REFERENCE::GetSymbol
SCH_SYMBOL * GetSymbol() const
Definition: sch_reference_list.h:93
SCH_SELECTION_TOOL
Definition: sch_selection_tool.h:66
SCH_SELECTION_TOOL::SyncSelection
void SyncSelection(const std::optional< SCH_SHEET_PATH > &targetSheetPath, SCH_ITEM *focusItem, const std::vector< SCH_ITEM * > &items)
Definition: sch_selection_tool.cpp:2865
SCH_SELECTION_TOOL::ClearSelection
int ClearSelection(const TOOL_EVENT &aEvent)
Select all visible items in sheet.
Definition: sch_selection_tool.cpp:2756
SCH_SELECTION_TOOL::GetSelection
SCH_SELECTION & GetSelection()
Definition: sch_selection_tool.cpp:1310
SCH_SELECTION
Definition: sch_selection.h:38
SCH_SHEET_LIST
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Definition: sch_sheet_path.h:465
SCH_SHEET_LIST::GetSymbols
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.
Definition: sch_sheet_path.cpp:1119
SCH_SHEET_LIST::GetSheetsWithinPath
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...
Definition: sch_sheet_path.cpp:1140
SCH_SHEET_LIST::GetSymbolsWithinPath
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...
Definition: sch_sheet_path.cpp:1127
SCH_SHEET_PATH
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Definition: sch_sheet_path.h:133
SCH_SHEET_PATH::push_back
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
Definition: sch_sheet_path.h:166
SCH_SHEET
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:47
SCH_SHEET::GetInstances
const std::vector< SCH_SHEET_INSTANCE > & GetInstances() const
Definition: sch_sheet.h:429
SCH_SYMBOL
Schematic symbol object.
Definition: sch_symbol.h:75
SCH_SYMBOL::GetFields
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly) const override
Populate a std::vector with SCH_FIELDs, sorted in ordinal order.
Definition: sch_symbol.cpp:788
SCH_SYMBOL::IsMissingLibSymbol
bool IsMissingLibSymbol() const
Check to see if the library symbol is set to the dummy library symbol.
Definition: sch_symbol.cpp:210
SCH_SYMBOL::IsPower
bool IsPower() const override
Definition: sch_symbol.cpp:2743
STD_BITMAP_BUTTON::SetBitmap
void SetBitmap(const wxBitmapBundle &aBmp)
Definition: std_bitmap_button.cpp:85
TEMPLATES::GetTemplateFieldNames
const std::vector< TEMPLATE_FIELDNAME > & GetTemplateFieldNames()
Return a template field name list for read only access.
Definition: template_fieldnames.cpp:308
TOOLS_HOLDER::GetToolManager
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
TOOL_MANAGER
Master controller class:
Definition: tool_manager.h:62
TOOL_MANAGER::GetTool
T * GetTool()
Definition: tool_manager.h:328
WX_GRID
Definition: wx_grid.h:51
WX_GRID::SetTable
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...
Definition: wx_grid.cpp:273
WX_GRID::CommitPendingChanges
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:632
ExpandEnvVarSubstitutions
const wxString ExpandEnvVarSubstitutions(const wxString &aString, const PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:355
GetGeneratedFieldDisplayName
wxString GetGeneratedFieldDisplayName(const wxString &aSource)
Returns any variables unexpanded, e.g.
Definition: common.cpp:123
ExpandTextVars
wxString ExpandTextVars(const wxString &aSource, const PROJECT *aProject, int aFlags)
Definition: common.cpp:59
EnsureFileDirectoryExists
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.
Definition: common.cpp:376
IsGeneratedField
bool IsGeneratedField(const wxString &aSource)
Returns true if the string is generated, e.g contains a single text var reference.
Definition: common.cpp:136
common.h
The common library.
OKOrCancelDialog
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.
Definition: confirm.cpp:142
IsOK
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:251
DisplayInfoMessage
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:222
HandleUnsavedChanges
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:129
DisplayErrorMessage
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:194
DisplayError
void DisplayError(wxWindow *aParent, const wxString &aText)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:169
confirm.h
This file is part of the common library.
wxDEFINE_EVENT
wxDEFINE_EVENT(EDA_EVT_CLOSE_DIALOG_SYMBOL_FIELDS_TABLE, wxCommandEvent)
MYID_SHOW_DATASHEET
@ MYID_SHOW_DATASHEET
Definition: dialog_symbol_fields_table.cpp:75
MYID_SELECT_FOOTPRINT
@ MYID_SELECT_FOOTPRINT
Definition: dialog_symbol_fields_table.cpp:74
COLUMN_MARGIN
#define COLUMN_MARGIN
Definition: dialog_symbol_fields_table.cpp:66
dialog_symbol_fields_table.h
_
#define _(s)
Definition: eda_3d_actions.cpp:36
GetAssociatedDocument
bool GetAssociatedDocument(wxWindow *aParent, const wxString &aDocName, PROJECT *aProject, SEARCH_STACK *aPaths, std::vector< EMBEDDED_FILES * > aFilesStack)
Open a document (file) with the suitable browser.
Definition: eda_doc.cpp:62
eda_doc.h
This file is part of the common library.
eda_list_dialog.h
eda_view_switcher.h
fields_data_model.h
LABEL_COLUMN
#define LABEL_COLUMN
Definition: fields_data_model.h:27
DISPLAY_NAME_COLUMN
#define DISPLAY_NAME_COLUMN
Definition: fields_data_model.h:24
FIELD_NAME_COLUMN
#define FIELD_NAME_COLUMN
Definition: fields_data_model.h:32
GROUP_BY_COLUMN
#define GROUP_BY_COLUMN
Definition: fields_data_model.h:29
SHOW_FIELD_COLUMN
#define SHOW_FIELD_COLUMN
Definition: fields_data_model.h:28
FRAME_FOOTPRINT_CHOOSER
@ FRAME_FOOTPRINT_CHOOSER
Definition: frame_type.h:44
grid_checkbox.h
grid_text_button_helpers.h
grid_tricks.h
GRIDTRICKS_FIRST_SHOWHIDE
@ GRIDTRICKS_FIRST_SHOWHIDE
Definition: grid_tricks.h:51
GRIDTRICKS_FIRST_CLIENT_ID
@ GRIDTRICKS_FIRST_CLIENT_ID
Definition: grid_tricks.h:48
FILEEXT::CsvFileExtension
static const std::string CsvFileExtension
Definition: wildcards_and_files_ext.h:189
FILEEXT::CsvFileWildcard
static wxString CsvFileWildcard()
Definition: wildcards_and_files_ext.cpp:415
job_export_sch_bom.h
kiface_base.h
KIPLATFORM::UI::GetUnobscuredSize
wxSize GetUnobscuredSize(const wxWindow *aWindow)
Tries to determine the size of the viewport of a scrollable widget (wxDataViewCtrl,...
Definition: wxgtk/ui.cpp:258
KIUI::GetTextSize
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...
Definition: ui_common.cpp:78
alg::contains
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:100
project_sch.h
sch_commit.h
sch_edit_frame.h
HIGHLIGHT_SYMBOL
@ HIGHLIGHT_SYMBOL
Definition: sch_edit_frame.h:74
sch_editor_control.h
sch_reference_list.h
schematic_settings.h
dummy
std::vector< FAB_LAYER_COLOR > dummy
Definition: stackup_predefined_prms.cpp:97
std_bitmap_button.h
string_utils.h
TO_UTF8
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:429
BOM_FIELD
Definition: bom_settings.h:31
BOM_FIELD::show
bool show
Definition: bom_settings.h:34
BOM_FIELD::label
wxString label
Definition: bom_settings.h:33
BOM_FIELD::groupBy
bool groupBy
Definition: bom_settings.h:35
BOM_FIELD::name
wxString name
Definition: bom_settings.h:32
BOM_FMT_PRESET
Definition: bom_settings.h:80
BOM_FMT_PRESET::readOnly
bool readOnly
Definition: bom_settings.h:82
BOM_FMT_PRESET::fieldDelimiter
wxString fieldDelimiter
Definition: bom_settings.h:83
BOM_FMT_PRESET::keepTabs
bool keepTabs
Definition: bom_settings.h:87
BOM_FMT_PRESET::keepLineBreaks
bool keepLineBreaks
Definition: bom_settings.h:88
BOM_FMT_PRESET::name
wxString name
Definition: bom_settings.h:81
BOM_FMT_PRESET::CSV
static BOM_FMT_PRESET CSV()
Definition: bom_settings.cpp:258
BOM_FMT_PRESET::BuiltInPresets
static std::vector< BOM_FMT_PRESET > BuiltInPresets()
Definition: bom_settings.cpp:278
BOM_FMT_PRESET::stringDelimiter
wxString stringDelimiter
Definition: bom_settings.h:84
BOM_FMT_PRESET::refRangeDelimiter
wxString refRangeDelimiter
Definition: bom_settings.h:86
BOM_FMT_PRESET::refDelimiter
wxString refDelimiter
Definition: bom_settings.h:85
BOM_PRESET
Definition: bom_settings.h:50
BOM_PRESET::name
wxString name
Definition: bom_settings.h:51
BOM_PRESET::DefaultEditing
static BOM_PRESET DefaultEditing()
Definition: bom_settings.cpp:123
BOM_PRESET::sortField
wxString sortField
Definition: bom_settings.h:54
BOM_PRESET::groupSymbols
bool groupSymbols
Definition: bom_settings.h:57
BOM_PRESET::fieldsOrdered
std::vector< BOM_FIELD > fieldsOrdered
Definition: bom_settings.h:53
BOM_PRESET::includeExcludedFromBOM
bool includeExcludedFromBOM
Definition: bom_settings.h:59
BOM_PRESET::readOnly
bool readOnly
Definition: bom_settings.h:52
BOM_PRESET::BuiltInPresets
static std::vector< BOM_PRESET > BuiltInPresets()
Definition: bom_settings.cpp:204
BOM_PRESET::excludeDNP
bool excludeDNP
Definition: bom_settings.h:58
BOM_PRESET::sortAsc
bool sortAsc
Definition: bom_settings.h:55
BOM_PRESET::filterString
wxString filterString
Definition: bom_settings.h:56
EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR
Definition: eeschema_settings.h:236
EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::selection_mode
int selection_mode
Definition: eeschema_settings.h:242
EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::scope
int scope
Definition: eeschema_settings.h:243
EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::page
int page
Definition: eeschema_settings.h:240
EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::height
int height
Definition: eeschema_settings.h:239
EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::field_widths
std::map< std::string, int > field_widths
Definition: eeschema_settings.h:237
EESCHEMA_SETTINGS::PANEL_FIELD_EDITOR::width
int width
Definition: eeschema_settings.h:238
SCH_SHEET_INSTANCE
A simple container for sheet instance information.
Definition: sch_sheet_path.h:65
TEMPLATE_FIELDNAME
Hold a name of a symbol's field, field value, and default visibility.
Definition: template_fieldnames.h:97
symbol_library.h
Definition for symbol library class.
GetDefaultFieldName
wxString GetDefaultFieldName(FIELD_T aFieldId, bool aTranslateForHI)
Return a default symbol field name for a mandatory field type.
Definition: template_fieldnames.cpp:55
DO_TRANSLATE
#define DO_TRANSLATE
Definition: template_fieldnames.h:70
MANDATORY_FIELDS
#define MANDATORY_FIELDS
Definition: template_fieldnames.h:57
FIELD_T
FIELD_T
The set of all field indices assuming an array like sequence that a SCH_COMPONENT or LIB_PART can hol...
Definition: template_fieldnames.h:44
GetCanonicalFieldName
wxString GetCanonicalFieldName(FIELD_T aFieldType)
Definition: template_fieldnames.h:85
SCH_SYMBOL_T
@ SCH_SYMBOL_T
Definition: typeinfo.h:173
SCH_SHEET_T
@ SCH_SHEET_T
Definition: typeinfo.h:176
wildcards_and_files_ext.h
Definition of file extensions used in Kicad.
wx_grid.h