KiCad PCB EDA Suite
dialog_choose_symbol.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) 2014 Henner Zeller <h.zeller@acm.org>
5  * Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #include <algorithm>
26 #include <symbol_library.h>
27 #include <dialog_choose_symbol.h>
28 #include <eeschema_settings.h>
29 #include <kiface_base.h>
30 #include <sch_base_frame.h>
31 #include <template_fieldnames.h>
34 #include <widgets/lib_tree.h>
36 #include <wx/button.h>
37 #include <wx/checkbox.h>
38 #include <wx/clipbrd.h>
39 #include <wx/dataview.h>
40 #include <wx/log.h>
41 #include <wx/panel.h>
42 #include <wx/sizer.h>
43 #include <wx/splitter.h>
44 #include <wx/timer.h>
45 #include <wx/utils.h>
46 #include <wx/wxhtml.h>
47 
49 
50 
52  wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>& aAdapter,
53  int aDeMorganConvert, bool aAllowFieldEdits,
54  bool aShowFootprints, bool aAllowBrowser )
55  : DIALOG_SHIM( aParent, wxID_ANY, aTitle, wxDefaultPosition, wxDefaultSize,
56  wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ),
57  m_symbol_preview( nullptr ),
58  m_browser_button( nullptr ),
59  m_hsplitter( nullptr ),
60  m_vsplitter( nullptr ),
61  m_fp_sel_ctrl( nullptr ),
62  m_fp_preview( nullptr ),
63  m_keepSymbol( nullptr ),
64  m_useUnits( nullptr ),
65  m_tree( nullptr ),
66  m_details( nullptr ),
67  m_parent( aParent ),
68  m_deMorganConvert( aDeMorganConvert >= 0 ? aDeMorganConvert : 0 ),
69  m_allow_field_edits( aAllowFieldEdits ),
70  m_show_footprints( aShowFootprints ),
71  m_external_browser_requested( false )
72 {
73  // Never show footprints in power symbol mode
74  if( aAdapter->GetFilter() == SYMBOL_TREE_MODEL_ADAPTER::SYM_FILTER_POWER )
75  m_show_footprints = false;
76 
77  wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
78 
79  // Use a slightly different layout, with a details pane spanning the entire window,
80  // if we're not showing footprints.
81  if( m_show_footprints )
82  {
83  m_hsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
84  wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );
85 
86  //Avoid the splitter window being assigned as the Parent to additional windows
87  m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
88 
89  sizer->Add( m_hsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
90  }
91  else
92  {
93  m_vsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
94  wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );
95 
96  m_hsplitter = new wxSplitterWindow( m_vsplitter, wxID_ANY, wxDefaultPosition, wxDefaultSize,
97  wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );
98 
99  // Avoid the splitter window being assigned as the parent to additional windows.
100  m_vsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
101  m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
102 
103  wxPanel* detailsPanel = new wxPanel( m_vsplitter );
104  wxBoxSizer* detailsSizer = new wxBoxSizer( wxVERTICAL );
105  detailsPanel->SetSizer( detailsSizer );
106 
107  m_details = new wxHtmlWindow( detailsPanel, wxID_ANY, wxDefaultPosition, wxDefaultSize,
108  wxHW_SCROLLBAR_AUTO );
109  detailsSizer->Add( m_details, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
110  detailsPanel->Layout();
111  detailsSizer->Fit( detailsPanel );
112 
113  m_vsplitter->SetSashGravity( 0.5 );
114  m_vsplitter->SetMinimumPaneSize( 20 );
115  m_vsplitter->SplitHorizontally( m_hsplitter, detailsPanel );
116 
117  sizer->Add( m_vsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
118  }
119 
120  wxPanel* treePanel = new wxPanel( m_hsplitter );
121  wxBoxSizer* treeSizer = new wxBoxSizer( wxVERTICAL );
122  treePanel->SetSizer( treeSizer );
123 
124  m_tree = new LIB_TREE( treePanel, Prj().SchSymbolLibTable(), aAdapter, LIB_TREE::WIDGETS::ALL,
125  m_details );
126 
127  treeSizer->Add( m_tree, 1, wxEXPAND | wxALL, 5 );
128  treePanel->Layout();
129  treeSizer->Fit( treePanel );
130 
131  aAdapter->FinishTreeInitialization();
132 
133  m_hsplitter->SetSashGravity( 0.8 );
134  m_hsplitter->SetMinimumPaneSize( 20 );
135  m_hsplitter->SplitVertically( treePanel, ConstructRightPanel( m_hsplitter ) );
136 
137  m_dbl_click_timer = new wxTimer( this );
138 
139  wxBoxSizer* buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
140 
141  if( aAllowBrowser )
142  {
143  m_browser_button = new wxButton( this, wxID_ANY, _( "Select with Browser" ) );
144  buttonsSizer->Add( m_browser_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
145  }
146 
147  m_keepSymbol = new wxCheckBox( this, wxID_ANY, _("Place repeated copies"), wxDefaultPosition,
148  wxDefaultSize, wxALIGN_RIGHT );
149  m_keepSymbol->SetToolTip( _( "Keep the symbol selected for subsequent clicks." ) );
150 
151  m_useUnits = new wxCheckBox( this, wxID_ANY, _("Place all units"), wxDefaultPosition,
152  wxDefaultSize, wxALIGN_RIGHT );
153  m_useUnits->SetToolTip( _( "Sequentially place all units of the symbol." ) );
154 
155  if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
156  {
157  m_keepSymbol->SetValue( cfg->m_SymChooserPanel.keep_symbol );
158  m_useUnits->SetValue( cfg->m_SymChooserPanel.place_all_units );
159  }
160 
161  buttonsSizer->Add( m_keepSymbol, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
162  buttonsSizer->Add( m_useUnits, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
163 
164  wxStdDialogButtonSizer* sdbSizer = new wxStdDialogButtonSizer();
165  wxButton* okButton = new wxButton( this, wxID_OK );
166  wxButton* cancelButton = new wxButton( this, wxID_CANCEL );
167 
168  sdbSizer->AddButton( okButton );
169  sdbSizer->AddButton( cancelButton );
170  sdbSizer->Realize();
171 
172  buttonsSizer->Add( sdbSizer, 1, wxALL, 5 );
173 
174  sizer->Add( buttonsSizer, 0, wxEXPAND | wxLEFT, 5 );
175  SetSizer( sizer );
176 
177  Layout();
178 
179  if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
180  {
181  EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER& panelCfg = cfg->m_SymChooserPanel;
182 
183  // We specify the width of the right window (m_symbol_view_panel), because specify
184  // the width of the left window does not work as expected when SetSashGravity() is called
185  m_hsplitter->SetSashPosition( panelCfg.sash_pos_h > 0 ? panelCfg.sash_pos_h :
186  horizPixelsFromDU( 220 ) );
187 
188  if( m_vsplitter )
189  {
190  m_vsplitter->SetSashPosition( panelCfg.sash_pos_v > 0 ? panelCfg.sash_pos_v :
191  vertPixelsFromDU( 230 ) );
192  }
193 
194  wxSize dlgSize( panelCfg.width > 0 ? panelCfg.width : horizPixelsFromDU( 390 ),
195  panelCfg.height > 0 ? panelCfg.height : vertPixelsFromDU( 300 ) );
196  SetSize( dlgSize );
197  }
198 
200  okButton->SetDefault();
201 
202  Bind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_SYMBOL::OnInitDialog, this );
203  Bind( wxEVT_TIMER, &DIALOG_CHOOSE_SYMBOL::OnCloseTimer, this, m_dbl_click_timer->GetId() );
204  Bind( SYMBOL_PRESELECTED, &DIALOG_CHOOSE_SYMBOL::OnComponentPreselected, this );
205  Bind( SYMBOL_SELECTED, &DIALOG_CHOOSE_SYMBOL::OnComponentSelected, this );
206 
207  if( m_browser_button )
208  {
209  m_browser_button->Bind( wxEVT_COMMAND_BUTTON_CLICKED, &DIALOG_CHOOSE_SYMBOL::OnUseBrowser,
210  this );
211  }
212 
213  if( m_fp_sel_ctrl )
214  {
215  m_fp_sel_ctrl->Bind( EVT_FOOTPRINT_SELECTED, &DIALOG_CHOOSE_SYMBOL::OnFootprintSelected,
216  this );
217  }
218 
219  if( m_details )
220  {
221  m_details->Connect( wxEVT_CHAR_HOOK, wxKeyEventHandler( DIALOG_CHOOSE_SYMBOL::OnCharHook ),
222  nullptr, this );
223  }
224 }
225 
226 
228 {
229  Unbind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_SYMBOL::OnInitDialog, this );
230  Unbind( wxEVT_TIMER, &DIALOG_CHOOSE_SYMBOL::OnCloseTimer, this );
231  Unbind( SYMBOL_PRESELECTED, &DIALOG_CHOOSE_SYMBOL::OnComponentPreselected, this );
232  Unbind( SYMBOL_SELECTED, &DIALOG_CHOOSE_SYMBOL::OnComponentSelected, this );
233 
234  // Stop the timer during destruction early to avoid potential race conditions (that do happen)
235  m_dbl_click_timer->Stop();
236  delete m_dbl_click_timer;
237 
238  if( m_browser_button )
239  {
240  m_browser_button->Unbind( wxEVT_COMMAND_BUTTON_CLICKED,
242  }
243 
244  if( m_fp_sel_ctrl )
245  {
246  m_fp_sel_ctrl->Unbind( EVT_FOOTPRINT_SELECTED, &DIALOG_CHOOSE_SYMBOL::OnFootprintSelected,
247  this );
248  }
249 
250  if( m_details )
251  {
252  m_details->Disconnect( wxEVT_CHAR_HOOK,
253  wxKeyEventHandler( DIALOG_CHOOSE_SYMBOL::OnCharHook ), nullptr,
254  this );
255  }
256 
257  if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
258  {
259  cfg->m_SymChooserPanel.width = GetSize().x;
260  cfg->m_SymChooserPanel.height = GetSize().y;
261 
262  cfg->m_SymChooserPanel.keep_symbol = m_keepSymbol->GetValue();
263  cfg->m_SymChooserPanel.place_all_units = m_useUnits->GetValue();
264 
265  cfg->m_SymChooserPanel.sash_pos_h = m_hsplitter->GetSashPosition();
266 
267  if( m_vsplitter )
268  cfg->m_SymChooserPanel.sash_pos_v = m_vsplitter->GetSashPosition();
269  }
270 }
271 
272 
273 wxPanel* DIALOG_CHOOSE_SYMBOL::ConstructRightPanel( wxWindow* aParent )
274 {
275  wxPanel* panel = new wxPanel( aParent );
276  wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
278 
279  m_symbol_preview = new SYMBOL_PREVIEW_WIDGET( panel, Kiway(), backend );
280  m_symbol_preview->SetLayoutDirection( wxLayout_LeftToRight );
281 
282  if( m_show_footprints )
283  {
285 
286  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxALL, 5 );
287 
288  if ( fp_list )
289  {
290  if( m_allow_field_edits )
291  m_fp_sel_ctrl = new FOOTPRINT_SELECT_WIDGET( m_parent, panel, fp_list, true );
292 
293  m_fp_preview = new FOOTPRINT_PREVIEW_WIDGET( panel, Kiway() );
294  }
295 
296  if( m_fp_sel_ctrl )
297  sizer->Add( m_fp_sel_ctrl, 0, wxEXPAND | wxTOP | wxLEFT | wxRIGHT, 3 );
298 
299  if( m_fp_preview )
300  sizer->Add( m_fp_preview, 1, wxEXPAND | wxALL, 5 );
301  }
302  else
303  {
304  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxALL, 5 );
305  }
306 
307  panel->SetSizer( sizer );
308  panel->Layout();
309  sizer->Fit( panel );
310 
311  return panel;
312 }
313 
314 
315 void DIALOG_CHOOSE_SYMBOL::OnInitDialog( wxInitDialogEvent& aEvent )
316 {
318  {
319  // This hides the GAL panel and shows the status label
320  m_fp_preview->SetStatusText( wxEmptyString );
321  }
322 
323  if( m_fp_sel_ctrl )
324  m_fp_sel_ctrl->Load( Kiway(), Prj() );
325 }
326 
327 
328 void DIALOG_CHOOSE_SYMBOL::OnCharHook( wxKeyEvent& e )
329 {
330  if( m_details && e.GetKeyCode() == 'C' && e.ControlDown() &&
331  !e.AltDown() && !e.ShiftDown() && !e.MetaDown() )
332  {
333  wxString txt = m_details->SelectionToText();
334  wxLogNull doNotLog; // disable logging of failed clipboard actions
335 
336  if( wxTheClipboard->Open() )
337  {
338  wxTheClipboard->SetData( new wxTextDataObject( txt ) );
339  wxTheClipboard->Flush(); // Allow data to be available after closing KiCad
340  wxTheClipboard->Close();
341  }
342  }
343  else
344  {
345  e.Skip();
346  }
347 }
348 
349 
351 {
352  return m_tree->GetSelectedLibId( aUnit );
353 }
354 
355 
356 void DIALOG_CHOOSE_SYMBOL::OnUseBrowser( wxCommandEvent& aEvent )
357 {
359 
360  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
361 }
362 
363 
364 void DIALOG_CHOOSE_SYMBOL::OnCloseTimer( wxTimerEvent& aEvent )
365 {
366  // Hack handler because of eaten MouseUp event. See
367  // DIALOG_CHOOSE_SYMBOL::OnComponentSelected for the beginning
368  // of this spaghetti noodle.
369 
370  auto state = wxGetMouseState();
371 
372  if( state.LeftIsDown() )
373  {
374  // Mouse hasn't been raised yet, so fire the timer again. Otherwise the
375  // purpose of this timer is defeated.
377  }
378  else
379  {
380  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
381  }
382 }
383 
384 
386 {
388  return;
389 
390  LIB_SYMBOL* symbol = nullptr;
391 
392  try
393  {
394  symbol = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
395  }
396  catch( const IO_ERROR& ioe )
397  {
398  wxLogError( _( "Error loading symbol %s from library '%s'." ) + wxS( "\n%s" ),
399  aLibId.GetLibItemName().wx_str(),
400  aLibId.GetLibNickname().wx_str(),
401  ioe.What() );
402  }
403 
404  if( !symbol )
405  return;
406 
407  LIB_FIELD* fp_field = symbol->GetFieldById( FOOTPRINT_FIELD );
408  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
409 
410  ShowFootprint( fp_name );
411 }
412 
413 
414 void DIALOG_CHOOSE_SYMBOL::ShowFootprint( wxString const& aName )
415 {
417  return;
418 
419  if( aName == wxEmptyString )
420  {
421  m_fp_preview->SetStatusText( _( "No footprint specified" ) );
422  }
423  else
424  {
425  LIB_ID lib_id;
426 
427  if( lib_id.Parse( aName ) == -1 && lib_id.IsValid() )
428  {
430  m_fp_preview->DisplayFootprint( lib_id );
431  }
432  else
433  {
434  m_fp_preview->SetStatusText( _( "Invalid footprint specified" ) );
435  }
436  }
437 }
438 
439 
441 {
442  if( !m_fp_sel_ctrl )
443  return;
444 
446 
447  LIB_SYMBOL* symbol = nullptr;
448 
449  if( aLibId.IsValid() )
450  {
451  try
452  {
453  symbol = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
454  }
455  catch( const IO_ERROR& ioe )
456  {
457  wxLogError( _( "Error loading symbol %s from library '%s'." ) + wxS( "\n%s" ),
458  aLibId.GetLibItemName().wx_str(),
459  aLibId.GetLibNickname().wx_str(),
460  ioe.What() );
461  }
462  }
463 
464  if( symbol != nullptr )
465  {
466  LIB_PINS temp_pins;
467  LIB_FIELD* fp_field = symbol->GetFieldById( FOOTPRINT_FIELD );
468  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
469 
470  symbol->GetPins( temp_pins );
471 
472  m_fp_sel_ctrl->FilterByPinCount( temp_pins.size() );
477  }
478  else
479  {
481  m_fp_sel_ctrl->Disable();
482  }
483 }
484 
485 
486 void DIALOG_CHOOSE_SYMBOL::OnFootprintSelected( wxCommandEvent& aEvent )
487 {
488  m_fp_override = aEvent.GetString();
489 
490  m_field_edits.erase( std::remove_if( m_field_edits.begin(), m_field_edits.end(),
491  []( std::pair<int, wxString> const& i )
492  {
493  return i.first == FOOTPRINT_FIELD;
494  } ),
495  m_field_edits.end() );
496 
497  m_field_edits.emplace_back( std::make_pair( FOOTPRINT_FIELD, m_fp_override ) );
498 
500 }
501 
502 
503 void DIALOG_CHOOSE_SYMBOL::OnComponentPreselected( wxCommandEvent& aEvent )
504 {
505  int unit = 0;
506 
507  LIB_ID id = m_tree->GetSelectedLibId( &unit );
508 
509  if( id.IsValid() )
510  {
511  m_symbol_preview->DisplaySymbol( id, unit );
512 
513  ShowFootprintFor( id );
515  }
516  else
517  {
518  m_symbol_preview->SetStatusText( _( "No symbol selected" ) );
519 
521  m_fp_preview->SetStatusText( wxEmptyString );
522 
524  }
525 }
526 
527 
528 void DIALOG_CHOOSE_SYMBOL::OnComponentSelected( wxCommandEvent& aEvent )
529 {
530  if( m_tree->GetSelectedLibId().IsValid() )
531  {
532  // Got a selection. We can't just end the modal dialog here, because
533  // wx leaks some events back to the parent window (in particular, the
534  // MouseUp following a double click).
535  //
536  // NOW, here's where it gets really fun. wxTreeListCtrl eats MouseUp.
537  // This isn't really feasible to bypass without a fully custom
538  // wxDataViewCtrl implementation, and even then might not be fully
539  // possible (docs are vague). To get around this, we use a one-shot
540  // timer to schedule the dialog close.
541  //
542  // See DIALOG_CHOOSE_SYMBOL::OnCloseTimer for the other end of this
543  // spaghetti noodle.
545  }
546 }
547 
548 
550 {
551  return m_useUnits->GetValue();
552 }
553 
554 
556 {
557  return m_keepSymbol->GetValue();
558 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
void ShowFootprint(const wxString &aFootprint)
Display the given footprint by name.
void OnCharHook(wxKeyEvent &aEvt) override
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0) const
Return a list of pin object pointers from the draw item list.
Definition: lib_symbol.cpp:693
const UTF8 & GetLibItemName() const
Definition: lib_id.h:104
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
DIALOG_CHOOSE_SYMBOL(SCH_BASE_FRAME *aParent, const wxString &aTitle, wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > &aAdapter, int aDeMorganConvert, bool aAllowFieldEdits, bool aShowFootprints, bool aAllowBrowser)
Create dialog to choose symbol.
void PopulateFootprintSelector(const LIB_ID &aLibId)
Populate the footprint selector for a given alias.
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
void SetStatusText(const wxString &aText)
Set the contents of the status label and display it.
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:55
SYMBOL_PREVIEW_WIDGET * m_symbol_preview
wxWindow * GetFocusTarget()
Definition: lib_tree.cpp:240
Field object used in symbol libraries.
Definition: lib_field.h:59
bool GetUseAllUnits() const
To be called after this dialog returns from ShowModal()
void OnFootprintSelected(wxCommandEvent &aEvent)
int horizPixelsFromDU(int x) const
Convert an integer number of dialog units to pixels, horizontally.
void OnComponentPreselected(wxCommandEvent &aEvent)
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
Definition: dialog_shim.h:82
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
All except INITIAL_ADD.
Definition: view_item.h:58
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:159
Define a library symbol object.
Definition: lib_symbol.h:96
std::vector< std::pair< int, wxString > > m_field_edits
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:97
static std::mutex g_Mutex
void ClearFilters()
Clear all filters.
void OnUseBrowser(wxCommandEvent &aEvent)
wxSplitterWindow * m_hsplitter
bool UpdateList()
Update the contents of the list to match the filters.
wxPanel * ConstructRightPanel(wxWindow *aParent)
wxSplitterWindow * m_vsplitter
void OnInitDialog(wxInitDialogEvent &aEvent)
static FOOTPRINT_LIST * GetInstance(KIWAY &aKiway)
Factory function to return a FOOTPRINT_LIST via Kiway.
void FilterByFootprintFilters(const wxArrayString &aFilters, bool aZeroFilters)
Filter by footprint filter list.
static constexpr int DblClickDelay
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
void ClearStatus()
Clear the contents of the status label and hide it.
void SetDefaultFootprint(const wxString &aFp)
Set the default footprint for a part.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit symbols, if the user selects the symbol itself rather than picking an individual unit,...
Definition: lib_tree.cpp:168
Definition for symbol library class.
virtual bool Enable(bool aEnable=true) override
Enable or disable the control for input.
#define _(s)
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:90
void SetStatusText(const wxString &aText)
Set the contents of the status label and display it.
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
To be called after this dialog returns from ShowModal().
void ShowFootprintFor(const LIB_ID &aLibId)
Look up the footprint for a given symbol specified in the LIB_ID and display it.
void DisplaySymbol(const LIB_ID &aSymbolID, int aUnit, int aConvert=0)
Set the currently displayed symbol.
void OnComponentSelected(wxCommandEvent &aEvent)
Handle the selection of an item.
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:49
LIB_FIELD * GetFieldById(int aId) const
Return pointer to the requested field.
Definition: lib_symbol.cpp:939
Holds a list of FOOTPRINT_INFO objects, along with a list of IO_ERRORs or PARSE_ERRORs that were thro...
void OnCloseTimer(wxTimerEvent &aEvent)
void DisplayFootprint(const LIB_ID &aFPID)
Set the currently displayed footprint.
bool GetKeepSymbol() const
To be called after this dialog returns from ShowModal()
wxString wx_str() const
Definition: utf8.cpp:46
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:294
int vertPixelsFromDU(int y) const
Convert an integer number of dialog units to pixels, vertically.
wxArrayString GetFPFilters() const
Definition: lib_symbol.h:183
void Load(KIWAY &aKiway, PROJECT &aProject)
Start loading.
GAL_TYPE GetBackend() const
Return the type of backend currently used by GAL canvas.
bool IsInitialized() const
Return whether the widget initialized properly.
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
void FilterByPinCount(int aPinCount)
Filter by pin count.
Widget displaying a tree of symbols with optional search text control and description panel....
Definition: lib_tree.h:45
Field Name Module PCB, i.e. "16DIP300".