KiCad PCB EDA Suite
dialog_choose_component.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-2019 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 <class_libentry.h>
27 #include <class_library.h>
29 #include <eeschema_settings.h>
30 #include <kiface_i.h>
31 #include <sch_base_frame.h>
32 #include <symbol_lib_table.h>
33 #include <template_fieldnames.h>
36 #include <widgets/lib_tree.h>
38 #include <wx/button.h>
39 #include <wx/clipbrd.h>
40 #include <wx/dataview.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 
48 
49 
52  int aDeMorganConvert, bool aAllowFieldEdits,
53  bool aShowFootprints, bool aAllowBrowser )
54  : DIALOG_SHIM( aParent, wxID_ANY, aTitle, wxDefaultPosition, wxDefaultSize,
55  wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ),
56  m_symbol_preview( nullptr ),
57  m_browser_button( nullptr ),
58  m_hsplitter( nullptr ),
59  m_vsplitter( nullptr ),
60  m_fp_sel_ctrl( nullptr ),
61  m_fp_preview( nullptr ),
62  m_keepSymbol( nullptr ),
63  m_useUnits( nullptr ),
64  m_tree( nullptr ),
65  m_details( nullptr ),
66  m_parent( aParent ),
67  m_deMorganConvert( aDeMorganConvert >= 0 ? aDeMorganConvert : 0 ),
68  m_allow_field_edits( aAllowFieldEdits ),
69  m_show_footprints( aShowFootprints ),
70  m_external_browser_requested( false )
71 {
72  auto sizer = new wxBoxSizer( wxVERTICAL );
73 
74  // Use a slightly different layout, with a details pane spanning the entire window,
75  // if we're not showing footprints.
76  if( aShowFootprints )
77  {
78  m_hsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
79  wxSP_LIVE_UPDATE );
80 
81  //Avoid the splitter window being assigned as the Parent to additional windows
82  m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
83 
84  sizer->Add( m_hsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
85  }
86  else
87  {
88  m_vsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
89  wxSP_LIVE_UPDATE );
90 
91  m_hsplitter = new wxSplitterWindow( m_vsplitter, wxID_ANY, wxDefaultPosition, wxDefaultSize,
92  wxSP_LIVE_UPDATE );
93 
94  //Avoid the splitter window being assigned as the Parent to additional windows
95  m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
96 
97  auto detailsPanel = new wxPanel( m_vsplitter );
98  auto detailsSizer = new wxBoxSizer( wxVERTICAL );
99  detailsPanel->SetSizer( detailsSizer );
100 
101  m_details = new wxHtmlWindow( detailsPanel, wxID_ANY, wxDefaultPosition, wxDefaultSize,
102  wxHW_SCROLLBAR_AUTO );
103  detailsSizer->Add( m_details, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
104  detailsPanel->Layout();
105  detailsSizer->Fit( detailsPanel );
106 
107  m_vsplitter->SetSashGravity( 0.5 );
108  m_vsplitter->SetMinimumPaneSize( 20 );
109  m_vsplitter->SplitHorizontally( m_hsplitter, detailsPanel );
110 
111  sizer->Add( m_vsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
112  }
113 
114  m_tree = new LIB_TREE( m_hsplitter, Prj().SchSymbolLibTable(), aAdapter,
116 
117  m_hsplitter->SetSashGravity( 0.8 );
118  m_hsplitter->SetMinimumPaneSize( 20 );
119  m_hsplitter->SplitVertically( m_tree, ConstructRightPanel( m_hsplitter ) );
120 
121  m_dbl_click_timer = new wxTimer( this );
122 
123  auto buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
124 
125  if( aAllowBrowser )
126  {
127  m_browser_button = new wxButton( this, wxID_ANY, _( "Select with Browser" ) );
128  buttonsSizer->Add( m_browser_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
129  }
130 
131  auto sdbSizer = new wxStdDialogButtonSizer();
132  auto okButton = new wxButton( this, wxID_OK );
133  auto cancelButton = new wxButton( this, wxID_CANCEL );
134  sdbSizer->AddButton( okButton );
135  sdbSizer->AddButton( cancelButton );
136  sdbSizer->Realize();
137 
138  buttonsSizer->Add( sdbSizer, 1, wxALL, 5 );
139 
140  sizer->Add( buttonsSizer, 0, wxEXPAND | wxLEFT, 5 );
141  SetSizer( sizer );
142 
143  Layout();
144 
145  EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
146 
147  if( cfg )
148  {
150 
151  // We specify the width of the right window (m_symbol_view_panel), because specify
152  // the width of the left window does not work as expected when SetSashGravity() is called
153  m_hsplitter->SetSashPosition( panelCfg.sash_pos_h > 0 ? panelCfg.sash_pos_h :
154  HorizPixelsFromDU( 220 ) );
155 
156  if( m_vsplitter )
157  m_vsplitter->SetSashPosition( panelCfg.sash_pos_v > 0 ? panelCfg.sash_pos_v :
158  VertPixelsFromDU( 230 ) );
159 
160  wxSize dlgSize( panelCfg.width > 0 ? panelCfg.width : HorizPixelsFromDU( 390 ),
161  panelCfg.height > 0 ? panelCfg.height : VertPixelsFromDU( 300 ) );
162  SetSize( dlgSize );
163  }
164 
166  okButton->SetDefault();
167 
168  Bind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_COMPONENT::OnInitDialog, this );
169  Bind( wxEVT_TIMER, &DIALOG_CHOOSE_COMPONENT::OnCloseTimer, this, m_dbl_click_timer->GetId() );
170  Bind( COMPONENT_PRESELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentPreselected, this );
171  Bind( COMPONENT_SELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentSelected, this );
172 
173  if( m_browser_button )
174  m_browser_button->Bind( wxEVT_COMMAND_BUTTON_CLICKED,
176 
177  if( m_fp_sel_ctrl )
178  m_fp_sel_ctrl->Bind( EVT_FOOTPRINT_SELECTED,
180 
181  if( m_details )
182  m_details->Connect( wxEVT_CHAR_HOOK,
183  wxKeyEventHandler( DIALOG_CHOOSE_COMPONENT::OnCharHook ),
184  NULL, this );
185 }
186 
187 
189 {
190  Unbind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_COMPONENT::OnInitDialog, this );
191  Unbind( wxEVT_TIMER, &DIALOG_CHOOSE_COMPONENT::OnCloseTimer, this );
192  Unbind( COMPONENT_PRESELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentPreselected, this );
193  Unbind( COMPONENT_SELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentSelected, this );
194 
195  if( m_browser_button )
196  m_browser_button->Unbind( wxEVT_COMMAND_BUTTON_CLICKED,
198 
199  if( m_fp_sel_ctrl )
200  m_fp_sel_ctrl->Unbind( EVT_FOOTPRINT_SELECTED,
202 
203  if( m_details )
204  m_details->Disconnect( wxEVT_CHAR_HOOK,
205  wxKeyEventHandler( DIALOG_CHOOSE_COMPONENT::OnCharHook ),
206  NULL, this );
207 
208  // I am not sure the following two lines are necessary, but they will not hurt anyone
209  m_dbl_click_timer->Stop();
210  delete m_dbl_click_timer;
211 
212  auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
213 
214  wxCHECK( cfg, /*void*/ );
215 
216  cfg->m_SymChooserPanel.width = GetSize().x;
217  cfg->m_SymChooserPanel.height = GetSize().y;
218 
219  cfg->m_SymChooserPanel.keep_symbol = m_keepSymbol->GetValue();
220  cfg->m_SymChooserPanel.place_all_units = m_useUnits->GetValue();
221 
222  cfg->m_SymChooserPanel.sash_pos_h = m_hsplitter->GetSashPosition();
223 
224  if( m_vsplitter )
225  cfg->m_SymChooserPanel.sash_pos_v = m_vsplitter->GetSashPosition();
226 }
227 
228 
229 wxPanel* DIALOG_CHOOSE_COMPONENT::ConstructRightPanel( wxWindow* aParent )
230 {
231  wxPanel* panel = new wxPanel( aParent );
232  wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
234 
235  m_symbol_preview = new SYMBOL_PREVIEW_WIDGET( panel, Kiway(), backend );
236  m_symbol_preview->SetLayoutDirection( wxLayout_LeftToRight );
237 
238  if( m_show_footprints )
239  {
241 
242  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxTOP | wxBOTTOM | wxRIGHT, 5 );
243 
244  if ( fp_list )
245  {
246  if( m_allow_field_edits )
247  m_fp_sel_ctrl = new FOOTPRINT_SELECT_WIDGET( panel, fp_list, true );
248 
249  m_fp_preview = new FOOTPRINT_PREVIEW_WIDGET( panel, Kiway() );
250  }
251 
252  if( m_fp_sel_ctrl )
253  sizer->Add( m_fp_sel_ctrl, 0, wxEXPAND | wxBOTTOM | wxTOP | wxRIGHT, 5 );
254 
255  if( m_fp_preview )
256  sizer->Add( m_fp_preview, 1, wxEXPAND | wxBOTTOM | wxRIGHT, 5 );
257  }
258  else
259  {
260  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxTOP | wxRIGHT, 5 );
261  }
262 
263  auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
264 
265  m_keepSymbol = new wxCheckBox( panel, 1000, _("Multi-Symbol Placement"), wxDefaultPosition,
266  wxDefaultSize, wxALIGN_RIGHT );
267  m_keepSymbol->SetValue( cfg ? cfg->m_SymChooserPanel.keep_symbol : true );
268  m_keepSymbol->SetToolTip( _( "Place multiple copies of the symbol." ) );
269 
270  m_useUnits = new wxCheckBox( panel, 1000, _("Place all units"), wxDefaultPosition,
271  wxDefaultSize, wxALIGN_RIGHT );
272  m_useUnits->SetValue( cfg ? cfg->m_SymChooserPanel.place_all_units : true );
273  m_useUnits->SetToolTip( _( "Sequentially place all units of the symbol." ) );
274 
275  auto fgSizer = new wxFlexGridSizer( 0, 2, 0, 1 );
276  fgSizer->AddGrowableCol( 0 );
277  fgSizer->SetFlexibleDirection( wxBOTH );
278  fgSizer->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_SPECIFIED );
279 
280  fgSizer->Add( 0, 0, 1, wxEXPAND );
281  fgSizer->Add( m_keepSymbol, 0, wxALIGN_CENTER_VERTICAL|wxALIGN_RIGHT|wxBOTTOM|wxRIGHT|wxLEFT, 5 );
282  fgSizer->Add( 0, 0, 1, wxEXPAND );
283  fgSizer->Add( m_useUnits, 0, wxALIGN_CENTER_VERTICAL|wxALIGN_RIGHT|wxBOTTOM|wxRIGHT|wxLEFT, 5 );
284 
285  sizer->Add( fgSizer, 0, wxALL | wxEXPAND, 5 );
286  panel->SetSizer( sizer );
287  panel->Layout();
288  sizer->Fit( panel );
289 
290  return panel;
291 }
292 
293 
294 void DIALOG_CHOOSE_COMPONENT::OnInitDialog( wxInitDialogEvent& aEvent )
295 {
297  {
298  // This hides the GAL panel and shows the status label
299  m_fp_preview->SetStatusText( wxEmptyString );
300  }
301 
302  if( m_fp_sel_ctrl )
303  m_fp_sel_ctrl->Load( Kiway(), Prj() );
304 }
305 
306 
308 {
309  if( m_details && e.GetKeyCode() == 'C' && e.ControlDown() &&
310  !e.AltDown() && !e.ShiftDown() && !e.MetaDown() )
311  {
312  wxString txt = m_details->SelectionToText();
313 
314  if( wxTheClipboard->Open() )
315  {
316  wxTheClipboard->SetData( new wxTextDataObject( txt ) );
317  wxTheClipboard->Close();
318  }
319  }
320  else
321  {
322  e.Skip();
323  }
324 }
325 
326 
328 {
329  return m_tree->GetSelectedLibId( aUnit );
330 }
331 
332 
333 void DIALOG_CHOOSE_COMPONENT::OnUseBrowser( wxCommandEvent& aEvent )
334 {
336  EndQuasiModal( wxID_OK );
337 }
338 
339 
340 void DIALOG_CHOOSE_COMPONENT::OnCloseTimer( wxTimerEvent& aEvent )
341 {
342  // Hack handler because of eaten MouseUp event. See
343  // DIALOG_CHOOSE_COMPONENT::OnComponentSelected for the beginning
344  // of this spaghetti noodle.
345 
346  auto state = wxGetMouseState();
347 
348  if( state.LeftIsDown() )
349  {
350  // Mouse hasn't been raised yet, so fire the timer again. Otherwise the
351  // purpose of this timer is defeated.
353  }
354  else
355  {
356  EndQuasiModal( wxID_OK );
357  }
358 }
359 
360 
362 {
364  return;
365 
366  LIB_PART* symbol = nullptr;
367 
368  try
369  {
370  symbol = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
371  }
372  catch( const IO_ERROR& ioe )
373  {
374  wxLogError( wxString::Format( _( "Error loading symbol %s from library %s.\n\n%s" ),
375  aLibId.GetLibItemName().wx_str(),
376  aLibId.GetLibNickname().wx_str(),
377  ioe.What() ) );
378  }
379 
380  if( !symbol )
381  return;
382 
383  LIB_FIELD* fp_field = symbol->GetField( FOOTPRINT );
384  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
385 
386  ShowFootprint( fp_name );
387 }
388 
389 
390 void DIALOG_CHOOSE_COMPONENT::ShowFootprint( wxString const& aName )
391 {
393  return;
394 
395  if( aName == wxEmptyString )
396  {
397  m_fp_preview->SetStatusText( _( "No footprint specified" ) );
398  }
399  else
400  {
401  LIB_ID lib_id;
402 
403  if( lib_id.Parse( aName, LIB_ID::ID_PCB ) == -1 && lib_id.IsValid() )
404  {
406  m_fp_preview->CacheFootprint( lib_id );
407  m_fp_preview->DisplayFootprint( lib_id );
408  }
409  else
410  {
411  m_fp_preview->SetStatusText( _( "Invalid footprint specified" ) );
412  }
413  }
414 }
415 
416 
418 {
419  if( !m_fp_sel_ctrl )
420  return;
421 
423 
424  LIB_PART* symbol = nullptr;
425 
426  if( aLibId.IsValid() )
427  {
428  try
429  {
430  symbol = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
431  }
432  catch( const IO_ERROR& ioe )
433  {
434  wxLogError( wxString::Format( _( "Error occurred loading symbol %s from library %s."
435  "\n\n%s" ),
436  aLibId.GetLibItemName().wx_str(),
437  aLibId.GetLibNickname().wx_str(),
438  ioe.What() ) );
439  }
440  }
441 
442  if( symbol != nullptr )
443  {
444  LIB_PINS temp_pins;
445  LIB_FIELD* fp_field = symbol->GetField( FOOTPRINT );
446  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
447 
448  symbol->GetPins( temp_pins );
449 
450  m_fp_sel_ctrl->FilterByPinCount( temp_pins.size() );
455  }
456  else
457  {
459  m_fp_sel_ctrl->Disable();
460  }
461 }
462 
463 
464 void DIALOG_CHOOSE_COMPONENT::OnFootprintSelected( wxCommandEvent& aEvent )
465 {
466  m_fp_override = aEvent.GetString();
467 
468  m_field_edits.erase( std::remove_if( m_field_edits.begin(), m_field_edits.end(),
469  []( std::pair<int, wxString> const& i )
470  {
471  return i.first == FOOTPRINT;
472  } ),
473  m_field_edits.end() );
474 
475  m_field_edits.emplace_back( std::make_pair( FOOTPRINT, m_fp_override ) );
476 
478 }
479 
480 
482 {
483  int unit = 0;
484 
485  LIB_ID id = m_tree->GetSelectedLibId( &unit );
486 
487  if( id.IsValid() )
488  {
489  m_symbol_preview->DisplaySymbol( id, unit );
490 
491  ShowFootprintFor( id );
493  }
494  else
495  {
496  m_symbol_preview->SetStatusText( _( "No symbol selected" ) );
497 
499  m_fp_preview->SetStatusText( wxEmptyString );
500 
502  }
503 }
504 
505 
506 void DIALOG_CHOOSE_COMPONENT::OnComponentSelected( wxCommandEvent& aEvent )
507 {
508  if( m_tree->GetSelectedLibId().IsValid() )
509  {
510  // Got a selection. We can't just end the modal dialog here, because
511  // wx leaks some events back to the parent window (in particular, the
512  // MouseUp following a double click).
513  //
514  // NOW, here's where it gets really fun. wxTreeListCtrl eats MouseUp.
515  // This isn't really feasible to bypass without a fully custom
516  // wxDataViewCtrl implementation, and even then might not be fully
517  // possible (docs are vague). To get around this, we use a one-shot
518  // timer to schedule the dialog close.
519  //
520  // See DIALOG_CHOOSE_COMPONENT::OnCloseTimer for the other end of this
521  // spaghetti noodle.
523  }
524 }
525 
526 
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
void FilterByFootprintFilters(wxArrayString const &aFilters, bool aZeroFilters)
Filter by footprint filter list.
std::vector< std::pair< int, wxString > > m_field_edits
void PopulateFootprintSelector(LIB_ID const &aLibId)
Populate the footprint selector for a given alias.
void OnFootprintSelected(wxCommandEvent &aEvent)
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:55
Field object used in symbol libraries.
Definition: lib_field.h:59
SYMBOL_PREVIEW_WIDGET * m_symbol_preview
void SetDefaultFootprint(wxString const &aFp)
Set the default footprint for a part.
void ShowFootprint(wxString const &aFootprint)
Display the given footprint by name.
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
Definition: dialog_shim.h:83
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
Item needs to be redrawn.
Definition: view_item.h:63
bool IsValid() const
Definition: lib_id.h:171
PANEL_SYM_CHOOSER m_SymChooserPanel
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:114
Field Name Module PCB, i.e. "16DIP300".
void OnComponentPreselected(wxCommandEvent &aEvent)
void ClearFilters()
Clear all filters.
void OnCharHook(wxKeyEvent &aEvt)
bool UpdateList()
Update the contents of the list to match the filters.
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
static FOOTPRINT_LIST * GetInstance(KIWAY &aKiway)
Factory function to return a FOOTPRINT_LIST via Kiway.
DIALOG_CHOOSE_COMPONENT(SCH_BASE_FRAME *aParent, const wxString &aTitle, SYMBOL_TREE_MODEL_ADAPTER::PTR &aAdapter, int aDeMorganConvert, bool aAllowFieldEdits, bool aShowFootprints, bool aAllowBrowser)
Create dialog to choose component.
void OnInitDialog(wxInitDialogEvent &aEvent)
#define NULL
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
void ClearStatus()
Clear the contents of the status label and hide it.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
Class LIB_PIN definition.
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit components, if the user selects the component itself rather than picking an individual...
Definition: lib_tree.cpp:148
Define a library symbol object.
void OnCloseTimer(wxTimerEvent &aEvent)
virtual bool Enable(bool aEnable=true) override
Enable or disable the control for input.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
wxPanel * ConstructRightPanel(wxWindow *aParent)
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
void OnUseBrowser(wxCommandEvent &aEvent)
wxArrayString GetFootprints() const
int VertPixelsFromDU(int y)
Convert an integer number of dialog units to pixels, vertically.
void EndQuasiModal(int retCode)
void DisplaySymbol(const LIB_ID &aSymbolID, int aUnit, int aConvert=0)
Set the currently displayed symbol.
void CacheFootprint(const LIB_ID &aFPID)
Preload a footprint into the cache.
Holds a list of FOOTPRINT_INFO objects, along with a list of IO_ERRORs or PARSE_ERRORs that were thro...
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
#define _(s)
Definition: 3d_actions.cpp:33
void DisplayFootprint(const LIB_ID &aFPID)
Set the currently displayed footprint.
static constexpr int DblClickDelay
wxString wx_str() const
Definition: utf8.cpp:51
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:298
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
void Load(KIWAY &aKiway, PROJECT &aProject)
Start loading.
int HorizPixelsFromDU(int x)
Convert an integer number of dialog units to pixels, horizontally.
void ShowFootprintFor(LIB_ID const &aLibId)
Look up the footprint for a given symbol specified in the LIB_ID and display it.
GAL_TYPE GetBackend() const
Function GetBackend Returns the type of backend currently used by GAL canvas.
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > PTR
Reference-counting container for a pointer to CMP_TREE_MODEL_ADAPTER_BASE.
Definition for part library class.
int Parse(const UTF8 &aId, LIB_ID_TYPE aType, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:122
LIB_FIELD * GetField(int aId) const
Return pointer to the requested field.
bool IsInitialized() const
Return whether the widget initialized properly.
A shim class between EDA_DRAW_FRAME and several derived classes: LIB_EDIT_FRAME, LIB_VIEW_FRAME,...
void OnComponentSelected(wxCommandEvent &aEvent)
Handle the selection of an item.
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
To be called after this dialog returns from ShowModal().
void FilterByPinCount(int aPinCount)
Filter by pin count.
Widget displaying a tree of components with optional search text control and description panel.
Definition: lib_tree.h:42