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 
26 #include <algorithm>
27 #include <wx/utils.h>
28 #include <wx/button.h>
29 #include <wx/dataview.h>
30 #include <wx/panel.h>
31 #include <wx/sizer.h>
32 #include <wx/splitter.h>
33 #include <wx/timer.h>
34 #include <class_library.h>
35 #include <sch_base_frame.h>
36 #include <template_fieldnames.h>
37 #include <symbol_lib_table.h>
38 #include <widgets/lib_tree.h>
42 #include <wx/clipbrd.h>
43 #include <kiface_i.h>
44 
45 #define SYM_CHOOSER_HSASH wxT( "SymbolChooserHSashPosition" )
46 #define SYM_CHOOSER_VSASH wxT( "SymbolChooserVSashPosition" )
47 #define SYM_CHOOSER_WIDTH_KEY wxT( "SymbolChooserWidth" )
48 #define SYM_CHOOSER_HEIGHT_KEY wxT( "SymbolChooserHeight" )
49 #define SYM_CHOOSER_KEEP_SYM_KEY wxT( "SymbolChooserKeepSymbol" )
50 #define SYM_CHOOSER_USE_UNITS_KEY wxT( "SymbolChooserUseUnits" )
51 
52 
54 
55 
58  int aDeMorganConvert, bool aAllowFieldEdits,
59  bool aShowFootprints, bool aAllowBrowser )
60  : DIALOG_SHIM( aParent, wxID_ANY, aTitle, wxDefaultPosition, wxDefaultSize,
61  wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ),
62  m_browser_button( nullptr ),
63  m_hsplitter( nullptr ),
64  m_vsplitter( nullptr ),
65  m_fp_sel_ctrl( nullptr ),
66  m_fp_preview( nullptr ),
67  m_tree( nullptr ),
68  m_details( nullptr ),
69  m_parent( aParent ),
70  m_deMorganConvert( aDeMorganConvert >= 0 ? aDeMorganConvert : 0 ),
71  m_allow_field_edits( aAllowFieldEdits ),
72  m_show_footprints( aShowFootprints ),
73  m_external_browser_requested( false )
74 {
76 
77  auto 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( aShowFootprints )
82  {
83  m_hsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
84  wxSP_LIVE_UPDATE );
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 );
95 
96  m_hsplitter = new wxSplitterWindow( m_vsplitter, wxID_ANY, wxDefaultPosition, wxDefaultSize,
97  wxSP_LIVE_UPDATE );
98 
99  //Avoid the splitter window being assigned as the Parent to additional windows
100  m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
101 
102  auto detailsPanel = new wxPanel( m_vsplitter );
103  auto detailsSizer = new wxBoxSizer( wxVERTICAL );
104  detailsPanel->SetSizer( detailsSizer );
105 
106  m_details = new wxHtmlWindow( detailsPanel, wxID_ANY, wxDefaultPosition, wxDefaultSize,
107  wxHW_SCROLLBAR_AUTO );
108  detailsSizer->Add( m_details, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
109  detailsPanel->Layout();
110  detailsSizer->Fit( detailsPanel );
111 
112  m_vsplitter->SetSashGravity( 0.5 );
113  m_vsplitter->SetMinimumPaneSize( 20 );
114  m_vsplitter->SplitHorizontally( m_hsplitter, detailsPanel );
115 
116  sizer->Add( m_vsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
117  }
118 
119  m_tree = new LIB_TREE( m_hsplitter, Prj().SchSymbolLibTable(), aAdapter,
121 
122  m_hsplitter->SetSashGravity( 0.8 );
123  m_hsplitter->SetMinimumPaneSize( 20 );
124  m_hsplitter->SplitVertically( m_tree, ConstructRightPanel( m_hsplitter ) );
125 
126  m_dbl_click_timer = new wxTimer( this );
127 
128  auto buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
129 
130  if( aAllowBrowser )
131  {
132  m_browser_button = new wxButton( this, wxID_ANY, _( "Select with Browser" ) );
133  buttonsSizer->Add( m_browser_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
134  }
135 
136  auto sdbSizer = new wxStdDialogButtonSizer();
137  auto okButton = new wxButton( this, wxID_OK );
138  auto cancelButton = new wxButton( this, wxID_CANCEL );
139  sdbSizer->AddButton( okButton );
140  sdbSizer->AddButton( cancelButton );
141  sdbSizer->Realize();
142 
143  buttonsSizer->Add( sdbSizer, 1, wxALL, 5 );
144 
145  sizer->Add( buttonsSizer, 0, wxEXPAND | wxLEFT, 5 );
146  SetSizer( sizer );
147 
148  Layout();
149 
150  // We specify the width of the right window (m_symbol_view_panel), because specify
151  // the width of the left window does not work as expected when SetSashGravity() is called
152  m_hsplitter->SetSashPosition( m_config->Read( SYM_CHOOSER_HSASH, HorizPixelsFromDU( 220 ) ) );
153 
154  if( m_vsplitter )
155  m_vsplitter->SetSashPosition( m_config->Read( SYM_CHOOSER_VSASH, VertPixelsFromDU( 230 ) ) );
156 
157  wxSize dlgSize( m_config->Read( SYM_CHOOSER_WIDTH_KEY, HorizPixelsFromDU( 390 ) ),
159  SetSize( dlgSize );
160 
162  okButton->SetDefault();
163 
164  Bind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_COMPONENT::OnInitDialog, this );
165  Bind( wxEVT_TIMER, &DIALOG_CHOOSE_COMPONENT::OnCloseTimer, this, m_dbl_click_timer->GetId() );
166  Bind( COMPONENT_PRESELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentPreselected, this );
167  Bind( COMPONENT_SELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentSelected, this );
168 
169  if( m_browser_button )
170  m_browser_button->Bind( wxEVT_COMMAND_BUTTON_CLICKED,
172 
173  if( m_fp_sel_ctrl )
174  m_fp_sel_ctrl->Bind( EVT_FOOTPRINT_SELECTED,
176 
177  if( m_details )
178  m_details->Connect( wxEVT_CHAR_HOOK,
179  wxKeyEventHandler( DIALOG_CHOOSE_COMPONENT::OnCharHook ),
180  NULL, this );
181 }
182 
183 
185 {
186  Unbind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_COMPONENT::OnInitDialog, this );
187  Unbind( wxEVT_TIMER, &DIALOG_CHOOSE_COMPONENT::OnCloseTimer, this );
188  Unbind( COMPONENT_PRESELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentPreselected, this );
189  Unbind( COMPONENT_SELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentSelected, this );
190 
191  if( m_browser_button )
192  m_browser_button->Unbind( wxEVT_COMMAND_BUTTON_CLICKED,
194 
195  if( m_fp_sel_ctrl )
196  m_fp_sel_ctrl->Unbind( EVT_FOOTPRINT_SELECTED,
198 
199  if( m_details )
200  m_details->Disconnect( wxEVT_CHAR_HOOK,
201  wxKeyEventHandler( DIALOG_CHOOSE_COMPONENT::OnCharHook ),
202  NULL, this );
203 
204  // I am not sure the following two lines are necessary, but they will not hurt anyone
205  m_dbl_click_timer->Stop();
206  delete m_dbl_click_timer;
207 
208  m_config->Write( SYM_CHOOSER_WIDTH_KEY, GetSize().x );
209  m_config->Write( SYM_CHOOSER_HEIGHT_KEY, GetSize().y );
210 
211  m_config->Write( SYM_CHOOSER_KEEP_SYM_KEY, m_keepSymbol->GetValue() );
212  m_config->Write( SYM_CHOOSER_USE_UNITS_KEY, m_useUnits->GetValue() );
213 
214  m_config->Write( SYM_CHOOSER_HSASH, m_hsplitter->GetSashPosition() );
215 
216  if( m_vsplitter )
217  m_config->Write( SYM_CHOOSER_VSASH, m_vsplitter->GetSashPosition() );
218 }
219 
220 
221 wxPanel* DIALOG_CHOOSE_COMPONENT::ConstructRightPanel( wxWindow* aParent )
222 {
223  auto panel = new wxPanel( aParent );
224  auto sizer = new wxBoxSizer( wxVERTICAL );
225 
227  m_parent->GetCanvas()->GetBackend() );
228  m_symbol_preview->SetLayoutDirection( wxLayout_LeftToRight );
229 
230  if( m_show_footprints )
231  {
233 
234  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxTOP | wxBOTTOM | wxRIGHT, 5 );
235 
236  if ( fp_list )
237  {
238  if( m_allow_field_edits )
239  m_fp_sel_ctrl = new FOOTPRINT_SELECT_WIDGET( panel, fp_list, true );
240 
241  m_fp_preview = new FOOTPRINT_PREVIEW_WIDGET( panel, Kiway() );
242  }
243 
244  if( m_fp_sel_ctrl )
245  sizer->Add( m_fp_sel_ctrl, 0, wxEXPAND | wxBOTTOM | wxTOP | wxRIGHT, 5 );
246 
247  if( m_fp_preview )
248  sizer->Add( m_fp_preview, 1, wxEXPAND | wxBOTTOM | wxRIGHT, 5 );
249  }
250  else
251  {
252  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxTOP | wxRIGHT, 5 );
253  }
254 
255  m_keepSymbol = new wxCheckBox( panel, 1000, _("Multi-Symbol Placement"), wxDefaultPosition,
256  wxDefaultSize, wxALIGN_RIGHT );
257  m_keepSymbol->SetValue( m_config->ReadBool( SYM_CHOOSER_KEEP_SYM_KEY, false ) );
258  m_keepSymbol->SetToolTip( _( "Place multiple copies of the symbol." ) );
259 
260  m_useUnits = new wxCheckBox( panel, 1000, _("Place all units"), wxDefaultPosition,
261  wxDefaultSize, wxALIGN_RIGHT );
262  m_useUnits->SetValue( m_config->ReadBool( SYM_CHOOSER_USE_UNITS_KEY, true ) );
263  m_useUnits->SetToolTip( _( "Sequentially place all units of the symbol." ) );
264 
265  auto fgSizer = new wxFlexGridSizer( 0, 2, 0, 1 );
266  fgSizer->AddGrowableCol( 0 );
267  fgSizer->SetFlexibleDirection( wxBOTH );
268  fgSizer->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_SPECIFIED );
269 
270  fgSizer->Add( 0, 0, 1, wxEXPAND );
271  fgSizer->Add( m_keepSymbol, 0, wxALIGN_CENTER_VERTICAL|wxALIGN_RIGHT|wxBOTTOM|wxRIGHT|wxLEFT, 5 );
272  fgSizer->Add( 0, 0, 1, wxEXPAND );
273  fgSizer->Add( m_useUnits, 0, wxALIGN_CENTER_VERTICAL|wxALIGN_RIGHT|wxBOTTOM|wxRIGHT|wxLEFT, 5 );
274 
275  sizer->Add( fgSizer, 0, wxALL | wxEXPAND, 5 );
276  panel->SetSizer( sizer );
277  panel->Layout();
278  sizer->Fit( panel );
279 
280  return panel;
281 }
282 
283 
284 void DIALOG_CHOOSE_COMPONENT::OnInitDialog( wxInitDialogEvent& aEvent )
285 {
287  {
288  // This hides the GAL panel and shows the status label
289  m_fp_preview->SetStatusText( wxEmptyString );
290  }
291 
292  if( m_fp_sel_ctrl )
293  m_fp_sel_ctrl->Load( Kiway(), Prj() );
294 }
295 
296 
298 {
299  if( m_details && e.GetKeyCode() == 'C' && e.ControlDown() &&
300  !e.AltDown() && !e.ShiftDown() && !e.MetaDown() )
301  {
302  wxString txt = m_details->SelectionToText();
303 
304  if( wxTheClipboard->Open() )
305  {
306  wxTheClipboard->SetData( new wxTextDataObject( txt ) );
307  wxTheClipboard->Close();
308  }
309  }
310  else
311  {
312  e.Skip();
313  }
314 }
315 
316 
318 {
319  return m_tree->GetSelectedLibId( aUnit );
320 }
321 
322 
323 void DIALOG_CHOOSE_COMPONENT::OnUseBrowser( wxCommandEvent& aEvent )
324 {
326  EndQuasiModal( wxID_OK );
327 }
328 
329 
330 void DIALOG_CHOOSE_COMPONENT::OnCloseTimer( wxTimerEvent& aEvent )
331 {
332  // Hack handler because of eaten MouseUp event. See
333  // DIALOG_CHOOSE_COMPONENT::OnComponentSelected for the beginning
334  // of this spaghetti noodle.
335 
336  auto state = wxGetMouseState();
337 
338  if( state.LeftIsDown() )
339  {
340  // Mouse hasn't been raised yet, so fire the timer again. Otherwise the
341  // purpose of this timer is defeated.
343  }
344  else
345  {
346  EndQuasiModal( wxID_OK );
347  }
348 }
349 
350 
352 {
354  return;
355 
356  LIB_ALIAS* alias = nullptr;
357 
358  try
359  {
360  alias = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
361  }
362  catch( const IO_ERROR& ioe )
363  {
364  wxLogError( wxString::Format( _( "Error loading symbol %s from library %s.\n\n%s" ),
365  aLibId.GetLibItemName().wx_str(),
366  aLibId.GetLibNickname().wx_str(),
367  ioe.What() ) );
368  }
369 
370  if( !alias )
371  return;
372 
373  LIB_FIELD* fp_field = alias->GetPart()->GetField( FOOTPRINT );
374  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
375 
376  ShowFootprint( fp_name );
377 }
378 
379 
380 void DIALOG_CHOOSE_COMPONENT::ShowFootprint( wxString const& aName )
381 {
383  return;
384 
385  if( aName == wxEmptyString )
386  {
387  m_fp_preview->SetStatusText( _( "No footprint specified" ) );
388  }
389  else
390  {
391  LIB_ID lib_id;
392 
393  if( lib_id.Parse( aName, LIB_ID::ID_PCB ) == -1 && lib_id.IsValid() )
394  {
396  m_fp_preview->CacheFootprint( lib_id );
397  m_fp_preview->DisplayFootprint( lib_id );
398  }
399  else
400  {
401  m_fp_preview->SetStatusText( _( "Invalid footprint specified" ) );
402  }
403  }
404 }
405 
406 
408 {
409  if( !m_fp_sel_ctrl )
410  return;
411 
413 
414  LIB_ALIAS* alias = nullptr;
415 
416  if( aLibId.IsValid() )
417  {
418  try
419  {
420  alias = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
421  }
422  catch( const IO_ERROR& ioe )
423  {
424  wxLogError( wxString::Format( _( "Error occurred loading symbol %s from library %s."
425  "\n\n%s" ),
426  aLibId.GetLibItemName().wx_str(),
427  aLibId.GetLibNickname().wx_str(),
428  ioe.What() ) );
429  }
430  }
431 
432  if( alias != nullptr )
433  {
434  LIB_PINS temp_pins;
435  LIB_FIELD* fp_field = alias->GetPart()->GetField( FOOTPRINT );
436  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
437 
438  alias->GetPart()->GetPins( temp_pins );
439 
440  m_fp_sel_ctrl->FilterByPinCount( temp_pins.size() );
445  }
446  else
447  {
449  m_fp_sel_ctrl->Disable();
450  }
451 }
452 
453 
454 void DIALOG_CHOOSE_COMPONENT::OnFootprintSelected( wxCommandEvent& aEvent )
455 {
456  m_fp_override = aEvent.GetString();
457 
458  m_field_edits.erase(
459  std::remove_if( m_field_edits.begin(), m_field_edits.end(),
460  []( std::pair<int, wxString> const& i )
461  {
462  return i.first == FOOTPRINT;
463  } ),
464  m_field_edits.end() );
465 
466  m_field_edits.emplace_back( std::make_pair( FOOTPRINT, m_fp_override ) );
467 
469 }
470 
471 
473 {
474  int unit = 0;
475 
476  LIB_ID id = m_tree->GetSelectedLibId( &unit );
477 
478  if( id.IsValid() )
479  {
480  m_symbol_preview->DisplaySymbol( id, unit );
481 
482  ShowFootprintFor( id );
484  }
485  else
486  {
487  m_symbol_preview->SetStatusText( _( "No symbol selected" ) );
488 
490  m_fp_preview->SetStatusText( wxEmptyString );
491 
493  }
494 }
495 
496 
497 void DIALOG_CHOOSE_COMPONENT::OnComponentSelected( wxCommandEvent& aEvent )
498 {
499  if( m_tree->GetSelectedLibId().IsValid() )
500  {
501  // Got a selection. We can't just end the modal dialog here, because
502  // wx leaks some events back to the parent window (in particular, the
503  // MouseUp following a double click).
504  //
505  // NOW, here's where it gets really fun. wxTreeListCtrl eats MouseUp.
506  // This isn't really feasible to bypass without a fully custom
507  // wxDataViewCtrl implementation, and even then might not be fully
508  // possible (docs are vague). To get around this, we use a one-shot
509  // timer to schedule the dialog close.
510  //
511  // See DIALOG_CHOOSE_COMPONENT::OnCloseTimer for the other end of this
512  // spaghetti noodle.
514  }
515 }
516 
517 
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Part library alias object definition.
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
#define SYM_CHOOSER_VSASH
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.
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
void ShowFootprint(wxString const &aFootprint)
Display the given footprint by name.
#define SYM_CHOOSER_HSASH
Class DIALOG_SHIM may sit in the inheritance tree between wxDialog and any class written by wxFormBui...
Definition: dialog_shim.h:83
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
bool IsValid() const
Definition: lib_id.h:171
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:118
Field Name Module PCB, i.e. "16DIP300".
void OnComponentPreselected(wxCommandEvent &aEvent)
#define SYM_CHOOSER_USE_UNITS_KEY
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
void ClearFilters()
Clear all filters.
void OnCharHook(wxKeyEvent &aEvt)
bool UpdateList()
Update the contents of the list to match the filters.
void DisplaySymbol(const LIB_ID &aSymbolID, int aUnit)
Set the currently displayed symbol.
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)
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.
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 components, if the user selects the component itself rather than picking an individual...
Definition: lib_tree.cpp:145
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
#define SYM_CHOOSER_KEEP_SYM_KEY
wxPanel * ConstructRightPanel(wxWindow *aParent)
Definition: hash_eda.h:46
LIB_PART * GetPart() const
Get the shared LIB_PART.
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
void OnUseBrowser(wxCommandEvent &aEvent)
#define _(s)
wxArrayString & GetFootprints()
#define SYM_CHOOSER_WIDTH_KEY
#define SYM_CHOOSER_HEIGHT_KEY
int VertPixelsFromDU(int y)
Convert an integer number of dialog units to pixels, vertically.
void EndQuasiModal(int retCode)
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
void DisplayFootprint(const LIB_ID &aFPID)
Set the currently displayed footprint.
static constexpr int DblClickDelay
size_t i
Definition: json11.cpp:649
wxString wx_str() const
Definition: utf8.cpp:51
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:300
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
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