KiCad PCB EDA Suite
Loading...
Searching...
No Matches
dialog_symbol_properties.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) 2004-2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
25
26#include <memory>
27
28#include <bitmaps.h>
29#include <wx/tooltip.h>
30#include <grid_tricks.h>
31#include <confirm.h>
32#include <kiface_base.h>
33#include <pin_numbers.h>
34#include <string_utils.h>
35#include <kiplatform/ui.h>
40#include <ee_collectors.h>
41#include <symbol_library.h>
42#include <fields_grid_table.h>
43#include <sch_edit_frame.h>
44#include <sch_reference_list.h>
45#include <schematic.h>
46#include <sch_commit.h>
47#include <tool/tool_manager.h>
48#include <tool/actions.h>
49
50#include <dialog_sim_model.h>
51
52
53wxDEFINE_EVENT( SYMBOL_DELAY_FOCUS, wxCommandEvent );
54wxDEFINE_EVENT( SYMBOL_DELAY_SELECTION, wxCommandEvent );
55
57{
63
64 COL_COUNT // keep as last
65};
66
67
68class SCH_PIN_TABLE_DATA_MODEL : public wxGridTableBase, public std::vector<SCH_PIN>
69{
70public:
72 m_readOnlyAttr( nullptr ),
73 m_typeAttr( nullptr ),
74 m_shapeAttr( nullptr )
75 {
76 }
77
79 {
80 for( wxGridCellAttr* attr : m_nameAttrs )
81 attr->DecRef();
82
83 m_readOnlyAttr->DecRef();
84 m_typeAttr->DecRef();
85 m_shapeAttr->DecRef();
86 }
87
89 {
90 for( wxGridCellAttr* attr : m_nameAttrs )
91 attr->DecRef();
92
93 m_nameAttrs.clear();
94
95 if( m_readOnlyAttr )
96 m_readOnlyAttr->DecRef();
97
98 m_readOnlyAttr = new wxGridCellAttr;
99 m_readOnlyAttr->SetReadOnly( true );
100
101 for( const SCH_PIN& pin : *this )
102 {
103 LIB_PIN* lib_pin = pin.GetLibPin();
104 wxGridCellAttr* attr = nullptr;
105
106 if( lib_pin->GetAlternates().empty() )
107 {
108 attr = new wxGridCellAttr;
109 attr->SetReadOnly( true );
110 attr->SetBackgroundColour( KIPLATFORM::UI::GetDialogBGColour() );
111 }
112 else
113 {
114 wxArrayString choices;
115 choices.push_back( lib_pin->GetName() );
116
117 for( const std::pair<const wxString, LIB_PIN::ALT>& alt : lib_pin->GetAlternates() )
118 choices.push_back( alt.first );
119
120 attr = new wxGridCellAttr();
121 attr->SetEditor( new GRID_CELL_COMBOBOX( choices ) );
122 }
123
124 m_nameAttrs.push_back( attr );
125 }
126
127 if( m_typeAttr )
128 m_typeAttr->DecRef();
129
130 m_typeAttr = new wxGridCellAttr;
132 PinTypeNames() ) );
133 m_typeAttr->SetReadOnly( true );
134
135 if( m_shapeAttr )
136 m_shapeAttr->DecRef();
137
138 m_shapeAttr = new wxGridCellAttr;
140 PinShapeNames() ) );
141 m_shapeAttr->SetReadOnly( true );
142 }
143
144 int GetNumberRows() override { return (int) size(); }
145 int GetNumberCols() override { return COL_COUNT; }
146
147 wxString GetColLabelValue( int aCol ) override
148 {
149 switch( aCol )
150 {
151 case COL_NUMBER: return _( "Number" );
152 case COL_BASE_NAME: return _( "Base Name" );
153 case COL_ALT_NAME: return _( "Alternate Assignment" );
154 case COL_TYPE: return _( "Electrical Type" );
155 case COL_SHAPE: return _( "Graphic Style" );
156 default: wxFAIL; return wxEmptyString;
157 }
158 }
159
160 bool IsEmptyCell( int row, int col ) override
161 {
162 return false; // don't allow adjacent cell overflow, even if we are actually empty
163 }
164
165 bool CanSetValueAs( int aRow, int aCol, const wxString& aTypeName ) override
166 {
167 // Don't accept random values; must use the popup to change to a known alternate
168 return false;
169 }
170
171 wxString GetValue( int aRow, int aCol ) override
172 {
173 return GetValue( at( aRow ), aCol );
174 }
175
176 static wxString GetValue( const SCH_PIN& aPin, int aCol )
177 {
178 if( aCol == COL_ALT_NAME )
179 {
180 if( aPin.GetLibPin()->GetAlternates().empty() )
181 return wxEmptyString;
182 else if( aPin.GetAlt().IsEmpty() )
183 return aPin.GetName();
184 else
185 return aPin.GetAlt();
186 }
187
188 switch( aCol )
189 {
190 case COL_NUMBER: return aPin.GetNumber();
191 case COL_BASE_NAME: return aPin.GetLibPin()->GetName();
192 case COL_TYPE: return PinTypeNames()[static_cast<int>( aPin.GetType() )];
193 case COL_SHAPE: return PinShapeNames()[static_cast<int>( aPin.GetShape() )];
194 default: wxFAIL; return wxEmptyString;
195 }
196 }
197
198 wxGridCellAttr* GetAttr( int aRow, int aCol, wxGridCellAttr::wxAttrKind ) override
199 {
200 switch( aCol )
201 {
202 case COL_NUMBER:
203 case COL_BASE_NAME:
204 m_readOnlyAttr->IncRef();
205 return m_readOnlyAttr;
206
207 case COL_ALT_NAME:
208 m_nameAttrs[ aRow ]->IncRef();
209 return m_nameAttrs[ aRow ];
210
211 case COL_TYPE:
212 m_typeAttr->IncRef();
213 return m_typeAttr;
214
215 case COL_SHAPE:
216 m_shapeAttr->IncRef();
217 return m_shapeAttr;
218
219 default:
220 wxFAIL;
221 return nullptr;
222 }
223 }
224
225 void SetValue( int aRow, int aCol, const wxString &aValue ) override
226 {
227 switch( aCol )
228 {
229 case COL_ALT_NAME:
230 if( aValue == at( aRow ).GetLibPin()->GetName() )
231 at( aRow ).SetAlt( wxEmptyString );
232 else
233 at( aRow ).SetAlt( aValue );
234 break;
235
236 case COL_NUMBER:
237 case COL_BASE_NAME:
238 case COL_TYPE:
239 case COL_SHAPE:
240 // Read-only.
241 break;
242
243 default:
244 wxFAIL;
245 break;
246 }
247 }
248
249 static bool compare( const SCH_PIN& lhs, const SCH_PIN& rhs, int sortCol, bool ascending )
250 {
251 wxString lhStr = GetValue( lhs, sortCol );
252 wxString rhStr = GetValue( rhs, sortCol );
253
254 if( lhStr == rhStr )
255 {
256 // Secondary sort key is always COL_NUMBER
257 sortCol = COL_NUMBER;
258 lhStr = GetValue( lhs, sortCol );
259 rhStr = GetValue( rhs, sortCol );
260 }
261
262 bool res;
263
264 // N.B. To meet the iterator sort conditions, we cannot simply invert the truth
265 // to get the opposite sort. i.e. ~(a<b) != (a>b)
266 auto cmp = [ ascending ]( const auto a, const auto b )
267 {
268 if( ascending )
269 return a < b;
270 else
271 return b < a;
272 };
273
274 switch( sortCol )
275 {
276 case COL_NUMBER:
277 case COL_BASE_NAME:
278 case COL_ALT_NAME:
279 res = cmp( PIN_NUMBERS::Compare( lhStr, rhStr ), 0 );
280 break;
281 case COL_TYPE:
282 case COL_SHAPE:
283 res = cmp( lhStr.CmpNoCase( rhStr ), 0 );
284 break;
285 default:
286 res = cmp( StrNumCmp( lhStr, rhStr ), 0 );
287 break;
288 }
289
290 return res;
291 }
292
293 void SortRows( int aSortCol, bool ascending )
294 {
295 std::sort( begin(), end(),
296 [ aSortCol, ascending ]( const SCH_PIN& lhs, const SCH_PIN& rhs ) -> bool
297 {
298 return compare( lhs, rhs, aSortCol, ascending );
299 } );
300 }
301
302protected:
303 std::vector<wxGridCellAttr*> m_nameAttrs;
304 wxGridCellAttr* m_readOnlyAttr;
305 wxGridCellAttr* m_typeAttr;
306 wxGridCellAttr* m_shapeAttr;
307};
308
309
311 SCH_SYMBOL* aSymbol ) :
313 m_symbol( nullptr ),
314 m_part( nullptr ),
315 m_fieldsSize( 0, 0 ),
316 m_lastRequestedFieldsSize( 0, 0 ),
317 m_lastRequestedPinsSize( 0, 0 ),
318 m_editorShown( false ),
319 m_fields( nullptr ),
320 m_dataModel( nullptr )
321{
322 m_symbol = aSymbol;
324
325 // GetLibSymbolRef() now points to the cached part in the schematic, which should always be
326 // there for usual cases, but can be null when opening old schematics not storing the part
327 // so we need to handle m_part == nullptr
328 // wxASSERT( m_part );
329
331
332 // Give a bit more room for combobox editors
333 m_fieldsGrid->SetDefaultRowSize( m_fieldsGrid->GetDefaultRowSize() + 4 );
334 m_pinGrid->SetDefaultRowSize( m_pinGrid->GetDefaultRowSize() + 4 );
335
337 m_fieldsGrid->PushEventHandler( new FIELDS_GRID_TRICKS( m_fieldsGrid, this,
338 [&]( wxCommandEvent& aEvent )
339 {
340 OnAddField( aEvent );
341 } ) );
342 m_fieldsGrid->SetSelectionMode( wxGrid::wxGridSelectRows );
343
344 // Show/hide columns according to user's preference
345 if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
346 {
347 m_fieldsGrid->ShowHideColumns( cfg->m_Appearance.edit_symbol_visible_columns );
349 }
350
352 {
353 // DeMorgan conversions are a subclass of alternate pin assignments, so don't allow
354 // free-form alternate assignments as well. (We won't know how to map the alternates
355 // back and forth when the conversion is changed.)
356 m_pinTablePage->Disable();
357 m_pinTablePage->SetToolTip( _( "Alternate pin assignments are not available for De Morgan "
358 "symbols." ) );
359 }
360 else
361 {
363
364 // Make a copy of the pins for editing
365 for( const std::unique_ptr<SCH_PIN>& pin : m_symbol->GetRawPins() )
366 m_dataModel->push_back( *pin );
367
370
372 }
373
374 if( m_part && m_part->IsPower() )
375 m_spiceFieldsButton->Hide();
376
377 m_pinGrid->PushEventHandler( new GRID_TRICKS( m_pinGrid ) );
378 m_pinGrid->SetSelectionMode( wxGrid::wxGridSelectRows );
379
380 m_tcLibraryID->SetBackgroundColour( KIPLATFORM::UI::GetDialogBGColour() );
381
382 wxToolTip::Enable( true );
384
385 // Configure button logos
386 m_bpAdd->SetBitmap( KiBitmapBundle( BITMAPS::small_plus ) );
387 m_bpDelete->SetBitmap( KiBitmapBundle( BITMAPS::small_trash ) );
388 m_bpMoveUp->SetBitmap( KiBitmapBundle( BITMAPS::small_up ) );
389 m_bpMoveDown->SetBitmap( KiBitmapBundle( BITMAPS::small_down ) );
390
391 // wxFormBuilder doesn't include this event...
392 m_fieldsGrid->Bind( wxEVT_GRID_CELL_CHANGING, &DIALOG_SYMBOL_PROPERTIES::OnGridCellChanging,
393 this );
394 m_pinGrid->Bind( wxEVT_GRID_COL_SORT, &DIALOG_SYMBOL_PROPERTIES::OnPinTableColSort, this );
395 Bind( SYMBOL_DELAY_FOCUS, &DIALOG_SYMBOL_PROPERTIES::HandleDelayedFocus, this );
396 Bind( SYMBOL_DELAY_SELECTION, &DIALOG_SYMBOL_PROPERTIES::HandleDelayedSelection, this );
397
398 QueueEvent( new wxCommandEvent( SYMBOL_DELAY_SELECTION ) );
399 wxCommandEvent *evt = new wxCommandEvent( SYMBOL_DELAY_FOCUS );
400 evt->SetClientData( new VECTOR2I( REFERENCE_FIELD, FDC_VALUE ) );
401 QueueEvent( evt );
402
404}
405
406
408{
409 if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
410 {
411 cfg->m_Appearance.edit_symbol_visible_columns = m_fieldsGrid->GetShownColumnsAsString();
412 cfg->m_Appearance.edit_symbol_width = GetSize().x;
413 cfg->m_Appearance.edit_symbol_height = GetSize().y;
414 }
415
416 // Prevents crash bug in wxGrid's d'tor
418
419 if( m_dataModel )
421
422 m_fieldsGrid->Unbind( wxEVT_GRID_CELL_CHANGING, &DIALOG_SYMBOL_PROPERTIES::OnGridCellChanging,
423 this );
424 m_pinGrid->Unbind( wxEVT_GRID_COL_SORT, &DIALOG_SYMBOL_PROPERTIES::OnPinTableColSort, this );
425 Unbind( SYMBOL_DELAY_FOCUS, &DIALOG_SYMBOL_PROPERTIES::HandleDelayedFocus, this );
426 Unbind( SYMBOL_DELAY_SELECTION, &DIALOG_SYMBOL_PROPERTIES::HandleDelayedSelection, this );
427
428 // Delete the GRID_TRICKS.
429 m_fieldsGrid->PopEventHandler( true );
430 m_pinGrid->PopEventHandler( true );
431}
432
433
435{
436 return dynamic_cast<SCH_EDIT_FRAME*>( wxDialog::GetParent() );
437}
438
439
441{
442 if( !wxDialog::TransferDataToWindow() )
443 return false;
444
445 std::set<wxString> defined;
446
447 // Push a copy of each field into m_updateFields
448 for( int i = 0; i < m_symbol->GetFieldCount(); ++i )
449 {
450 SCH_FIELD field( m_symbol->GetFields()[i] );
451
452 // change offset to be symbol-relative
453 field.Offset( -m_symbol->GetPosition() );
454
455 field.SetText( m_symbol->Schematic()->ConvertKIIDsToRefs( field.GetText() ) );
456
457 defined.insert( field.GetName() );
458 m_fields->push_back( field );
459 }
460
461 // Add in any template fieldnames not yet defined:
462 for( const TEMPLATE_FIELDNAME& templateFieldname :
463 GetParent()->Schematic().Settings().m_TemplateFieldNames.GetTemplateFieldNames() )
464 {
465 if( defined.count( templateFieldname.m_Name ) <= 0 )
466 {
467 SCH_FIELD field( VECTOR2I( 0, 0 ), -1, m_symbol, templateFieldname.m_Name );
468 field.SetVisible( templateFieldname.m_Visible );
469 m_fields->push_back( field );
470 }
471 }
472
473 // notify the grid
474 wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, m_fields->size() );
475 m_fieldsGrid->ProcessTableMessage( msg );
477
478 // If a multi-unit symbol, set up the unit selector and interchangeable checkbox.
479 if( m_symbol->GetUnitCount() > 1 )
480 {
481 // Ensure symbol unit is the currently selected unit (mandatory in complex hierarchies)
482 // from the current sheet path, because it can be modified by previous calculations
483 m_symbol->UpdateUnit( m_symbol->GetUnitSelection( &GetParent()->GetCurrentSheet() ) );
484
485 for( int ii = 1; ii <= m_symbol->GetUnitCount(); ii++ )
486 {
487 if( m_symbol->HasUnitDisplayName( ii ) )
488 m_unitChoice->Append( m_symbol->GetUnitDisplayName( ii ) );
489 else
490 m_unitChoice->Append( m_symbol->SubReference( ii, false ) );
491 }
492
493 if( m_symbol->GetUnit() <= ( int )m_unitChoice->GetCount() )
494 m_unitChoice->SetSelection( m_symbol->GetUnit() - 1 );
495 }
496 else
497 {
498 m_unitLabel->Enable( false );
499 m_unitChoice->Enable( false );
500 }
501
503 {
505 m_cbAlternateSymbol->SetValue( true );
506 }
507 else
508 {
509 m_cbAlternateSymbol->Enable( false );
510 }
511
512 // Set the symbol orientation and mirroring.
513 int orientation = m_symbol->GetOrientation() & ~( SYM_MIRROR_X | SYM_MIRROR_Y );
514
515 switch( orientation )
516 {
517 default:
518 case SYM_ORIENT_0: m_orientationCtrl->SetSelection( 0 ); break;
519 case SYM_ORIENT_90: m_orientationCtrl->SetSelection( 1 ); break;
520 case SYM_ORIENT_270: m_orientationCtrl->SetSelection( 2 ); break;
521 case SYM_ORIENT_180: m_orientationCtrl->SetSelection( 3 ); break;
522 }
523
524 int mirror = m_symbol->GetOrientation() & ( SYM_MIRROR_X | SYM_MIRROR_Y );
525
526 switch( mirror )
527 {
528 default: m_mirrorCtrl->SetSelection( 0 ) ; break;
529 case SYM_MIRROR_X: m_mirrorCtrl->SetSelection( 1 ); break;
530 case SYM_MIRROR_Y: m_mirrorCtrl->SetSelection( 2 ); break;
531 }
532
536 m_cbDNP->SetValue( m_symbol->GetDNP() );
537
538 if( m_part )
539 {
540 m_ShowPinNumButt->SetValue( m_part->ShowPinNumbers() );
541 m_ShowPinNameButt->SetValue( m_part->ShowPinNames() );
542 }
543
544 // Set the symbol's library name.
546
547 Layout();
548 m_fieldsGrid->Layout();
549 wxSafeYield();
550
551 return true;
552}
553
554
556{
558 return;
559
560 std::vector<SCH_FIELD> fields;
561
562 for( const SCH_FIELD& field : *m_fields )
563 fields.emplace_back( field );
564
565 DIALOG_SIM_MODEL dialog( this, m_parentFrame, *m_symbol, fields );
566
567 if( dialog.ShowModal() != wxID_OK )
568 return;
569
570 // Add in any new fields
571 for( const SCH_FIELD& editedField : fields )
572 {
573 bool found = false;
574
575 for( SCH_FIELD& existingField : *m_fields )
576 {
577 if( existingField.GetName() == editedField.GetName() )
578 {
579 found = true;
580 existingField.SetText( editedField.GetText() );
581 break;
582 }
583 }
584
585 if( !found )
586 {
587 m_fields->emplace_back( editedField );
588 wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
589 m_fieldsGrid->ProcessTableMessage( msg );
590 }
591 }
592
593 // Remove any deleted fields
594 for( int ii = (int) m_fields->size() - 1; ii >= 0; --ii )
595 {
596 SCH_FIELD& existingField = m_fields->at( ii );
597 bool found = false;
598
599 for( SCH_FIELD& editedField : fields )
600 {
601 if( editedField.GetName() == existingField.GetName() )
602 {
603 found = true;
604 break;
605 }
606 }
607
608 if( !found )
609 {
610 m_fields->erase( m_fields->begin() + ii );
611 wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_DELETED, ii, 1 );
612 m_fieldsGrid->ClearSelection();
613 m_fieldsGrid->ProcessTableMessage( msg );
614 }
615 }
616
617 OnModify();
618 m_fieldsGrid->ForceRefresh();
619}
620
621
623{
624 // Running the Footprint Browser gums up the works and causes the automatic cancel
625 // stuff to no longer work. So we do it here ourselves.
626 EndQuasiModal( wxID_CANCEL );
627}
628
629
631{
632 LIB_ID id;
633
634 if( !m_fieldsGrid->CommitPendingChanges() || !m_fieldsGrid->Validate() )
635 return false;
636
638 {
639 DisplayErrorMessage( this, _( "References must start with a letter." ) );
640
641 wxCommandEvent *evt = new wxCommandEvent( SYMBOL_DELAY_FOCUS );
642 evt->SetClientData( new VECTOR2I( REFERENCE_FIELD, FDC_VALUE ) );
643 QueueEvent( evt );
644
645 return false;
646 }
647
648 // Check for missing field names.
649 for( size_t i = MANDATORY_FIELDS; i < m_fields->size(); ++i )
650 {
651 SCH_FIELD& field = m_fields->at( i );
652 wxString fieldName = field.GetName( false );
653
654 if( fieldName.IsEmpty() )
655 {
656 DisplayErrorMessage( this, _( "Fields must have a name." ) );
657
658 wxCommandEvent *evt = new wxCommandEvent( SYMBOL_DELAY_FOCUS );
659 evt->SetClientData( new VECTOR2I( i, FDC_VALUE ) );
660 QueueEvent( evt );
661
662 return false;
663 }
664 }
665
666 return true;
667}
668
669
671{
672 if( !wxDialog::TransferDataFromWindow() ) // Calls our Validate() method.
673 return false;
674
676 return false;
677
679 return false;
680
681 SCH_COMMIT commit( GetParent() );
682 SCH_SCREEN* currentScreen = GetParent()->GetScreen();
683 bool replaceOnCurrentScreen;
684 wxCHECK( currentScreen, false );
685
686 // This needs to be done before the LIB_ID is changed to prevent stale library symbols in
687 // the schematic file.
688 replaceOnCurrentScreen = currentScreen->Remove( m_symbol );
689
690 // save old cmp in undo list if not already in edit, or moving ...
691 if( m_symbol->GetEditFlags() == 0 )
692 commit.Modify( m_symbol, currentScreen );
693
694 // Save current flags which could be modified by next change settings
696
697 // For symbols with multiple shapes (De Morgan representation) Set the selected shape:
698 if( m_cbAlternateSymbol->IsEnabled() && m_cbAlternateSymbol->GetValue() )
700 else
702
703 //Set the part selection in multiple part per package
704 int unit_selection = m_unitChoice->IsEnabled() ? m_unitChoice->GetSelection() + 1 : 1;
705 m_symbol->SetUnitSelection( &GetParent()->GetCurrentSheet(), unit_selection );
706 m_symbol->SetUnit( unit_selection );
707
708 switch( m_orientationCtrl->GetSelection() )
709 {
710 case 0: m_symbol->SetOrientation( SYM_ORIENT_0 ); break;
711 case 1: m_symbol->SetOrientation( SYM_ORIENT_90 ); break;
712 case 2: m_symbol->SetOrientation( SYM_ORIENT_270 ); break;
713 case 3: m_symbol->SetOrientation( SYM_ORIENT_180 ); break;
714 }
715
716 switch( m_mirrorCtrl->GetSelection() )
717 {
718 case 0: break;
719 case 1: m_symbol->SetOrientation( SYM_MIRROR_X ); break;
720 case 2: m_symbol->SetOrientation( SYM_MIRROR_Y ); break;
721 }
722
723 if( m_part )
724 {
727 }
728
729 // Restore m_Flag modified by SetUnit() and other change settings from the dialog
731 m_symbol->SetFlags( flags );
732
733 // change all field positions from relative to absolute
734 for( unsigned i = 0; i < m_fields->size(); ++i )
735 {
736 SCH_FIELD& field = m_fields->at( i );
737
738 field.Offset( m_symbol->GetPosition() );
739 field.SetText( m_symbol->Schematic()->ConvertRefsToKIIDs( field.GetText() ) );
740 }
741
742 SCH_FIELDS& fields = m_symbol->GetFields();
743
744 fields.clear();
745
746 for( size_t ii = 0; ii < m_fields->size(); ++ii )
747 {
748 SCH_FIELD& field = m_fields->at( ii );
749 const wxString& fieldName = field.GetCanonicalName();
750
751 if( fieldName.IsEmpty() && field.GetText().IsEmpty() )
752 continue;
753 else if( fieldName.IsEmpty() )
754 field.SetName( _( "untitled" ) );
755
756 fields.push_back( field );
757 }
758
759 // Reference has a specific initialization, depending on the current active sheet
760 // because for a given symbol, in a complex hierarchy, there are more than one
761 // reference.
762 m_symbol->SetRef( &GetParent()->GetCurrentSheet(), m_fields->at( REFERENCE_FIELD ).GetText() );
763
764 // Similar for Value and Footprint, except that the GUI behavior is that they are kept
765 // in sync between multiple instances.
766 m_symbol->SetValueFieldText( m_fields->at( VALUE_FIELD ).GetText() );
768
772 m_symbol->SetDNP( m_cbDNP->IsChecked() );
773
774 // Update any assignments
775 if( m_dataModel )
776 {
777 for( const SCH_PIN& model_pin : *m_dataModel )
778 {
779 // map from the edited copy back to the "real" pin in the symbol.
780 SCH_PIN* src_pin = m_symbol->GetPin( model_pin.GetNumber() );
781
782 if( src_pin )
783 src_pin->SetAlt( model_pin.GetAlt() );
784 }
785 }
786
787 // Keep fields other than the reference, include/exclude flags, and alternate pin assignements
788 // in sync in multi-unit parts.
789 if( m_symbol->GetUnitCount() > 1 && m_symbol->IsAnnotated( &GetParent()->GetCurrentSheet() ) )
790 {
791 wxString ref = m_symbol->GetRef( &GetParent()->GetCurrentSheet() );
792 int unit = m_symbol->GetUnit();
793 LIB_ID libId = m_symbol->GetLibId();
794
795 for( SCH_SHEET_PATH& sheet : GetParent()->Schematic().GetSheets() )
796 {
797 SCH_SCREEN* screen = sheet.LastScreen();
798 std::vector<SCH_SYMBOL*> otherUnits;
799
800 CollectOtherUnits( ref, unit, libId, sheet, &otherUnits );
801
802 for( SCH_SYMBOL* otherUnit : otherUnits )
803 {
804 commit.Modify( otherUnit, screen );
805 otherUnit->SetValueFieldText( m_fields->at( VALUE_FIELD ).GetText() );
806 otherUnit->SetFootprintFieldText( m_fields->at( FOOTPRINT_FIELD ).GetText() );
807
808 for( size_t ii = DATASHEET_FIELD; ii < m_fields->size(); ++ii )
809 {
810 SCH_FIELD* otherField = otherUnit->FindField( m_fields->at( ii ).GetName() );
811
812 if( otherField )
813 {
814 otherField->SetText( m_fields->at( ii ).GetText() );
815 }
816 else
817 {
818 SCH_FIELD newField( m_fields->at( ii ) );
819 const_cast<KIID&>( newField.m_Uuid ) = KIID();
820
821 newField.Offset( -m_symbol->GetPosition() );
822 newField.Offset( otherUnit->GetPosition() );
823
824 newField.SetParent( otherUnit );
825 otherUnit->AddField( newField );
826 }
827 }
828
829 for( size_t ii = otherUnit->GetFields().size() - 1; ii > DATASHEET_FIELD; ii-- )
830 {
831 SCH_FIELD& otherField = otherUnit->GetFields().at( ii );
832
833 if( !m_symbol->FindField( otherField.GetName() ) )
834 otherUnit->GetFields().erase( otherUnit->GetFields().begin() + ii );
835 }
836
837 otherUnit->SetExcludedFromSim( m_cbExcludeFromSim->IsChecked() );
838 otherUnit->SetExcludedFromBOM( m_cbExcludeFromBom->IsChecked() );
839 otherUnit->SetExcludedFromBoard( m_cbExcludeFromBoard->IsChecked() );
840 otherUnit->SetDNP( m_cbDNP->IsChecked() );
841
842 if( m_dataModel )
843 {
844 for( const SCH_PIN& model_pin : *m_dataModel )
845 {
846 SCH_PIN* src_pin = otherUnit->GetPin( model_pin.GetNumber() );
847
848 if( src_pin )
849 src_pin->SetAlt( model_pin.GetAlt() );
850 }
851 }
852 }
853 }
854 }
855
856 if( replaceOnCurrentScreen )
857 currentScreen->Append( m_symbol );
858
859 if( !commit.Empty() )
860 commit.Push( _( "Edit Symbol Properties" ) );
861
862 return true;
863}
864
865
867{
868 wxGridCellEditor* editor = m_fieldsGrid->GetCellEditor( event.GetRow(), event.GetCol() );
869 wxControl* control = editor->GetControl();
870
871 if( control && control->GetValidator() && !control->GetValidator()->Validate( control ) )
872 {
873 event.Veto();
874 wxCommandEvent *evt = new wxCommandEvent( SYMBOL_DELAY_FOCUS );
875 evt->SetClientData( new VECTOR2I( event.GetRow(), event.GetCol() ) );
876 QueueEvent( evt );
877 }
878 else if( event.GetCol() == FDC_NAME )
879 {
880 wxString newName = event.GetString();
881
882 for( int i = 0; i < m_fieldsGrid->GetNumberRows(); ++i )
883 {
884 if( i == event.GetRow() )
885 continue;
886
887 if( newName.CmpNoCase( m_fieldsGrid->GetCellValue( i, FDC_NAME ) ) == 0 )
888 {
889 DisplayError( this, wxString::Format( _( "Field name '%s' already in use." ),
890 newName ) );
891 event.Veto();
892 wxCommandEvent *evt = new wxCommandEvent( SYMBOL_DELAY_FOCUS );
893 evt->SetClientData( new VECTOR2I( event.GetRow(), event.GetCol() ) );
894 QueueEvent( evt );
895 }
896 }
897 }
898
899 editor->DecRef();
900}
901
902
904{
905 if( aEvent.GetRow() == REFERENCE_FIELD && aEvent.GetCol() == FDC_VALUE )
906 QueueEvent( new wxCommandEvent( SYMBOL_DELAY_SELECTION ) );
907
908 m_editorShown = true;
909}
910
911
913{
914 m_editorShown = false;
915}
916
917
918void DIALOG_SYMBOL_PROPERTIES::OnAddField( wxCommandEvent& event )
919{
921 return;
922
924 int fieldID = (int) m_fields->size();
925 SCH_FIELD newField( VECTOR2I( 0, 0 ), fieldID, m_symbol,
927 DO_TRANSLATE ) );
928
929 newField.SetTextAngle( m_fields->at( REFERENCE_FIELD ).GetTextAngle() );
930 newField.SetTextSize( VECTOR2I( settings.m_DefaultTextSize, settings.m_DefaultTextSize ) );
931
932 m_fields->push_back( newField );
933
934 // notify the grid
935 wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, 1 );
936 m_fieldsGrid->ProcessTableMessage( msg );
937
938 m_fieldsGrid->MakeCellVisible( (int) m_fields->size() - 1, 0 );
939 m_fieldsGrid->SetGridCursor( (int) m_fields->size() - 1, 0 );
940
941 m_fieldsGrid->EnableCellEditControl();
942 m_fieldsGrid->ShowCellEditControl();
943
944 OnModify();
945}
946
947
948void DIALOG_SYMBOL_PROPERTIES::OnDeleteField( wxCommandEvent& event )
949{
950 wxArrayInt selectedRows = m_fieldsGrid->GetSelectedRows();
951
952 if( selectedRows.empty() && m_fieldsGrid->GetGridCursorRow() >= 0 )
953 selectedRows.push_back( m_fieldsGrid->GetGridCursorRow() );
954
955 if( selectedRows.empty() )
956 return;
957
958 for( int row : selectedRows )
959 {
960 if( row < MANDATORY_FIELDS )
961 {
962 DisplayError( this, wxString::Format( _( "The first %d fields are mandatory." ),
964 return;
965 }
966 }
967
968 m_fieldsGrid->CommitPendingChanges( true /* quiet mode */ );
969 m_fieldsGrid->ClearSelection();
970
971 // Reverse sort so deleting a row doesn't change the indexes of the other rows.
972 selectedRows.Sort( []( int* first, int* second ) { return *second - *first; } );
973
974 for( int row : selectedRows )
975 {
976 m_fields->erase( m_fields->begin() + row );
977
978 // notify the grid
979 wxGridTableMessage msg( m_fields, wxGRIDTABLE_NOTIFY_ROWS_DELETED, row, 1 );
980 m_fieldsGrid->ProcessTableMessage( msg );
981
982 if( m_fieldsGrid->GetNumberRows() > 0 )
983 {
984 m_fieldsGrid->MakeCellVisible( std::max( 0, row-1 ), m_fieldsGrid->GetGridCursorCol() );
985 m_fieldsGrid->SetGridCursor( std::max( 0, row-1 ), m_fieldsGrid->GetGridCursorCol() );
986 }
987 }
988
989 OnModify();
990}
991
992
993void DIALOG_SYMBOL_PROPERTIES::OnMoveUp( wxCommandEvent& event )
994{
996 return;
997
998 int i = m_fieldsGrid->GetGridCursorRow();
999
1000 if( i > MANDATORY_FIELDS )
1001 {
1002 SCH_FIELD tmp = m_fields->at( (unsigned) i );
1003 m_fields->erase( m_fields->begin() + i, m_fields->begin() + i + 1 );
1004 m_fields->insert( m_fields->begin() + i - 1, tmp );
1005 m_fieldsGrid->ForceRefresh();
1006
1007 m_fieldsGrid->SetGridCursor( i - 1, m_fieldsGrid->GetGridCursorCol() );
1008 m_fieldsGrid->MakeCellVisible( m_fieldsGrid->GetGridCursorRow(),
1009 m_fieldsGrid->GetGridCursorCol() );
1010
1011 OnModify();
1012 }
1013 else
1014 {
1015 wxBell();
1016 }
1017}
1018
1019
1020void DIALOG_SYMBOL_PROPERTIES::OnMoveDown( wxCommandEvent& event )
1021{
1023 return;
1024
1025 int i = m_fieldsGrid->GetGridCursorRow();
1026
1027 if( i >= MANDATORY_FIELDS && i < m_fieldsGrid->GetNumberRows() - 1 )
1028 {
1029 SCH_FIELD tmp = m_fields->at( (unsigned) i );
1030 m_fields->erase( m_fields->begin() + i, m_fields->begin() + i + 1 );
1031 m_fields->insert( m_fields->begin() + i + 1, tmp );
1032 m_fieldsGrid->ForceRefresh();
1033
1034 m_fieldsGrid->SetGridCursor( i + 1, m_fieldsGrid->GetGridCursorCol() );
1035 m_fieldsGrid->MakeCellVisible( m_fieldsGrid->GetGridCursorRow(),
1036 m_fieldsGrid->GetGridCursorCol() );
1037
1038 OnModify();
1039 }
1040 else
1041 {
1042 wxBell();
1043 }
1044}
1045
1046
1048{
1051}
1052
1053
1055{
1058}
1059
1060
1062{
1065}
1066
1067
1069{
1072}
1073
1074
1076{
1077 int row = aEvent.GetRow();
1078
1079 if( m_pinGrid->GetCellValue( row, COL_ALT_NAME )
1080 == m_dataModel->GetValue( row, COL_BASE_NAME ) )
1081 {
1082 m_dataModel->SetValue( row, COL_ALT_NAME, wxEmptyString );
1083 }
1084
1085 // These are just to get the cells refreshed
1088
1089 OnModify();
1090}
1091
1092
1094{
1095 int sortCol = aEvent.GetCol();
1096 bool ascending;
1097
1098 // This is bonkers, but wxWidgets doesn't tell us ascending/descending in the
1099 // event, and if we ask it will give us pre-event info.
1100 if( m_pinGrid->IsSortingBy( sortCol ) )
1101 // same column; invert ascending
1102 ascending = !m_pinGrid->IsSortOrderAscending();
1103 else
1104 // different column; start with ascending
1105 ascending = true;
1106
1107 m_dataModel->SortRows( sortCol, ascending );
1109}
1110
1111
1113{
1114 wxGridUpdateLocker deferRepaintsTillLeavingScope( m_fieldsGrid );
1115
1116 // Account for scroll bars
1117 int fieldsWidth = KIPLATFORM::UI::GetUnobscuredSize( m_fieldsGrid ).x;
1118
1119 m_fieldsGrid->AutoSizeColumn( 0 );
1120 m_fieldsGrid->SetColSize( 0, std::max( 72, m_fieldsGrid->GetColSize( 0 ) ) );
1121
1122 int fixedColsWidth = m_fieldsGrid->GetColSize( 0 );
1123
1124 for( int i = 2; i < m_fieldsGrid->GetNumberCols(); i++ )
1125 fixedColsWidth += m_fieldsGrid->GetColSize( i );
1126
1127 m_fieldsGrid->SetColSize( 1, std::max( 120, fieldsWidth - fixedColsWidth ) );
1128}
1129
1130
1132{
1133 wxGridUpdateLocker deferRepaintsTillLeavingScope( m_pinGrid );
1134
1135 // Account for scroll bars
1136 int pinTblWidth = KIPLATFORM::UI::GetUnobscuredSize( m_pinGrid ).x;
1137
1138 // Stretch the Base Name and Alternate Assignment columns to fit.
1139 for( int i = 0; i < COL_COUNT; ++i )
1140 {
1141 if( i != COL_BASE_NAME && i != COL_ALT_NAME )
1142 pinTblWidth -= m_pinGrid->GetColSize( i );
1143 }
1144
1145 m_pinGrid->SetColSize( COL_BASE_NAME, pinTblWidth / 2 );
1146 m_pinGrid->SetColSize( COL_ALT_NAME, pinTblWidth / 2 );
1147}
1148
1149
1150void DIALOG_SYMBOL_PROPERTIES::OnUpdateUI( wxUpdateUIEvent& event )
1151{
1152 std::bitset<64> shownColumns = m_fieldsGrid->GetShownColumns();
1153
1154 if( shownColumns != m_shownColumns )
1155 {
1156 m_shownColumns = shownColumns;
1157
1158 if( !m_fieldsGrid->IsCellEditControlShown() )
1160 }
1161}
1162
1163
1165{
1166 VECTOR2I *loc = static_cast<VECTOR2I*>( event.GetClientData() );
1167
1168 wxCHECK_RET( loc, wxT( "Missing focus cell location" ) );
1169
1170 // Handle a delayed focus
1171
1172 m_fieldsGrid->SetFocus();
1173 m_fieldsGrid->MakeCellVisible( loc->x, loc->y );
1174 m_fieldsGrid->SetGridCursor( loc->x, loc->y );
1175
1176 m_fieldsGrid->EnableCellEditControl( true );
1177 m_fieldsGrid->ShowCellEditControl();
1178
1179 delete loc;
1180}
1181
1182
1184{
1185 // Handle a delayed selection
1186 wxGridCellEditor* cellEditor = m_fieldsGrid->GetCellEditor( REFERENCE_FIELD, FDC_VALUE );
1187
1188 if( wxTextEntry* txt = dynamic_cast<wxTextEntry*>( cellEditor->GetControl() ) )
1190
1191 cellEditor->DecRef(); // we're done; must release
1192}
1193
1195{
1196 wxSize new_size = event.GetSize();
1197
1198 if( ( !m_editorShown || m_lastRequestedFieldsSize != new_size ) && m_fieldsSize != new_size )
1199 {
1200 m_fieldsSize = new_size;
1201
1203 }
1204
1205 // We store this value to check whether the dialog is changing size. This might indicate
1206 // that the user is scaling the dialog with a grid-cell-editor shown. Some editors do not
1207 // close (at least on GTK) when the user drags a dialog corner
1208 m_lastRequestedFieldsSize = new_size;
1209
1210 // Always propagate for a grid repaint (needed if the height changes, as well as width)
1211 event.Skip();
1212}
1213
1214
1216{
1217 wxSize new_size = event.GetSize();
1218
1219 if( ( !m_editorShown || m_lastRequestedPinsSize != new_size ) && m_pinsSize != new_size )
1220 {
1221 m_pinsSize = new_size;
1222
1224 }
1225
1226 // We store this value to check whether the dialog is changing size. This might indicate
1227 // that the user is scaling the dialog with a grid-cell-editor shown. Some editors do not
1228 // close (at least on GTK) when the user drags a dialog corner
1229 m_lastRequestedPinsSize = new_size;
1230
1231 // Always propagate for a grid repaint (needed if the height changes, as well as width)
1232 event.Skip();
1233}
1234
1235
1236void DIALOG_SYMBOL_PROPERTIES::OnInitDlg( wxInitDialogEvent& event )
1237{
1239
1240 // Now all widgets have the size fixed, call FinishDialogSettings
1242
1243 EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
1244
1245 if( cfg && cfg->m_Appearance.edit_symbol_width > 0 && cfg->m_Appearance.edit_symbol_height > 0 )
1247}
1248
1249
1250void DIALOG_SYMBOL_PROPERTIES::OnCheckBox( wxCommandEvent& event )
1251{
1252 OnModify();
1253}
1254
1255
1256void DIALOG_SYMBOL_PROPERTIES::OnUnitChoice( wxCommandEvent& event )
1257{
1258 if( m_dataModel )
1259 {
1260 EDA_ITEM_FLAGS flags = m_symbol->GetFlags();
1261
1262 int unit_selection = m_unitChoice->GetSelection() + 1;
1263
1264 // We need to select a new unit to build the new unit pin list
1265 // but we should not change the symbol, so the initial unit will be selected
1266 // after rebuilding the pin list
1267 int old_unit = m_symbol->GetUnit();
1268 m_symbol->SetUnit( unit_selection );
1269
1270 // Rebuild a copy of the pins of the new unit for editing
1271 m_dataModel->clear();
1272
1273 for( const std::unique_ptr<SCH_PIN>& pin : m_symbol->GetRawPins() )
1274 m_dataModel->push_back( *pin );
1275
1278
1279 m_symbol->SetUnit( old_unit );
1280
1281 // Restore m_Flag modified by SetUnit()
1283 m_symbol->SetFlags( flags );
1284 }
1285
1286 OnModify();
1287}
1288
1289
1291{
1292 event.Enable( m_symbol && m_symbol->GetLibSymbolRef() );
1293}
1294
1295
1297{
1298 event.Enable( m_symbol && m_symbol->GetLibSymbolRef() );
1299}
1300
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap)
Definition: bitmap.cpp:110
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Create an undo entry for an item that has been already modified.
Definition: commit.h:105
bool Empty() const
Returns status of an item.
Definition: commit.h:144
void SetupStandardButtons(std::map< int, wxString > aLabels={})
void EndQuasiModal(int retCode)
void OnModify()
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:223
Class DIALOG_SYMBOL_PROPERTIES_BASE.
void OnSizePinsGrid(wxSizeEvent &event) override
void OnPinTableCellEdited(wxGridEvent &event) override
void OnGridEditorShown(wxGridEvent &event) override
void OnUpdateUI(wxUpdateUIEvent &event) override
void OnEditSymbol(wxCommandEvent &) override
void OnCancelButtonClick(wxCommandEvent &event) override
virtual void onUpdateEditLibrarySymbol(wxUpdateUIEvent &event) override
SCH_PIN_TABLE_DATA_MODEL * m_dataModel
void OnMoveDown(wxCommandEvent &event) override
void OnSizeFieldsGrid(wxSizeEvent &event) override
void OnPinTableColSort(wxGridEvent &aEvent)
void OnMoveUp(wxCommandEvent &event) override
void OnDeleteField(wxCommandEvent &event) override
void OnInitDlg(wxInitDialogEvent &event) override
void OnAddField(wxCommandEvent &event) override
void OnGridEditorHidden(wxGridEvent &event) override
void OnUnitChoice(wxCommandEvent &event) override
void OnEditSpiceModel(wxCommandEvent &event) override
DIALOG_SYMBOL_PROPERTIES(SCH_EDIT_FRAME *aParent, SCH_SYMBOL *aSymbol)
void HandleDelayedFocus(wxCommandEvent &event)
void HandleDelayedSelection(wxCommandEvent &event)
void OnCheckBox(wxCommandEvent &event) override
void OnGridCellChanging(wxGridEvent &event)
void OnEditLibrarySymbol(wxCommandEvent &) override
void OnUpdateSymbol(wxCommandEvent &) override
FIELDS_GRID_TABLE< SCH_FIELD > * m_fields
void OnExchangeSymbol(wxCommandEvent &) override
virtual void onUpdateEditSymbol(wxUpdateUIEvent &event) override
EDA_ITEM_FLAGS GetEditFlags() const
Definition: eda_item.h:129
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:123
const KIID m_Uuid
Definition: eda_item.h:482
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:125
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:100
EDA_ITEM_FLAGS GetFlags() const
Definition: eda_item.h:126
void SetTextSize(VECTOR2I aNewSize, bool aEnforceMinTextSize=true)
Definition: eda_text.cpp:374
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:95
void Offset(const VECTOR2I &aOffset)
Definition: eda_text.cpp:437
virtual void SetVisible(bool aVisible)
Definition: eda_text.cpp:245
virtual void SetTextAngle(const EDA_ANGLE &aAngle)
Definition: eda_text.cpp:205
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
Definition: grid_tricks.h:61
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:95
Definition: kiid.h:49
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
UTF8 Format() const
Definition: lib_id.cpp:118
@ BASE
Definition: lib_item.h:79
@ DEMORGAN
Definition: lib_item.h:80
std::map< wxString, ALT > & GetAlternates()
Definition: lib_pin.h:142
const wxString & GetName() const
Definition: lib_pin.h:106
bool HasAlternateBodyStyle() const
Test if symbol has more than one body conversion type (DeMorgan).
void SetShowPinNames(bool aShow)
Set or clear the pin name visibility flag.
Definition: lib_symbol.h:632
bool IsPower() const
Definition: lib_symbol.cpp:704
bool ShowPinNames() const
Definition: lib_symbol.h:633
void SetShowPinNumbers(bool aShow)
Set or clear the pin number visibility flag.
Definition: lib_symbol.h:640
bool ShowPinNumbers() const
Definition: lib_symbol.h:641
static int Compare(const wxString &lhs, const wxString &rhs)
These settings were stored in SCH_BASE_FRAME previously.
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:287
wxString ConvertKIIDsToRefs(const wxString &aSource) const
Definition: schematic.cpp:541
wxString ConvertRefsToKIIDs(const wxString &aSource) const
Definition: schematic.cpp:473
virtual void Push(const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
Revert the commit by restoring the modified items state.
Definition: sch_commit.cpp:393
Schematic editor (Eeschema) main window.
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:52
wxString GetCanonicalName() const
Get a non-language-specific name for a field which can be used for storage, variable look-up,...
Definition: sch_field.cpp:1034
wxString GetName(bool aUseDefaultName=true) const
Return the field name (not translated).
Definition: sch_field.cpp:1002
void SetName(const wxString &aName)
Definition: sch_field.cpp:981
void SetText(const wxString &aText) override
Definition: sch_field.cpp:991
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:113
virtual void SetExcludedFromSim(bool aExclude)
Definition: sch_item.h:224
bool IsEmptyCell(int row, int col) override
wxString GetValue(int aRow, int aCol) override
std::vector< wxGridCellAttr * > m_nameAttrs
static bool compare(const SCH_PIN &lhs, const SCH_PIN &rhs, int sortCol, bool ascending)
void SortRows(int aSortCol, bool ascending)
wxGridCellAttr * GetAttr(int aRow, int aCol, wxGridCellAttr::wxAttrKind) override
bool CanSetValueAs(int aRow, int aCol, const wxString &aTypeName) override
static wxString GetValue(const SCH_PIN &aPin, int aCol)
wxString GetColLabelValue(int aCol) override
void SetValue(int aRow, int aCol, const wxString &aValue) override
void SetAlt(const wxString &aAlt)
Definition: sch_pin.h:65
wxString GetAlt() const
Definition: sch_pin.h:64
wxString GetName() const
Definition: sch_pin.cpp:95
LIB_PIN * GetLibPin() const
Definition: sch_pin.h:59
wxString GetNumber() const
Definition: sch_pin.h:145
GRAPHIC_PINSHAPE GetShape() const
Definition: sch_pin.cpp:138
ELECTRICAL_PINTYPE GetType() const
Definition: sch_pin.cpp:127
void Append(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Definition: sch_screen.cpp:150
bool Remove(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Remove aItem from the schematic associated with this screen.
Definition: sch_screen.cpp:320
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Schematic symbol object.
Definition: sch_symbol.h:109
int GetUnitCount() const
Return the number of units per package of the symbol.
Definition: sch_symbol.cpp:486
std::vector< std::unique_ptr< SCH_PIN > > & GetRawPins()
Definition: sch_symbol.h:649
int GetUnit() const
Definition: sch_symbol.h:258
int GetFieldCount() const
Return the number of fields in this symbol.
Definition: sch_symbol.h:588
void SetDNP(bool aDNP)
Definition: sch_symbol.h:868
void SetBodyStyle(int aBodyStyle)
Definition: sch_symbol.cpp:467
void UpdateUnit(int aUnit)
Change the unit number to aUnit without setting any internal flags.
Definition: sch_symbol.cpp:461
wxString SubReference(int aUnit, bool aAddSeparator=true) const
Definition: sch_symbol.cpp:870
static bool IsReferenceStringValid(const wxString &aReferenceString)
Test for an acceptable reference string.
Definition: sch_symbol.cpp:787
void SetValueFieldText(const wxString &aValue)
Definition: sch_symbol.cpp:931
SCH_FIELD * FindField(const wxString &aFieldName, bool aIncludeDefaultFields=true, bool aCaseInsensitive=false)
Search for a SCH_FIELD with aFieldName.
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const
Return the reference for the given sheet path.
Definition: sch_symbol.cpp:751
void SetExcludedFromSim(bool aExclude) override
Definition: sch_symbol.h:859
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
Definition: sch_symbol.cpp:793
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
void SetFootprintFieldText(const wxString &aFootprint)
Definition: sch_symbol.cpp:947
bool GetExcludedFromBOM() const
Definition: sch_symbol.h:861
VECTOR2I GetPosition() const override
Definition: sch_symbol.h:816
bool GetExcludedFromSim() const override
Definition: sch_symbol.h:858
bool HasUnitDisplayName(int aUnit)
Return true if the given unit aUnit has a display name set.
Definition: sch_symbol.cpp:503
void SetExcludedFromBOM(bool aIncludeInBOM)
Definition: sch_symbol.h:862
int GetOrientation() const
Get the display symbol orientation.
bool IsAnnotated(const SCH_SHEET_PATH *aSheet)
Check if the symbol has a valid annotation (reference) for the given sheet path.
Definition: sch_symbol.cpp:829
int GetUnitSelection(const SCH_SHEET_PATH *aSheet) const
Return the instance-specific unit selection for the given sheet path.
Definition: sch_symbol.cpp:879
void SetUnit(int aUnit)
Change the unit number to aUnit.
Definition: sch_symbol.cpp:455
const LIB_ID & GetLibId() const
Definition: sch_symbol.h:203
wxString GetUnitDisplayName(int aUnit)
Return the display name for a given unit aUnit.
Definition: sch_symbol.cpp:495
SCH_PIN * GetPin(const wxString &number) const
Find a symbol pin by number.
bool GetExcludedFromBoard() const
Definition: sch_symbol.h:864
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with SCH_FIELDs.
void SetUnitSelection(const SCH_SHEET_PATH *aSheet, int aUnitSelection)
Set the selected unit of this symbol on one sheet.
Definition: sch_symbol.cpp:895
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef()
Definition: sch_symbol.h:222
void SetExcludedFromBoard(bool aIncludeOnBoard)
Definition: sch_symbol.h:865
int GetBodyStyle() const
Definition: sch_symbol.h:300
bool GetDNP() const
Definition: sch_symbol.h:867
void SetBitmap(const wxBitmapBundle &aBmp)
void ShowHideColumns(const wxString &shownColumns)
Show/hide the grid columns based on a tokenized string of shown column indexes.
Definition: wx_grid.cpp:312
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:156
void DestroyTable(wxGridTableBase *aTable)
Work-around for a bug in wxGrid which crashes when deleting the table if the cell edit control was no...
Definition: wx_grid.cpp:268
wxString GetShownColumnsAsString()
Get a tokenized string containing the shown column indexes.
Definition: wx_grid.cpp:282
std::bitset< 64 > GetShownColumns()
Definition: wx_grid.cpp:301
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:462
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:280
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:305
This file is part of the common library.
wxDEFINE_EVENT(SYMBOL_DELAY_FOCUS, wxCommandEvent)
@ SYMBOL_PROPS_EDIT_SCHEMATIC_SYMBOL
@ SYMBOL_PROPS_WANT_EXCHANGE_SYMBOL
@ SYMBOL_PROPS_WANT_UPDATE_SYMBOL
@ SYMBOL_PROPS_EDIT_LIBRARY_SYMBOL
#define _(s)
std::uint32_t EDA_ITEM_FLAGS
void CollectOtherUnits(const wxString &aRef, int aUnit, const LIB_ID &aLibId, SCH_SHEET_PATH &aSheet, std::vector< SCH_SYMBOL * > *otherUnits)
@ FDC_NAME
@ FDC_VALUE
wxColour GetDialogBGColour()
Definition: gtk/ui.cpp:61
wxSize GetUnobscuredSize(const wxWindow *aWindow)
Tries to determine the size of the viewport of a scrollable widget (wxDataViewCtrl,...
Definition: gtk/ui.cpp:195
void SelectReferenceNumber(wxTextEntry *aTextEntry)
Select the number (or "?") in a reference for ease of editing.
Definition: ui_common.cpp:225
const std::vector< BITMAPS > & PinTypeIcons()
Definition: pin_type.cpp:151
const wxArrayString & PinTypeNames()
Definition: pin_type.cpp:142
const wxArrayString & PinShapeNames()
Definition: pin_type.cpp:160
const std::vector< BITMAPS > & PinShapeIcons()
Definition: pin_type.cpp:169
std::vector< SCH_FIELD > SCH_FIELDS
A container for several SCH_FIELD items.
Definition: sch_symbol.h:70
@ SYM_ORIENT_270
Definition: sch_symbol.h:88
@ SYM_MIRROR_Y
Definition: sch_symbol.h:90
@ SYM_ORIENT_180
Definition: sch_symbol.h:87
@ SYM_MIRROR_X
Definition: sch_symbol.h:89
@ SYM_ORIENT_90
Definition: sch_symbol.h:86
@ SYM_ORIENT_0
Definition: sch_symbol.h:85
int StrNumCmp(const wxString &aString1, const wxString &aString2, bool aIgnoreCase)
Compare two strings with alphanumerical content.
wxString UnescapeString(const wxString &aSource)
Hold a name of a symbol's field, field value, and default visibility.
static const wxString GetDefaultFieldName(int aFieldNdx, bool aTranslateForHI=false)
Return a default symbol field name for field aFieldNdx for all components.
Definition for symbol library class.
#define DO_TRANSLATE
@ DATASHEET_FIELD
name of datasheet
@ FOOTPRINT_FIELD
Field Name Module PCB, i.e. "16DIP300".
@ VALUE_FIELD
Field Value of part, i.e. "3.3K".
@ MANDATORY_FIELDS
The first 5 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
@ REFERENCE_FIELD
Field Reference of part, i.e. "IC21".
VECTOR3I res
VECTOR2< int > VECTOR2I
Definition: vector2d.h:588