KiCad PCB EDA Suite
dialog_edit_component_in_schematic.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-2018 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 
24 
25 #include <wx/tooltip.h>
26 #include <wx/hyperlink.h>
27 #include <wx/url.h>
28 
29 #include <fctsys.h>
30 #include <pgm_base.h>
31 #include <kiway.h>
32 #include <class_drawpanel.h>
33 #include <confirm.h>
34 #include <sch_edit_frame.h>
35 #include <base_units.h>
36 
37 #include <sch_reference_list.h>
38 #include <class_library.h>
39 #include <sch_component.h>
40 #include <dialog_helpers.h>
41 #include <sch_validators.h>
42 #include <kicad_device_context.h>
43 #include <symbol_lib_table.h>
44 
45 #include <bitmaps.h>
46 
48 #include <invoke_sch_dialog.h>
49 
50 #ifdef KICAD_SPICE
51 #include <dialog_spice_model.h>
53 #endif /* KICAD_SPICE */
54 
55 #include "common.h"
56 #include "eda_doc.h"
57 #include <list>
58 
59 
67 {
68 public:
70 
76  void InitBuffers( SCH_COMPONENT* aComponent );
77 
78  SCH_EDIT_FRAME* GetParent() { return dynamic_cast< SCH_EDIT_FRAME* >( wxDialog::GetParent() ); }
79 
80 private:
81 
82  friend class SCH_EDIT_FRAME;
83 
87 
88  static int s_SelectedRow;
89 
92 
93  void setSelectedFieldNdx( int aFieldNdx );
94 
95  int getSelectedFieldNdx();
96 
101 
109 
110  void copyOptionsToPanel();
111 
112  void copyPanelToOptions();
113 
114  void setRowItem( int aFieldNdx, const wxString& aName, const wxString& aValue );
115 
116  void setRowItem( int aFieldNdx, const SCH_FIELD& aField )
117  {
118  // Use default field name for mandatory fields, because they are transalted
119  // according to the current locale
120  wxString f_name;
121 
122  if( aFieldNdx < MANDATORY_FIELDS )
123  f_name = TEMPLATE_FIELDNAME::GetDefaultFieldName( aFieldNdx );
124  else
125  f_name = aField.GetName( false );
126 
127  setRowItem( aFieldNdx, f_name, aField.GetText() );
128  }
129 
130  // event handlers
131  void OnCloseDialog( wxCloseEvent& event ) override;
132  void OnListItemDeselected( wxListEvent& event ) override;
133  void OnListItemSelected( wxListEvent& event ) override;
134  void OnCancelButtonClick( wxCommandEvent& event ) override;
135  void OnOKButtonClick( wxCommandEvent& event ) override;
136  void SetInitCmp( wxCommandEvent& event ) override;
137  void UpdateFields( wxCommandEvent& event ) override;
138  void addFieldButtonHandler( wxCommandEvent& event ) override;
139  void deleteFieldButtonHandler( wxCommandEvent& event ) override;
140  void moveUpButtonHandler( wxCommandEvent& event ) override;
141  void moveDownButtonHandler( wxCommandEvent& event ) override;
142  void showButtonHandler( wxCommandEvent& event ) override;
143  void OnTestChipName( wxCommandEvent& event ) override;
144  void OnSelectChipName( wxCommandEvent& event ) override;
145  void OnSizeFieldsList( wxSizeEvent& event ) override;
146  void OnInitDlg( wxInitDialogEvent& event ) override
147  {
148  TransferDataToWindow();
149 
150  // Now all widgets have the size fixed, call FinishDialogSettings
152  }
153 
154  void EditSpiceModel( wxCommandEvent& event ) override;
155 
156  SCH_FIELD* findField( const wxString& aFieldName );
157 
164  {
165  fieldListCtrl->DeleteAllItems();
166 
167  for( unsigned ii = 0; ii < m_FieldsBuf.size(); ii++ )
168  setRowItem( ii, m_FieldsBuf[ii] );
169  }
170 };
171 
172 
174 
175 
177 {
178  wxCHECK_RET( aComponent != NULL && aComponent->Type() == SCH_COMPONENT_T,
179  wxT( "Invalid component object pointer. Bad Programmer!" ) );
180 
182 
184 
185  dlg->InitBuffers( aComponent );
186 
187  // make sure the chipnameTextCtrl is wide enough to hold any unusually long chip names:
189 
190  // This dialog itself subsequently can invoke a KIWAY_PLAYER as a quasimodal
191  // frame. Therefore this dialog as a modal frame parent, MUST be run under
192  // quasimodal mode for the quasimodal frame support to work. So don't use
193  // the QUASIMODAL macros here.
194  int ret = dlg->ShowQuasiModal();
195 
196  if( m_autoplaceFields )
197  aComponent->AutoAutoplaceFields( GetScreen() );
198 
199  m_canvas->SetIgnoreMouseEvents( false );
201  dlg->Destroy();
202 
203  if( ret == wxID_OK )
204  GetCanvas()->Refresh();
205 }
206 
207 
210 {
211 #ifndef KICAD_SPICE
212  spiceFieldsButton->Hide();
213 #endif /* not KICAD_SPICE */
214 
215  m_cmp = NULL;
216  m_part = NULL;
217  m_skipCopyFromPanel = false;
218 
219  wxListItem columnLabel;
220 
221  columnLabel.SetImage( -1 );
222 
223  columnLabel.SetText( _( "Name" ) );
224  fieldListCtrl->InsertColumn( 0, columnLabel );
225 
226  columnLabel.SetText( _( "Value" ) );
227  fieldListCtrl->InsertColumn( 1, columnLabel );
228 
232 
233  wxToolTip::Enable( true );
234  stdDialogButtonSizerOK->SetDefault();
235 
236  // Configure button logos
237  addFieldButton->SetBitmap( KiBitmap( plus_xpm ) );
238  deleteFieldButton->SetBitmap( KiBitmap( minus_xpm ) );
239  moveUpButton->SetBitmap( KiBitmap( go_up_xpm ) );
240  moveDownButton->SetBitmap( KiBitmap( go_down_xpm ) );
241 
242  Fit();
243 }
244 
245 
247 {
248  if( !m_skipCopyFromPanel )
249  {
250  if( !copyPanelToSelectedField() )
251  event.Skip(); // do not go to the next row
252  }
253 }
254 
256 {
257  LIB_ID id;
258  wxString msg;
259  wxString partname = chipnameTextCtrl->GetValue();
260 
261  if( id.Parse( partname ) != -1 || !id.IsValid() )
262  {
263  msg.Printf( _( "\"%s\" is not a valid library symbol identifier." ), partname );
264  DisplayError( this, msg );
265  return;
266  }
267 
268  LIB_ALIAS* alias = NULL;
269 
270  try
271  {
272  alias = Prj().SchSymbolLibTable()->LoadSymbol( id );
273  }
274  catch( ... )
275  {
276  }
277 
278  if( !alias )
279  {
280  msg.Printf( _( "Symbol \"%s\" not found in library \"%s\"" ),
281  id.GetLibItemName().wx_str(), id.GetLibNickname().wx_str() );
282  DisplayError( this, msg );
283  return;
284  }
285 
286  msg.Printf( _( "Symbol \"%s\" found in library \"%s\"" ),
287  id.GetLibItemName().wx_str(), id.GetLibNickname().wx_str() );
288 
289  DisplayInfoMessage( this, msg );
290 }
291 
292 
294 {
296 
297  auto sel = GetParent()->SelectComponentFromLibrary( NULL, dummy, true, 0, 0, false );
298 
299  if( !sel.LibId.IsValid() )
300  return;
301 
302  chipnameTextCtrl->SetValue( sel.LibId.Format() );
303 }
304 
305 
307 {
308 #ifdef KICAD_SPICE
309  setSelectedFieldNdx( 0 );
310  DIALOG_SPICE_MODEL dialog( this, *m_cmp, m_FieldsBuf );
311 
312  if( dialog.ShowModal() == wxID_OK )
313  updateDisplay();
314 #endif /* KICAD_SPICE */
315 }
316 
317 
319 {
320  // remember the selected row, statically
321  s_SelectedRow = event.GetIndex();
322 
324 }
325 
326 
328 {
329  // On wxWidgets 2.8, and on Linux, calling EndQuasiModal here is mandatory
330  // Otherwise, the main event loop is never restored, and Eeschema does not
331  // respond to any event, because the DIALOG_SHIM destructor is never called.
332  // On wxWidgets 3.0, or on Windows, the DIALOG_SHIM destructor is called,
333  // and calls EndQuasiModal.
334  // therefore calling EndQuasiModal here is not always mandatory but it creates no issues
335  EndQuasiModal( wxID_CANCEL );
336 }
337 
338 
340 {
341  EndQuasiModal( wxID_CANCEL );
342 }
343 
344 
346 {
347  LIB_ID id;
348  wxString msg;
349  wxString tmp = chipnameTextCtrl->GetValue();
350 
351  tmp.Replace( wxT( " " ), wxT( "_" ) );
352 
353  id.Parse( tmp );
354 
355  // Save current flags which could be modified by next change settings
356  STATUS_FLAGS flags = m_cmp->GetFlags();
357 
358  if( !id.IsValid() )
359  {
360  msg.Printf( _( "Symbol library identifier \"%s\" is not valid!" ), tmp );
361  DisplayError( this, msg );
362  }
363  else if( id != m_cmp->GetLibId() )
364  {
365  LIB_ALIAS* alias = NULL;
366 
367  try
368  {
369  alias = Prj().SchSymbolLibTable()->LoadSymbol( id );
370  }
371  catch( ... )
372  {
373  }
374 
375  if( !alias )
376  {
377  msg.Printf( _( "Symbol \"%s\" not found in library \"%s\"!" ),
378  id.GetLibItemName().wx_str(), id.GetLibNickname().wx_str() );
379  DisplayError( this, msg );
380  }
381  else // Change symbol from lib!
382  {
383  m_cmp->SetLibId( id, Prj().SchSymbolLibTable(), Prj().SchLibs()->GetCacheLibrary() );
384  }
385  }
386 
387  // For symbols with multiple shapes (De Morgan representation) Set the selected shape:
388  if( convertCheckBox->IsEnabled() )
389  {
390  m_cmp->SetConvert( convertCheckBox->GetValue() ? 2 : 1 );
391  }
392 
393  //Set the part selection in multiple part per package
394  if( m_cmp->GetUnitCount() > 1 )
395  {
396  int unit_selection = unitChoice->GetCurrentSelection() + 1;
397 
398  m_cmp->SetUnitSelection( &GetParent()->GetCurrentSheet(), unit_selection );
399  m_cmp->SetUnit( unit_selection );
400  }
401 
402  switch( orientationRadioBox->GetSelection() )
403  {
404  case 0:
406  break;
407 
408  case 1:
410  break;
411 
412  case 2:
414  break;
415 
416  case 3:
418  break;
419  }
420 
421  int mirror = mirrorRadioBox->GetSelection();
422 
423  switch( mirror )
424  {
425  case 0:
426  break;
427 
428  case 1:
430  break;
431 
432  case 2:
434  break;
435  }
436 
437  // Restore m_Flag modified by SetUnit() and other change settings
438  m_cmp->ClearFlags();
439  m_cmp->SetFlags( flags );
440 }
441 
442 
444 {
445  bool removeRemainingFields = false;
446 
447  if( !copyPanelToSelectedField() )
448  return;
449 
451  {
452  DisplayError( NULL, _( "Illegal reference. References must start with a letter" ) );
453  return;
454  }
455 
456  // save old cmp in undo list if not already in edit, or moving ...
457  // or the component to be edited is part of a block
458  if( m_cmp->GetFlags() == 0
461 
463 
464  // Delete any fields with no name before we copy all of m_FieldsBuf back into the component.
465  for( unsigned i = MANDATORY_FIELDS; i<m_FieldsBuf.size(); )
466  {
467  if( m_FieldsBuf[i].GetName( false ).IsEmpty() || m_FieldsBuf[i].GetText().IsEmpty() )
468  {
469  // If a field has no value and is not it the field template list, warn the user
470  // that it will be remove from the component. This gives the user a chance to
471  // correct the problem before removing the undefined fields. It should also
472  // resolve most of the bug reports and questions regarding missing fields.
473  if( !m_FieldsBuf[i].GetName( false ).IsEmpty() && m_FieldsBuf[i].GetText().IsEmpty()
474  && !GetParent()->GetTemplates().HasFieldName( m_FieldsBuf[i].GetName( false ) )
475  && !removeRemainingFields )
476  {
477  wxString msg = wxString::Format(
478  _( "The field name \"%s\" does not have a value and is not defined in "
479  "the field template list. Empty field values are invalid an will "
480  "be removed from the component. Do you wish to remove this and "
481  "all remaining undefined fields?" ),
482  GetChars( m_FieldsBuf[i].GetName( false ) )
483  );
484 
485  wxMessageDialog dlg( this, msg, _( "Remove Fields" ), wxYES_NO | wxNO_DEFAULT );
486 
487  if( dlg.ShowModal() == wxID_NO )
488  return;
489 
490  removeRemainingFields = true;
491  }
492 
493  m_FieldsBuf.erase( m_FieldsBuf.begin() + i );
494  continue;
495  }
496 
497  ++i;
498  }
499 
500  // change all field positions from relative to absolute
501  for( unsigned i = 0; i<m_FieldsBuf.size(); ++i )
502  {
503  m_FieldsBuf[i].Offset( m_cmp->m_Pos );
504  }
505 
506  LIB_PART* entry = GetParent()->GetLibPart( m_cmp->GetLibId() );
507 
508  if( entry && entry->IsPower() )
509  m_FieldsBuf[VALUE].SetText( m_cmp->GetLibId().GetLibItemName() );
510 
511  // copy all the fields back, and change the length of m_Fields.
513 
514  // Reference has a specific initialization, depending on the current active sheet
515  // because for a given component, in a complex hierarchy, there are more than one
516  // reference.
518 
519  // The value, footprint and datasheet fields should be kept in sync in multi-unit
520  // parts.
521  if( m_cmp->GetUnitCount() > 1 )
522  {
523  const LIB_ID thisLibId = m_cmp->GetLibId();
524  const wxString thisRef = m_cmp->GetRef( &( GetParent()->GetCurrentSheet() ) );
525  int thisUnit = m_cmp->GetUnit();
526 
527  SCH_REFERENCE_LIST components;
528  GetParent()->GetCurrentSheet().GetComponents( components );
529  for( unsigned i = 0; i < components.GetCount(); i++ )
530  {
531  SCH_REFERENCE component = components[i];
532  if( component.GetLibPart()->GetLibId() == thisLibId
533  && component.GetRef() == thisRef
534  && component.GetUnit() != thisUnit )
535  {
536  SCH_COMPONENT* otherUnit = component.GetComp();
537  GetParent()->SaveCopyInUndoList( otherUnit, UR_CHANGED, true /* append */);
538  otherUnit->GetField( VALUE )->SetText( m_FieldsBuf[VALUE].GetText() );
539  otherUnit->GetField( FOOTPRINT )->SetText( m_FieldsBuf[FOOTPRINT].GetText() );
540  otherUnit->GetField( DATASHEET )->SetText( m_FieldsBuf[DATASHEET].GetText() );
541  }
542  }
543  }
544 
545  GetParent()->OnModify();
547 
548  EndQuasiModal( wxID_OK );
549 }
550 
551 
553 {
554  // in case m_FieldsBuf[REFERENCE].m_Orient has changed on screen only, grab
555  // screen contents.
556  if( !copyPanelToSelectedField() )
557  return;
558 
559  unsigned fieldNdx = m_FieldsBuf.size();
560 
561  SCH_FIELD blank( wxPoint(), fieldNdx, m_cmp );
562 
563  blank.SetTextAngle( m_FieldsBuf[REFERENCE].GetTextAngle() );
564 
565  m_FieldsBuf.push_back( blank );
566  m_FieldsBuf[fieldNdx].SetName( TEMPLATE_FIELDNAME::GetDefaultFieldName( fieldNdx ) );
567 
568  m_skipCopyFromPanel = true;
569  setRowItem( fieldNdx, m_FieldsBuf[fieldNdx] );
570 
571  setSelectedFieldNdx( fieldNdx );
572  m_skipCopyFromPanel = false;
573 }
574 
575 
577 {
578  unsigned fieldNdx = getSelectedFieldNdx();
579 
580  if( fieldNdx >= m_FieldsBuf.size() ) // traps the -1 case too
581  return;
582 
583  if( fieldNdx < MANDATORY_FIELDS )
584  {
585  wxBell();
586  return;
587  }
588 
589  m_skipCopyFromPanel = true;
590  m_FieldsBuf.erase( m_FieldsBuf.begin() + fieldNdx );
591  fieldListCtrl->DeleteItem( fieldNdx );
592 
593  if( fieldNdx >= m_FieldsBuf.size() )
594  --fieldNdx;
595 
596  updateDisplay();
597 
598  setSelectedFieldNdx( fieldNdx );
599  m_skipCopyFromPanel = false;
600 }
601 
602 
604 {
605  unsigned fieldNdx = getSelectedFieldNdx();
606 
607  if( fieldNdx == DATASHEET )
608  {
609  wxString datasheet_uri = fieldValueTextCtrl->GetValue();
610  datasheet_uri = ResolveUriByEnvVars( datasheet_uri );
611  GetAssociatedDocument( this, datasheet_uri );
612  }
613  else if( fieldNdx == FOOTPRINT )
614  {
615  // pick a footprint using the footprint picker.
616  wxString fpid = fieldValueTextCtrl->GetValue();
617 
618  KIWAY_PLAYER* frame = Kiway().Player( FRAME_PCB_MODULE_VIEWER_MODAL, true, this );
619 
620  if( frame->ShowModal( &fpid, this ) )
621  {
622  // DBG( printf( "%s: %s\n", __func__, TO_UTF8( fpid ) ); )
623  fieldValueTextCtrl->SetValue( fpid );
624 
625  setRowItem( fieldNdx, m_FieldsBuf[fieldNdx].GetName( false ), fpid );
626  }
627 
628  frame->Destroy();
629  }
630 }
631 
632 
634 {
635  unsigned fieldNdx = getSelectedFieldNdx();
636 
637  if( fieldNdx >= m_FieldsBuf.size() ) // traps the -1 case too
638  return;
639 
640  if( fieldNdx <= MANDATORY_FIELDS )
641  {
642  wxBell();
643  return;
644  }
645 
646  if( !copyPanelToSelectedField() )
647  return;
648 
649  // swap the fieldNdx field with the one before it, in both the vector
650  // and in the fieldListCtrl
651  SCH_FIELD tmp = m_FieldsBuf[fieldNdx - 1];
652 
653  DBG( printf( "tmp.m_Text=\"%s\" tmp.m_Name=\"%s\"\n",
654  TO_UTF8( tmp.GetText() ), TO_UTF8( tmp.GetName( false ) ) ); )
655 
656  m_FieldsBuf[fieldNdx - 1] = m_FieldsBuf[fieldNdx];
657  setRowItem( fieldNdx - 1, m_FieldsBuf[fieldNdx] );
658 
659  m_FieldsBuf[fieldNdx] = tmp;
660  setRowItem( fieldNdx, tmp );
661 
662  updateDisplay();
663 
664  m_skipCopyFromPanel = true;
665  setSelectedFieldNdx( fieldNdx - 1 );
666  m_skipCopyFromPanel = false;
667 }
668 
669 
671 {
672  unsigned fieldNdx = getSelectedFieldNdx();
673 
674  // Ensure there is at least one field after this one
675  if( fieldNdx >= ( m_FieldsBuf.size() - 1 ) )
676  {
677  return;
678  }
679 
680  // The first field which can be moved up is the second user field
681  // so any field which id < MANDATORY_FIELDS cannot be moved down
682  if( fieldNdx < MANDATORY_FIELDS )
683  return;
684 
685  if( !copyPanelToSelectedField() )
686  return;
687 
688  // swap the fieldNdx field with the one before it, in both the vector
689  // and in the fieldListCtrl
690  SCH_FIELD tmp = m_FieldsBuf[fieldNdx + 1];
691 
692  m_FieldsBuf[fieldNdx + 1] = m_FieldsBuf[fieldNdx];
693  setRowItem( fieldNdx + 1, m_FieldsBuf[fieldNdx] );
694  m_FieldsBuf[fieldNdx + 1].SetId( fieldNdx + 1 );
695 
696  m_FieldsBuf[fieldNdx] = tmp;
697  setRowItem( fieldNdx, tmp );
698  m_FieldsBuf[fieldNdx].SetId( fieldNdx );
699 
700  updateDisplay( );
701 
702  m_skipCopyFromPanel = true;
703  setSelectedFieldNdx( fieldNdx + 1 );
704  m_skipCopyFromPanel = false;
705 }
706 
707 
709 {
710  /* deselect old selection, but I think this is done by single selection
711  * flag within fieldListCtrl.
712  * fieldListCtrl->SetItemState( s_SelectedRow, 0,
713  * wxLIST_STATE_SELECTED|wxLIST_STATE_FOCUSED);
714  */
715 
716  if( aFieldNdx >= (int) m_FieldsBuf.size() )
717  aFieldNdx = m_FieldsBuf.size() - 1;
718 
719  if( aFieldNdx < 0 )
720  aFieldNdx = 0;
721 
722  fieldListCtrl->SetItemState( aFieldNdx, wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED );
723  fieldListCtrl->EnsureVisible( aFieldNdx );
724 
725  s_SelectedRow = aFieldNdx;
726 }
727 
728 
730 {
731  return s_SelectedRow;
732 }
733 
734 
736 {
737  for( unsigned i=0; i<m_FieldsBuf.size(); ++i )
738  {
739  if( aFieldName == m_FieldsBuf[i].GetName( false ) )
740  return &m_FieldsBuf[i];
741  }
742 
743  return NULL;
744 }
745 
746 
748 {
749  m_cmp = aComponent;
750 
751  /* We have 3 component related field lists to be aware of: 1) UI
752  presentation, 2) fields in component ram copy, and 3) fields recorded
753  with component on disk. m_FieldsBuf is the list of UI fields, and this
754  list is not the same as the list which is in the component, which is
755  also not the same as the list on disk. All 3 lists are potentially
756  different. In the UI we choose to preserve the order of the first
757  MANDATORY_FIELDS which are sometimes called fixed fields. Then we append
758  the template fieldnames in the exact same order as the template
759  fieldname editor shows them. Then we append any user defined fieldnames
760  which came from the component.
761  */
762 
763  m_part = GetParent()->GetLibPart( m_cmp->GetLibId(), true );
764 
765 #if 0 && defined(DEBUG)
766  for( int i = 0; i<aComponent->GetFieldCount(); ++i )
767  {
768  printf( "Orig[%d] (x=%d, y=%d)\n", i,
769  aComponent->m_Fields[i].GetTextPos().x,
770  aComponent->m_Fields[i].GetTextPos().y );
771  }
772 
773 #endif
774 
775  // When this code was written, all field constructors ensure that the fixed fields
776  // are all present within a component. So we can knowingly copy them over
777  // in the normal order. Copy only the fixed fields at first.
778  // Please do not break the field constructors.
779 
780  m_FieldsBuf.clear();
781 
782  for( int i=0; i<MANDATORY_FIELDS; ++i )
783  {
784  m_FieldsBuf.push_back( aComponent->m_Fields[i] );
785 
786  // make the editable field position relative to the component
787  m_FieldsBuf[i].Offset( -m_cmp->m_Pos );
788 
789  // Ensure the Field name reflects the default name, even if the
790  // local has changed since schematic was read
792  }
793 
794  // Add template fieldnames:
795  // Now copy in the template fields, in the order that they are present in the
796  // template field editor UI.
798 
799  for( TEMPLATE_FIELDNAMES::const_iterator it = tfnames.begin(); it!=tfnames.end(); ++it )
800  {
801  // add a new field unconditionally to the UI only
802  SCH_FIELD fld( wxPoint(0,0), -1 /* id is a relic */, m_cmp, it->m_Name );
803 
804  // See if field by same name already exists in component.
805  SCH_FIELD* schField = aComponent->FindField( it->m_Name );
806 
807  // If the field does not already exist in the component, then we
808  // use defaults from the template fieldname, otherwise the original
809  // values from the component will be set.
810  if( !schField )
811  {
812  if( !it->m_Visible )
813  fld.SetVisible( false );
814  else
815  fld.SetVisible( true );
816 
817  fld.SetText( it->m_Value ); // empty? ok too.
818  }
819  else
820  {
821  fld = *schField;
822 
823  // make the editable field position relative to the component
824  fld.Offset( -m_cmp->m_Pos );
825  }
826 
827  m_FieldsBuf.push_back( fld );
828  }
829 
830  // Lastly, append any original fields from the component which were not added
831  // from the set of fixed fields nor from the set of template fields.
832  for( unsigned i=MANDATORY_FIELDS; i<aComponent->m_Fields.size(); ++i )
833  {
834  SCH_FIELD* cmp = &aComponent->m_Fields[i];
835  SCH_FIELD* buf = findField( cmp->GetName( false ) );
836 
837  if( !buf )
838  {
839  int newNdx = m_FieldsBuf.size();
840  m_FieldsBuf.push_back( *cmp );
841 
842  // make the editable field position relative to the component
843  m_FieldsBuf[newNdx].Offset( -m_cmp->m_Pos );
844  }
845  }
846 
847 
848 #if 0 && defined(DEBUG)
849  for( unsigned i = 0; i<m_FieldsBuf.size(); ++i )
850  {
851  printf( "m_FieldsBuf[%d] (x=%-3d, y=%-3d) name:%s\n", i, m_FieldsBuf[i].m_Pos.x,
852  m_FieldsBuf[i].m_Pos.y, TO_UTF8(m_FieldsBuf[i].GetName( false ) ) );
853  }
854 #endif
855 
857 
858  for( unsigned i = 0; i<m_FieldsBuf.size(); ++i )
859  {
860  setRowItem( i, m_FieldsBuf[i] );
861  }
862 
863 #if 0 && defined(DEBUG)
864  for( unsigned i = 0; i<m_FieldsBuf.size(); ++i )
865  {
866  printf( "after[%d] (x=%d, y=%d)\n", i, m_FieldsBuf[i].m_Pos.x,
867  m_FieldsBuf[i].m_Pos.y );
868  }
869 
870 #endif
871 
873 
874  // disable some options inside the edit dialog
875  // which can cause problems while dragging
876  if( m_cmp->IsDragging() )
877  {
878  orientationRadioBox->Disable();
879  mirrorRadioBox->Disable();
880  chipnameTextCtrl->Disable();
881  }
882 
883  // put focus on the list ctrl
884  fieldListCtrl->SetFocus();
885 
886  // resume editing at the last row edited, last time dialog was up.
888 
890 }
891 
892 
893 void DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::setRowItem( int aFieldNdx, const wxString& aName, const wxString& aValue )
894 {
895  wxASSERT( aFieldNdx >= 0 );
896 
897  // insert blanks if aFieldNdx is referencing a "yet to be defined" row
898  while( aFieldNdx >= fieldListCtrl->GetItemCount() )
899  {
900  long ndx = fieldListCtrl->InsertItem( fieldListCtrl->GetItemCount(), wxEmptyString );
901 
902  wxASSERT( ndx >= 0 );
903 
904  fieldListCtrl->SetItem( ndx, 1, wxEmptyString );
905  }
906 
907  fieldListCtrl->SetItem( aFieldNdx, 0, aName );
908  fieldListCtrl->SetItem( aFieldNdx, 1, aValue );
909 
910  // recompute the column widths here, after setting texts
911  int totalWidth = fieldListCtrl->GetSize().GetWidth();
912  fieldListCtrl->SetColumnWidth( 0, wxLIST_AUTOSIZE );
913  fieldListCtrl->SetColumnWidth( 1, totalWidth - fieldListCtrl->GetColumnWidth( 0 ) );
914 }
915 
916 
918 {
919  wxCHECK_RET( m_cmp != NULL, wxT( "Component pointer not initialized." ) );
920 
921  unsigned fieldNdx = getSelectedFieldNdx();
922 
923  if( fieldNdx >= m_FieldsBuf.size() ) // traps the -1 case too
924  return;
925 
926  SCH_FIELD& field = m_FieldsBuf[fieldNdx];
927 
928  showCheckBox->SetValue( field.IsVisible() );
929 
930  rotateCheckBox->SetValue( field.GetTextAngle() == TEXT_ANGLE_VERT );
931 
932  int style = 0;
933 
934  if( field.IsItalic() )
935  style = 1;
936 
937  if( field.IsBold() )
938  style |= 2;
939 
940  m_StyleRadioBox->SetSelection( style );
941 
942  // Select the right text justification
943  if( field.GetHorizJustify() == GR_TEXT_HJUSTIFY_LEFT )
944  m_FieldHJustifyCtrl->SetSelection( 0 );
945  else if( field.GetHorizJustify() == GR_TEXT_HJUSTIFY_RIGHT )
946  m_FieldHJustifyCtrl->SetSelection( 2 );
947  else
948  m_FieldHJustifyCtrl->SetSelection( 1 );
949 
950  if( field.GetVertJustify() == GR_TEXT_VJUSTIFY_TOP )
951  m_FieldVJustifyCtrl->SetSelection( 0 );
952  else if( field.GetVertJustify() == GR_TEXT_VJUSTIFY_BOTTOM )
953  m_FieldVJustifyCtrl->SetSelection( 2 );
954  else
955  m_FieldVJustifyCtrl->SetSelection( 1 );
956 
957 
958  fieldNameTextCtrl->SetValue( field.GetName( false ) );
959 
960  // the names of the fixed fields are not editable, others are.
961  fieldNameTextCtrl->Enable( fieldNdx >= MANDATORY_FIELDS );
962  fieldNameTextCtrl->SetEditable( fieldNdx >= MANDATORY_FIELDS );
963 
964  // only user defined fields may be moved, and not the top most user defined
965  // field since it would be moving up into the fixed fields, > not >=
966  moveUpButton->Enable( fieldNdx > MANDATORY_FIELDS );
967  moveDownButton->Enable( ( fieldNdx >= MANDATORY_FIELDS ) && ( fieldNdx < ( m_FieldsBuf.size() - 1 ) ) );
968 
969  // may only delete user defined fields
970  deleteFieldButton->Enable( fieldNdx >= MANDATORY_FIELDS );
971 
972  fieldValueTextCtrl->SetValidator( SCH_FIELD_VALIDATOR( false, field.GetId() ) );
973  fieldValueTextCtrl->SetValue( field.GetText() );
974 
975  m_show_datasheet_button->Enable( fieldNdx == DATASHEET || fieldNdx == FOOTPRINT );
976 
977  if( fieldNdx == DATASHEET )
978  {
979  m_show_datasheet_button->SetLabel( _( "Show Datasheet" ) );
980  m_show_datasheet_button->SetToolTip(
981  _("If your datasheet is given as an http:// link,"
982  " then pressing this button should bring it up in your webbrowser.") );
983  }
984  else if( fieldNdx == FOOTPRINT )
985  {
986  m_show_datasheet_button->SetLabel( _( "Browse Footprints" ) );
987  m_show_datasheet_button->SetToolTip(
988  _("Open the footprint browser to choose a footprint and assign it.") );
989  }
990  else
991  {
992  m_show_datasheet_button->SetLabel( wxEmptyString );
993  m_show_datasheet_button->SetToolTip(
994  _("Used only for fields Footprint and Datasheet.") );
995  }
996 
997  // For power symbols, the value is NOR editable, because value and pin
998  // name must be same and can be edited only in library editor
999  if( fieldNdx == VALUE && m_part && m_part->IsPower() )
1000  fieldValueTextCtrl->Enable( false );
1001  else
1002  fieldValueTextCtrl->Enable( true );
1003 
1005 
1006  wxPoint coord = field.GetTextPos();
1007  wxPoint zero = -m_cmp->m_Pos; // relative zero
1008 
1009  // If the field value is empty and the position is at relative zero, we
1010  // set the initial position as a small offset from the ref field, and
1011  // orient it the same as the ref field. That is likely to put it at least
1012  // close to the desired position.
1013  if( coord == zero && field.GetText().IsEmpty() )
1014  {
1015  rotateCheckBox->SetValue( m_FieldsBuf[REFERENCE].GetTextAngle() == TEXT_ANGLE_VERT );
1016 
1017  coord.x = m_FieldsBuf[REFERENCE].GetTextPos().x
1018  + ( fieldNdx - MANDATORY_FIELDS + 1 ) * 100;
1019 
1020  coord.y = m_FieldsBuf[REFERENCE].GetTextPos().y
1021  + ( fieldNdx - MANDATORY_FIELDS + 1 ) * 100;
1022 
1023  // coord can compute negative if field is < MANDATORY_FIELDS, e.g. FOOTPRINT.
1024  // That is ok, we basically don't want all the new empty fields on
1025  // top of each other.
1026  }
1027 
1028  wxString coordText = StringFromValue( g_UserUnit, coord.x );
1029  posXTextCtrl->SetValue( coordText );
1030 
1031  coordText = StringFromValue( g_UserUnit, coord.y );
1032  posYTextCtrl->SetValue( coordText );
1033 }
1034 
1035 
1037 {
1038  unsigned fieldNdx = getSelectedFieldNdx();
1039 
1040  if( fieldNdx >= m_FieldsBuf.size() ) // traps the -1 case too
1041  return true;
1042 
1043  // Check for illegal field text.
1044  if( fieldValueTextCtrl->GetValidator()
1045  && !fieldValueTextCtrl->GetValidator()->Validate( this ) )
1046  return false;
1047 
1048  SCH_FIELD& field = m_FieldsBuf[fieldNdx];
1049 
1050  field.SetVisible( showCheckBox->GetValue() );
1051 
1052  if( rotateCheckBox->GetValue() )
1053  field.SetTextAngle( TEXT_ANGLE_VERT );
1054  else
1055  field.SetTextAngle( TEXT_ANGLE_HORIZ );
1056 
1057  rotateCheckBox->SetValue( field.GetTextAngle() == TEXT_ANGLE_VERT );
1058 
1059  // Copy the text justification
1060  static const EDA_TEXT_HJUSTIFY_T hjustify[] = {
1064  };
1065 
1066  static const EDA_TEXT_VJUSTIFY_T vjustify[] = {
1070  };
1071 
1072  field.SetHorizJustify( hjustify[m_FieldHJustifyCtrl->GetSelection()] );
1073  field.SetVertJustify( vjustify[m_FieldVJustifyCtrl->GetSelection()] );
1074 
1075  field.SetName( fieldNameTextCtrl->GetValue() );
1076 
1077  /* Void fields texts for REFERENCE and VALUE (value is the name of the
1078  * component in lib ! ) are not allowed
1079  * change them only for a new non void value
1080  * When void, usually netlists are broken
1081  */
1082  if( !fieldValueTextCtrl->GetValue().IsEmpty() || fieldNdx > VALUE )
1083  field.SetText( fieldValueTextCtrl->GetValue() );
1084 
1085  setRowItem( fieldNdx, field ); // update fieldListCtrl
1086 
1088  field.SetTextSize( wxSize( tmp, tmp ) );
1089  int style = m_StyleRadioBox->GetSelection();
1090 
1091  field.SetItalic( (style & 1 ) != 0 );
1092  field.SetBold( (style & 2 ) != 0 );
1093 
1094  wxPoint pos;
1095  pos.x = ValueFromString( g_UserUnit, posXTextCtrl->GetValue() );
1096  pos.y = ValueFromString( g_UserUnit, posYTextCtrl->GetValue() );
1097  field.SetTextPos( pos );
1098 
1099  return true;
1100 }
1101 
1102 
1104 {
1105  // Remove non existing choices (choiceCount must be <= number for parts)
1106  int unitcount = m_part ? m_part->GetUnitCount() : 1;
1107 
1108  if( unitcount < 1 )
1109  unitcount = 1;
1110 
1111  unitChoice->Clear();
1112 
1113  for( int ii = 1; ii <= unitcount; ii++ )
1114  {
1115  unitChoice->Append( LIB_PART::SubReference( ii, false ) );
1116  }
1117 
1118  // For symbols with multiple parts per package, set the unit selection
1119  if( m_cmp->GetUnit() <= (int)unitChoice->GetCount() )
1120  unitChoice->SetSelection( m_cmp->GetUnit() - 1 );
1121 
1122  // Disable unit selection if only one unit exists:
1123  if( m_cmp->GetUnitCount() <= 1 )
1124  {
1125  unitChoice->Enable( false );
1126  unitsInterchageableLabel->Show( false );
1127  unitsInterchageableText->Show( false );
1128  }
1129  else
1130  {
1131  // Show the "Units are not interchangeable" message option?
1132  if( !m_part || !m_part->UnitsLocked() )
1133  unitsInterchageableLabel->SetLabel( _( "Yes" ) );
1134  else
1135  unitsInterchageableLabel->SetLabel( _( "No" ) );
1136  }
1137 
1138  int orientation = m_cmp->GetOrientation() & ~( CMP_MIRROR_X | CMP_MIRROR_Y );
1139 
1140  if( orientation == CMP_ORIENT_90 )
1141  orientationRadioBox->SetSelection( 1 );
1142  else if( orientation == CMP_ORIENT_180 )
1143  orientationRadioBox->SetSelection( 2 );
1144  else if( orientation == CMP_ORIENT_270 )
1145  orientationRadioBox->SetSelection( 3 );
1146  else
1147  orientationRadioBox->SetSelection( 0 );
1148 
1149  int mirror = m_cmp->GetOrientation() & ( CMP_MIRROR_X | CMP_MIRROR_Y );
1150 
1151  if( mirror == CMP_MIRROR_X )
1152  {
1153  mirrorRadioBox->SetSelection( 1 );
1154  DBG( printf( "mirror=X,1\n" ); )
1155  }
1156  else if( mirror == CMP_MIRROR_Y )
1157  {
1158  mirrorRadioBox->SetSelection( 2 );
1159  DBG( printf( "mirror=Y,2\n" ); )
1160  }
1161  else
1162  mirrorRadioBox->SetSelection( 0 );
1163 
1164  // Activate/Desactivate the normal/convert option ? (activated only if
1165  // the component has more than one shape)
1166  if( m_cmp->GetConvert() > 1 )
1167  convertCheckBox->SetValue( true );
1168 
1169  if( m_part == NULL || !m_part->HasConversion() )
1170  convertCheckBox->Enable( false );
1171 
1172  // Set the component's library name.
1173  chipnameTextCtrl->SetValue( m_cmp->GetLibId().Format() );
1174 
1175  // Set the component's unique ID time stamp.
1176  m_textCtrlTimeStamp->SetValue( wxString::Format( wxT( "%8.8lX" ),
1177  (unsigned long) m_cmp->GetTimeStamp() ) );
1178 }
1179 
1180 
1182 {
1183  if( !m_cmp )
1184  return;
1185 
1186  if( LIB_PART* part = GetParent()->GetLibPart( m_cmp->GetLibId() ) )
1187  {
1188  // save old cmp in undo list if not already in edit, or moving ...
1189  if( m_cmp->GetFlags() == 0 )
1191 
1193  m_cmp->Draw( GetParent()->GetCanvas(), &dc, wxPoint( 0, 0 ), g_XorMode );
1194 
1195  // Initialize fixed field values to default values found in library
1196  // Note: the field texts are not modified because they are set in schematic,
1197  // the text from libraries is most of time a dummy text
1198  // Only VALUE, REFERENCE , FOOTPRINT and DATASHEET are re-initialized
1199  LIB_FIELD& refField = part->GetReferenceField();
1200 
1201  m_cmp->GetField( REFERENCE )->ImportValues( refField );
1202  m_cmp->GetField( REFERENCE )->SetTextPos( refField.GetTextPos() + m_cmp->m_Pos );
1203 
1204  LIB_FIELD& valField = part->GetValueField();
1205 
1206  m_cmp->GetField( VALUE )->ImportValues( valField );
1207  m_cmp->GetField( VALUE )->SetTextPos( valField.GetTextPos() + m_cmp->m_Pos );
1208 
1209  LIB_FIELD* field = part->GetField(FOOTPRINT);
1210 
1211  if( field && m_cmp->GetField( FOOTPRINT ) )
1212  {
1213  m_cmp->GetField( FOOTPRINT )->ImportValues( *field );
1214  m_cmp->GetField( FOOTPRINT )->SetTextPos( field->GetTextPos() + m_cmp->m_Pos );
1215  }
1216 
1217  field = part->GetField(DATASHEET);
1218 
1219  if( field && m_cmp->GetField( DATASHEET ) )
1220  {
1221  m_cmp->GetField( DATASHEET )->ImportValues( *field );
1222  m_cmp->GetField( DATASHEET )->SetTextPos( field->GetTextPos() + m_cmp->m_Pos );
1223  }
1224 
1226 
1227  GetParent()->OnModify();
1228 
1229  m_cmp->Draw( GetParent()->GetCanvas(), &dc, wxPoint( 0, 0 ), GR_DEFAULT_DRAWMODE );
1230 
1231  EndQuasiModal( wxID_OK );
1232  }
1233 }
1234 
1235 
1237 {
1238  SCH_COMPONENT copy( *m_cmp );
1239  std::list<SCH_COMPONENT*> components;
1240  components.push_back( &copy );
1241  InvokeDialogUpdateFields( GetParent(), components, false );
1242 
1243  // Copy fields from the modified component copy to the dialog buffer
1244  m_FieldsBuf.clear();
1245 
1246  for( int i = 0; i < copy.GetFieldCount(); ++i )
1247  {
1248  copy.m_Fields[i].SetParent( m_cmp );
1249  m_FieldsBuf.push_back( copy.m_Fields[i] );
1250  m_FieldsBuf[i].Offset( -m_cmp->m_Pos );
1251  }
1252 
1253  // Update the selected field as well
1255  updateDisplay();
1256 }
1257 
1259 {
1260  int newWidth = event.GetSize().GetX();
1261  fieldListCtrl->SetColumnWidth( 1, newWidth - fieldListCtrl->GetColumnWidth( 0 ) );
1262  event.Skip();
1263 }
void GetComponents(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanComponents=false)
Function GetComponents adds a SCH_REFERENCE() object to aReferences for each component in the sheet...
void SetTextAngle(double aAngle)
Definition: eda_text.h:154
GR_DRAWMODE g_XorMode
Definition: gr_basic.cpp:73
KICAD_T Type() const
Function Type()
Definition: base_struct.h:209
#define TEXT_ANGLE_HORIZ
Frequent text rotations, used with {Set,Get}TextAngle(), in 0.1 degrees for now, hoping to migrate to...
Definition: common.h:91
Class SCH_FIELD instances are attached to a component and provide a place for the component&#39;s value...
Definition: sch_field.h:56
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:227
bool UnitsLocked() const
Check whether part units are interchangeable.
void EditComponent(SCH_COMPONENT *aComponent)
Display the edit component dialog to edit the parameters of aComponent.
void AutoAutoplaceFields(SCH_SCREEN *aScreen)
Autoplace fields only if correct to do so automatically.
STATUS_FLAGS GetFlags() const
Definition: base_struct.h:266
Class KIWAY_PLAYER is a wxFrame capable of the OpenProjectFiles function, meaning it can load a porti...
Definition: kiway_player.h:111
bool copyPanelToSelectedField()
Copy the values displayed on the panel fields to the currently selected field.
Part library alias object definition.
SCH_FIELD * FindField(const wxString &aFieldName, bool aIncludeDefaultFields=true)
Search for a SCH_FIELD with aFieldName.
wxString GetName(bool aUseDefaultName=true) const
Function GetName returns the field name.
Definition: sch_field.cpp:425
const TEMPLATES & GetTemplates()
Return the field names template for read only access.
BLOCK_SELECTOR m_BlockLocate
Block description for block commands.
Definition: base_screen.h:214
EDA_TEXT_HJUSTIFY_T
Definition: eda_text.h:47
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:60
name of datasheet
void Parse(void *yyp, int yymajor, ParseTOKENTYPE yyminorParseARG_PDECL)
bool HasConversion() const
Test if part has more than one body conversion type (DeMorgan).
const wxPoint & GetTextPos() const
Definition: eda_text.h:222
void moveDownButtonHandler(wxCommandEvent &event) override
int GetOrientation()
Get the display symbol orientation.
SCH_FIELDS m_FieldsBuf
a copy of the edited symbol&#39;s SCH_FIELDs
SCH_FIELD * findField(const wxString &aFieldName)
bool IsItalic() const
Definition: eda_text.h:168
const wxString ResolveUriByEnvVars(const wxString &aUri)
Function ResolveUriByEnvVars replaces any environment variables in file-path uris (leaving network-pa...
Definition: common.cpp:269
bool IsPower() const
virtual void Refresh(bool eraseBackground=true, const wxRect *rect=NULL) override
Update the board display after modifying it bu a python script (note: it is automatically called by a...
Definition: draw_panel.cpp:338
Implementation of conversion functions that require both schematic and board internal units...
This file is part of the common library.
void OnOKButtonClick(wxCommandEvent &event) override
EDA_DRAW_PANEL * GetCanvas()
Definition: draw_frame.h:351
void OnModify()
Must be called after a schematic change in order to set the "modify" flag of the current screen* and ...
SCH_FIELDS m_Fields
Variable length list of fields.
Definition: sch_component.h:91
int GetId() const
Definition: sch_field.h:87
This file is part of the common library.
void ImportValues(const LIB_FIELD &aSource)
Function ImportValues copy parameters from a LIB_FIELD source.
Definition: sch_field.cpp:222
void addFieldButtonHandler(wxCommandEvent &event) override
wxString StringFromValue(EDA_UNITS_T aUnit, int aValue, bool aAddUnitSymbol)
Function StringFromValue returns the string from aValue according to units (inch, mm ...
Definition: base_units.cpp:205
wxPoint m_Pos
Name and library where symbol was loaded from, i.e. "74xx:74LS00".
Definition: sch_component.h:77
void SetItalic(bool isItalic)
Definition: eda_text.h:167
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors...
void OnInitDlg(wxInitDialogEvent &event) override
Field object used in symbol libraries.
Definition: lib_field.h:59
int GetTextWidth() const
Definition: eda_text.h:216
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:221
void SetVisible(bool aVisible)
Definition: eda_text.h:173
const LIB_ID & GetLibId() const
void OnCancelButtonClick(wxCommandEvent &event) override
static int ParseSize(const wxString &sizeText, EDA_UNITS_T user_unit)
bool GetAssociatedDocument(wxWindow *aParent, const wxString &aDocName, const wxPathList *aPaths)
Function GetAssociatedDocument open a document (file) with the suitable browser.
Definition: eda_doc.cpp:87
std::vector< COMPONENT_SELECTION > HISTORY_LIST
static const wxString GetDefaultFieldName(int aFieldNdx)
Function GetDefaultFieldName returns a default symbol field name for field aFieldNdx for all componen...
Schematic editor (Eeschema) main window.
LIB_PART * GetLibPart(const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
void SetUnitSelection(SCH_SHEET_PATH *aSheet, int aUnitSelection)
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:212
int GetUnitCount() const
Return the number of units per package of the symbol.
void deleteFieldButtonHandler(wxCommandEvent &event) override
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void MoveCursorToCrossHair()
Function MoveCursorToCrossHair warps the cursor to the current cross hair position.
Definition: draw_panel.cpp:360
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:188
#define TEXT_ANGLE_VERT
Definition: common.h:92
int GetUnit() const
Field Name Module PCB, i.e. "16DIP300".
Field Reference of part, i.e. "IC21".
bool IsBold() const
Definition: eda_text.h:171
double GetTextAngle() const
Definition: eda_text.h:162
Class SCH_REFERENCE_LIST is used to create a flattened list of components because in a complex hierar...
void SetConvert(int aConvert)
SCH_SCREEN * GetScreen() const override
Function GetScreen returns a pointer to a BASE_SCREEN or one of its derivatives.
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
void setRowItem(int aFieldNdx, const wxString &aName, const wxString &aValue)
int GetConvert() const
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Function KiBitmap constructs a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:78
void SetLibId(const LIB_ID &aName, PART_LIBS *aLibs=NULL)
void OnTestChipName(wxCommandEvent &event) override
a helper to handle the real device context used in KiCad
bool EnsureTextCtrlWidth(wxTextCtrl *aCtrl, const wxString *aString)
Function EnsureTextCtrlWidth sets the minimum pixel width on a text control in order to make a text s...
Definition: common.cpp:109
std::vector< TEMPLATE_FIELDNAME > TEMPLATE_FIELDNAMES
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:264
void SetFields(const SCH_FIELDS &aFields)
Set multiple schematic fields.
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:300
const UTF8 & GetLibItemName() const
Definition: lib_id.h:118
int ShowQuasiModal()
const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:128
std::vector< SCH_FIELD > SCH_FIELDS
A container for several SCH_FIELD items.
Definition: sch_component.h:53
void SetVertJustify(EDA_TEXT_VJUSTIFY_T aType)
Definition: eda_text.h:192
wxString GetAbbreviatedUnitsLabel(EDA_UNITS_T aUnit)
Definition: base_units.cpp:485
Defintions of control validators for schematic dialogs.
SCH_SHEET_PATH & GetCurrentSheet()
void SaveCopyInUndoList(SCH_ITEM *aItemToCopy, UNDO_REDO_T aTypeCommand, bool aAppend=false, const wxPoint &aTransformPoint=wxPoint(0, 0))
Create a copy of the current schematic item, and put it in the undo list.
int ValueFromString(EDA_UNITS_T aUnits, const wxString &aTextValue)
Function ValueFromString converts aTextValue in aUnits to internal units used by the application...
Definition: base_units.cpp:370
Define a library symbol object.
void OnListItemDeselected(wxListEvent &event) override
Helper dialog and control classes.
unsigned STATUS_FLAGS
Definition: base_struct.h:142
wxString GetText(GRAPHIC_PINSHAPE shape)
Definition: pin_shape.cpp:33
void SetUnit(int aUnit)
Change the unit number to aUnit.
int GetUnit() const
void OnListItemSelected(wxListEvent &event) override
const wxString GetRef(const SCH_SHEET_PATH *aSheet)
Return the reference for the given sheet path.
void UpdateFields(wxCommandEvent &event) override
int InvokeDialogUpdateFields(SCH_EDIT_FRAME *aCaller, const list< SCH_COMPONENT * > aComponents, bool aCreateUndoEntry)
Class DIALOG_EDIT_COMPONENT_IN_SCHEMATIC_BASE.
bool m_autoplaceFields
automatically place component fields
EDA_TEXT_VJUSTIFY_T
Definition: eda_text.h:54
int GetUnitCount() const
EDA_UNITS_T g_UserUnit
Global variables definitions.
Definition: common.cpp:57
void OnSelectChipName(wxCommandEvent &event) override
void moveUpButtonHandler(wxCommandEvent &event) override
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:189
EDA_DRAW_PANEL * m_canvas
The area to draw on.
Definition: draw_frame.h:98
wxString GetRef() const
void SetRef(const SCH_SHEET_PATH *aSheet, const wxString &aReference)
Set the reference for the given sheet path for this symbol.
void EndQuasiModal(int retCode)
#define GR_DEFAULT_DRAWMODE
Definition: general.h:70
Definition the SCH_COMPONENT class for Eeschema.
bool HasFieldName(const wxString &aName) const
Function HasFieldName checks for aName in the the template field name list.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
const TEMPLATE_FIELDNAMES & GetTemplateFieldNames()
Return a template field names list for read only access.
see class PGM_BASE
void updateDisplay()
Update the listbox showing fields according to the field&#39;s text.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
int GetFieldCount() const
Return the number of fields in this symbol.
BLOCK_STATE_T GetState() const
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
void SetHorizJustify(EDA_TEXT_HJUSTIFY_T aType)
Definition: eda_text.h:191
#define INSTALL_UNBUFFERED_DC(name, parent)
bool IsVisible() const
Definition: eda_text.h:174
bool TestDanglingEnds()
Test all of the connectable objects in the schematic for unused connection points.
Definition: sch_screen.cpp:913
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, GR_DRAWMODE aDrawMode, COLOR4D aColor=COLOR4D::UNSPECIFIED) override
Function Draw Draw a schematic item.
Dialog used to edit SCH_COMPONENT objects in a schematic.
size_t i
Definition: json11.cpp:597
void SetIgnoreMouseEvents(bool aIgnore)
void SetName(const wxString &aName)
Definition: sch_field.h:85
static wxString SubReference(int aUnit, bool aAddSeparator=true)
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
void EditSpiceModel(wxCommandEvent &event) override
const LIB_ID & GetLibId() const
The common library.
void copySelectedFieldToPanel()
Sets the values displayed on the panel according to the currently selected field row.
UTF8 Format() const
Definition: lib_id.cpp:263
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:265
COMPONENT_SELECTION SelectComponentFromLibrary(const SCHLIB_FILTER *aFilter, std::vector< COMPONENT_SELECTION > &aHistoryList, bool aUseLibBrowser, int aUnit, int aConvert, bool aShowFootprints, const LIB_ID *aHighlight=nullptr, bool aAllowFields=true)
Function SelectComponentFromLib Calls the library viewer to select component to import into schematic...
Definition: getpart.cpp:102
#define DBG(x)
Definition: fctsys.h:33
void InitBuffers(SCH_COMPONENT *aComponent)
Initialize controls with aComponent.
LIB_PART * GetLibPart() const
class SCH_FILED_VALIDATOR
Definition for part library class.
void showButtonHandler(wxCommandEvent &event) override
static bool IsReferenceStringValid(const wxString &aReferenceString)
Tests for an acceptable reference string.
void setRowItem(int aFieldNdx, const SCH_FIELD &aField)
unsigned GetCount()
Function GetCount.
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Function DisplayInfoMessage displays an informational message box with aMessage.
Definition: confirm.cpp:216
SCH_COMPONENT * GetComp() const
#define VALUE
void SetBold(bool aBold)
Definition: eda_text.h:170
static wxString FormatSize(EDA_UNITS_T user_unit, int textSize)
Function FormatSize formats a string containing the size in the desired units.
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:185
VTBL_ENTRY bool ShowModal(wxString *aResult=NULL, wxWindow *aResultantFocusWindow=NULL)
Function ShowModal puts up this wxFrame as if it were a modal dialog, with all other instantiated wxF...
Class SCH_REFERENCE is used as a helper to define a component&#39;s reference designator in a schematic...
timestamp_t GetTimeStamp() const
Definition: base_struct.h:215
virtual void SetText(const wxString &aText)
Definition: eda_text.h:139
void SetOrientation(int aOrientation)
Compute the new transform matrix based on aOrientation for the symbol which is applied to the current...
bool IsDragging() const
Definition: base_struct.h:230