KiCad PCB EDA Suite
Loading...
Searching...
No Matches
panel_symbol_chooser.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 <[email protected]>
5 * Copyright (C) 2016-2024 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
27#include <pgm_base.h>
28#include <kiface_base.h>
29#include <sch_base_frame.h>
30#include <project_sch.h>
31#include <widgets/lib_tree.h>
37#include <eeschema_settings.h>
39#include <symbol_library.h> // For SYMBOL_LIBRARY_FILTER
40#include <symbol_lib_table.h>
41#include <wx/button.h>
42#include <wx/clipbrd.h>
43#include <wx/panel.h>
44#include <wx/sizer.h>
45#include <wx/splitter.h>
46#include <wx/timer.h>
47#include <wx/wxhtml.h>
48#include <wx/log.h>
49
50
53
54
56 const SYMBOL_LIBRARY_FILTER* aFilter,
57 std::vector<PICKED_SYMBOL>& aHistoryList,
58 std::vector<PICKED_SYMBOL>& aAlreadyPlaced,
59 bool aAllowFieldEdits, bool aShowFootprints,
60 std::function<void()> aAcceptHandler,
61 std::function<void()> aEscapeHandler ) :
62 wxPanel( aParent, wxID_ANY, wxDefaultPosition, wxDefaultSize ),
63 m_symbol_preview( nullptr ),
64 m_hsplitter( nullptr ),
65 m_vsplitter( nullptr ),
66 m_fp_sel_ctrl( nullptr ),
67 m_fp_preview( nullptr ),
68 m_tree( nullptr ),
69 m_details( nullptr ),
70 m_frame( aFrame ),
71 m_acceptHandler( std::move( aAcceptHandler ) ),
72 m_escapeHandler( std::move( aEscapeHandler ) ),
73 m_showPower( false ),
74 m_allow_field_edits( aAllowFieldEdits ),
75 m_show_footprints( aShowFootprints )
76{
80
81 // Make sure settings are loaded before we start running multi-threaded symbol loaders
84
86 SYMBOL_TREE_MODEL_ADAPTER* adapter = static_cast<SYMBOL_TREE_MODEL_ADAPTER*>( m_adapter.get() );
87 bool loaded = false;
88
89 if( aFilter )
90 {
91 const wxArrayString& liblist = aFilter->GetAllowedLibList();
92
93 for( const wxString& nickname : liblist )
94 {
95 if( libs->HasLibrary( nickname, true ) )
96 {
97 loaded = true;
98
99 bool pinned = alg::contains( session.pinned_symbol_libs, nickname )
100 || alg::contains( project.m_PinnedSymbolLibs, nickname );
101
102 if( libs->FindRow( nickname )->GetIsVisible() )
103 adapter->AddLibrary( nickname, pinned );
104 }
105 }
106
107 adapter->AssignIntrinsicRanks();
108
109 if( aFilter->GetFilterPowerSymbols() )
110 {
111 // HACK ALERT: when loading symbols we presume that *any* filter is a power symbol
112 // filter. So the filter only needs to return true for libraries.
113 static std::function<bool( LIB_TREE_NODE& )> powerFilter =
114 []( LIB_TREE_NODE& aNode ) -> bool
115 {
116 return true;
117 };
118
119 adapter->SetFilter( &powerFilter );
120
121 m_showPower = true;
122 m_show_footprints = false;
123 }
124 }
125
126 std::vector<LIB_SYMBOL> history_list_storage;
127 std::vector<LIB_TREE_ITEM*> history_list;
128 std::vector<LIB_SYMBOL> already_placed_storage;
129 std::vector<LIB_TREE_ITEM*> already_placed;
130
131 // Lambda to encapsulate the common logic
132 auto processList =
133 [&]( const std::vector<PICKED_SYMBOL>& inputList,
134 std::vector<LIB_SYMBOL>& storageList,
135 std::vector<LIB_TREE_ITEM*>& resultList )
136 {
137 storageList.reserve( inputList.size() );
138
139 for( const PICKED_SYMBOL& i : inputList )
140 {
141 LIB_SYMBOL* symbol = m_frame->GetLibSymbol( i.LibId );
142
143 if( symbol )
144 {
145 storageList.emplace_back( *symbol );
146
147 for( const std::pair<int, wxString>& fieldDef : i.Fields )
148 {
149 SCH_FIELD* field = storageList.back().GetFieldById( fieldDef.first );
150
151 if( field )
152 field->SetText( fieldDef.second );
153 }
154
155 resultList.push_back( &storageList.back() );
156 }
157 }
158 };
159
160 // Sort the already placed list since it is potentially from multiple sessions,
161 // but not the most recent list since we want this listed by most recent usage.
162 std::sort( aAlreadyPlaced.begin(), aAlreadyPlaced.end(),
163 []( PICKED_SYMBOL const& a, PICKED_SYMBOL const& b )
164 {
165 return a.LibId.GetLibItemName() < b.LibId.GetLibItemName();
166 } );
167
168 processList( aHistoryList, history_list_storage, history_list );
169 processList( aAlreadyPlaced, already_placed_storage, already_placed );
170
171 adapter->DoAddLibrary( wxT( "-- " ) + _( "Recently Used" ) + wxT( " --" ), wxEmptyString,
172 history_list, false, true );
173
174 if( !aHistoryList.empty() )
175 adapter->SetPreselectNode( aHistoryList[0].LibId, aHistoryList[0].Unit );
176
177 adapter->DoAddLibrary( wxT( "-- " ) + _( "Already Placed" ) + wxT( " --" ), wxEmptyString,
178 already_placed, false, true );
179
180 const std::vector< wxString > libNicknames = libs->GetLogicalLibs();
181
182 if( !loaded )
183 {
184 if( !adapter->AddLibraries( libNicknames, m_frame ) )
185 {
186 // loading cancelled by user
188 }
189 }
190
191 // -------------------------------------------------------------------------------------
192 // Construct the actual panel
193 //
194
195 wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
196
197 // Use a slightly different layout, with a details pane spanning the entire window,
198 // if we're not showing footprints.
200 {
201 m_hsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
202 wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );
203
204 //Avoid the splitter window being assigned as the Parent to additional windows
205 m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
206
207 sizer->Add( m_hsplitter, 1, wxEXPAND, 5 );
208 }
209 else
210 {
211 m_vsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
212 wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );
213
214 m_hsplitter = new wxSplitterWindow( m_vsplitter, wxID_ANY, wxDefaultPosition, wxDefaultSize,
215 wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );
216
217 // Avoid the splitter window being assigned as the parent to additional windows.
218 m_vsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
219 m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
220
221 wxPanel* detailsPanel = new wxPanel( m_vsplitter );
222 wxBoxSizer* detailsSizer = new wxBoxSizer( wxVERTICAL );
223 detailsPanel->SetSizer( detailsSizer );
224
225 m_details = new HTML_WINDOW( detailsPanel, wxID_ANY, wxDefaultPosition, wxDefaultSize );
226 detailsSizer->Add( m_details, 1, wxEXPAND | wxLEFT | wxRIGHT | wxBOTTOM, 5 );
227 detailsPanel->Layout();
228 detailsSizer->Fit( detailsPanel );
229
230 m_vsplitter->SetSashGravity( 0.5 );
231 m_vsplitter->SetMinimumPaneSize( 20 );
232 m_vsplitter->SplitHorizontally( m_hsplitter, detailsPanel );
233
234 sizer->Add( m_vsplitter, 1, wxEXPAND | wxBOTTOM, 5 );
235 }
236
237 wxPanel* treePanel = new wxPanel( m_hsplitter );
238 wxBoxSizer* treeSizer = new wxBoxSizer( wxVERTICAL );
239 treePanel->SetSizer( treeSizer );
240
241 m_tree = new LIB_TREE( treePanel, m_showPower ? wxT( "power" ) : wxT( "symbols" ),
243
244 treeSizer->Add( m_tree, 1, wxALL | wxEXPAND, 5 );
245 treePanel->Layout();
246 treeSizer->Fit( treePanel );
247
248 m_adapter->FinishTreeInitialization();
249
250 if( m_showPower )
252 else
254
255 m_hsplitter->SetSashGravity( 0.8 );
256 m_hsplitter->SetMinimumPaneSize( 20 );
257 m_hsplitter->SplitVertically( treePanel, constructRightPanel( m_hsplitter ) );
258
259 m_dbl_click_timer = new wxTimer( this );
260 m_open_libs_timer = new wxTimer( this );
261
262 SetSizer( sizer );
263
264 Layout();
265
266 Bind( wxEVT_TIMER, &PANEL_SYMBOL_CHOOSER::onCloseTimer, this, m_dbl_click_timer->GetId() );
267 Bind( wxEVT_TIMER, &PANEL_SYMBOL_CHOOSER::onOpenLibsTimer, this, m_open_libs_timer->GetId() );
268 Bind( EVT_LIBITEM_SELECTED, &PANEL_SYMBOL_CHOOSER::onSymbolSelected, this );
269 Bind( EVT_LIBITEM_CHOSEN, &PANEL_SYMBOL_CHOOSER::onSymbolChosen, this );
270 Bind( wxEVT_CHAR_HOOK, &PANEL_SYMBOL_CHOOSER::OnChar, this );
271
272 if( m_fp_sel_ctrl )
273 {
274 m_fp_sel_ctrl->Bind( EVT_FOOTPRINT_SELECTED, &PANEL_SYMBOL_CHOOSER::onFootprintSelected,
275 this );
276 }
277
278 if( m_details )
279 {
280 m_details->Connect( wxEVT_CHAR_HOOK,
281 wxKeyEventHandler( PANEL_SYMBOL_CHOOSER::OnDetailsCharHook ),
282 nullptr, this );
283 }
284
285 // Open the user's previously opened libraries on timer expiration.
286 // This is done on a timer because we need a gross hack to keep GTK from garbling the
287 // display. Must be longer than the search debounce timer.
288 m_open_libs_timer->StartOnce( 300 );
289}
290
291
293{
294 Unbind( wxEVT_TIMER, &PANEL_SYMBOL_CHOOSER::onCloseTimer, this );
295 Unbind( EVT_LIBITEM_SELECTED, &PANEL_SYMBOL_CHOOSER::onSymbolSelected, this );
296 Unbind( EVT_LIBITEM_CHOSEN, &PANEL_SYMBOL_CHOOSER::onSymbolChosen, this );
297 Unbind( wxEVT_CHAR_HOOK, &PANEL_SYMBOL_CHOOSER::OnChar, this );
298
299 // Stop the timer during destruction early to avoid potential race conditions (that do happen)
300 m_dbl_click_timer->Stop();
301 m_open_libs_timer->Stop();
302 delete m_dbl_click_timer;
303 delete m_open_libs_timer;
304
305 if( m_showPower )
307 else
309
310 if( m_fp_sel_ctrl )
311 {
312 m_fp_sel_ctrl->Unbind( EVT_FOOTPRINT_SELECTED, &PANEL_SYMBOL_CHOOSER::onFootprintSelected,
313 this );
314 }
315
316 if( m_details )
317 {
318 m_details->Disconnect( wxEVT_CHAR_HOOK,
319 wxKeyEventHandler( PANEL_SYMBOL_CHOOSER::OnDetailsCharHook ),
320 nullptr, this );
321 }
322
323 if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
324 {
325 // Save any changes to column widths, etc.
326 m_adapter->SaveSettings();
327
328 cfg->m_SymChooserPanel.width = GetParent()->GetSize().x;
329 cfg->m_SymChooserPanel.height = GetParent()->GetSize().y;
330
331 cfg->m_SymChooserPanel.sash_pos_h = m_hsplitter->GetSashPosition();
332
333 if( m_vsplitter )
334 cfg->m_SymChooserPanel.sash_pos_v = m_vsplitter->GetSashPosition();
335
336 cfg->m_SymChooserPanel.sort_mode = m_tree->GetSortMode();
337 }
338}
339
340
341void PANEL_SYMBOL_CHOOSER::OnChar( wxKeyEvent& aEvent )
342{
343 if( aEvent.GetKeyCode() == WXK_ESCAPE )
344 {
345 wxObject* eventSource = aEvent.GetEventObject();
346
347 if( wxTextCtrl* textCtrl = dynamic_cast<wxTextCtrl*>( eventSource ) )
348 {
349 // First escape cancels search string value
350 if( textCtrl->GetValue() == m_tree->GetSearchString()
351 && !m_tree->GetSearchString().IsEmpty() )
352 {
353 m_tree->SetSearchString( wxEmptyString );
354 return;
355 }
356 }
357
359 }
360 else
361 {
362 aEvent.Skip();
363 }
364}
365
366
367wxPanel* PANEL_SYMBOL_CHOOSER::constructRightPanel( wxWindow* aParent )
368{
370
371 if( m_frame->GetCanvas() )
372 {
373 backend = m_frame->GetCanvas()->GetBackend();
374 }
375 else
376 {
379 }
380
381 wxPanel* panel = new wxPanel( aParent );
382 wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
383
384 m_symbol_preview = new SYMBOL_PREVIEW_WIDGET( panel, &m_frame->Kiway(), true, backend );
385 m_symbol_preview->SetLayoutDirection( wxLayout_LeftToRight );
386
388 {
390
391 sizer->Add( m_symbol_preview, 11, wxEXPAND | wxALL, 5 );
392
393 if ( fp_list )
394 {
396 m_fp_sel_ctrl = new FOOTPRINT_SELECT_WIDGET( m_frame, panel, fp_list, true );
397
400 }
401
402 if( m_fp_sel_ctrl )
403 sizer->Add( m_fp_sel_ctrl, 0, wxEXPAND | wxLEFT | wxRIGHT | wxBOTTOM, 5 );
404
405 if( m_fp_preview )
406 sizer->Add( m_fp_preview, 10, wxEXPAND | wxLEFT | wxRIGHT | wxBOTTOM, 5 );
407 }
408 else
409 {
410 sizer->Add( m_symbol_preview, 1, wxEXPAND | wxALL, 5 );
411 }
412
413 panel->SetSizer( sizer );
414 panel->Layout();
415 sizer->Fit( panel );
416
417 return panel;
418}
419
420
422{
423 if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
424 {
425 auto horizPixelsFromDU =
426 [&]( int x ) -> int
427 {
428 wxSize sz( x, 0 );
429 return GetParent()->ConvertDialogToPixels( sz ).x;
430 };
431
432 EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER& panelCfg = cfg->m_SymChooserPanel;
433
434 int w = panelCfg.width > 40 ? panelCfg.width : horizPixelsFromDU( 440 );
435 int h = panelCfg.height > 40 ? panelCfg.height : horizPixelsFromDU( 340 );
436
437 GetParent()->SetSize( wxSize( w, h ) );
438 GetParent()->Layout();
439
440 // We specify the width of the right window (m_symbol_view_panel), because specify
441 // the width of the left window does not work as expected when SetSashGravity() is called
442
443 if( panelCfg.sash_pos_h < 0 )
444 panelCfg.sash_pos_h = horizPixelsFromDU( 220 );
445
446 if( panelCfg.sash_pos_v < 0 )
447 panelCfg.sash_pos_v = horizPixelsFromDU( 230 );
448
449 m_hsplitter->SetSashPosition( panelCfg.sash_pos_h );
450
451 if( m_vsplitter )
452 m_vsplitter->SetSashPosition( panelCfg.sash_pos_v );
453
454 m_adapter->SetSortMode( (LIB_TREE_MODEL_ADAPTER::SORT_MODE) panelCfg.sort_mode );
455 }
456
458 {
459 // This hides the GAL panel and shows the status label
460 m_fp_preview->SetStatusText( wxEmptyString );
461 }
462
463 if( m_fp_sel_ctrl )
465}
466
467
469{
470 if( m_details && e.GetKeyCode() == 'C' && e.ControlDown() &&
471 !e.AltDown() && !e.ShiftDown() && !e.MetaDown() )
472 {
473 wxString txt = m_details->SelectionToText();
474 wxLogNull doNotLog; // disable logging of failed clipboard actions
475
476 if( wxTheClipboard->Open() )
477 {
478 wxTheClipboard->SetData( new wxTextDataObject( txt ) );
479 wxTheClipboard->Flush(); // Allow data to be available after closing KiCad
480 wxTheClipboard->Close();
481 }
482 }
483 else
484 {
485 e.Skip();
486 }
487}
488
489
491{
492 m_adapter->SetPreselectNode( aPreselect, 0 );
493}
494
495
497{
498 return m_tree->GetSelectedLibId( aUnit );
499}
500
501
502void PANEL_SYMBOL_CHOOSER::onCloseTimer( wxTimerEvent& aEvent )
503{
504 // Hack because of eaten MouseUp event. See PANEL_SYMBOL_CHOOSER::onSymbolChosen
505 // for the beginning of this spaghetti noodle.
506
507 wxMouseState state = wxGetMouseState();
508
509 if( state.LeftIsDown() )
510 {
511 // Mouse hasn't been raised yet, so fire the timer again. Otherwise the
512 // purpose of this timer is defeated.
514 }
515 else
516 {
518 }
519}
520
521
522void PANEL_SYMBOL_CHOOSER::onOpenLibsTimer( wxTimerEvent& aEvent )
523{
524 if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
525 m_adapter->OpenLibs( cfg->m_LibTree.open_libs );
526}
527
528
530{
532 return;
533
534 LIB_SYMBOL* symbol = nullptr;
535
536 try
537 {
538 symbol = PROJECT_SCH::SchSymbolLibTable( &m_frame->Prj() )->LoadSymbol( aLibId );
539 }
540 catch( const IO_ERROR& ioe )
541 {
542 wxLogError( _( "Error loading symbol %s from library '%s'." ) + wxS( "\n%s" ),
543 aLibId.GetLibItemName().wx_str(),
544 aLibId.GetLibNickname().wx_str(),
545 ioe.What() );
546 }
547
548 if( !symbol )
549 return;
550
551 SCH_FIELD* fp_field = symbol->GetFieldById( FOOTPRINT_FIELD );
552 wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
553
554 showFootprint( fp_name );
555}
556
557
558void PANEL_SYMBOL_CHOOSER::showFootprint( wxString const& aFootprint )
559{
561 return;
562
563 if( aFootprint == wxEmptyString )
564 {
565 m_fp_preview->SetStatusText( _( "No footprint specified" ) );
566 }
567 else
568 {
569 LIB_ID lib_id;
570
571 if( lib_id.Parse( aFootprint ) == -1 && lib_id.IsValid() )
572 {
575 }
576 else
577 {
578 m_fp_preview->SetStatusText( _( "Invalid footprint specified" ) );
579 }
580 }
581}
582
583
585{
586 if( !m_fp_sel_ctrl )
587 return;
588
590
591 LIB_SYMBOL* symbol = nullptr;
592
593 if( aLibId.IsValid() )
594 {
595 try
596 {
597 symbol = PROJECT_SCH::SchSymbolLibTable( &m_frame->Prj() )->LoadSymbol( aLibId );
598 }
599 catch( const IO_ERROR& ioe )
600 {
601 wxLogError( _( "Error loading symbol %s from library '%s'." ) + wxS( "\n%s" ),
602 aLibId.GetLibItemName().wx_str(),
603 aLibId.GetLibNickname().wx_str(),
604 ioe.What() );
605 }
606 }
607
608 if( symbol != nullptr )
609 {
610 int pinCount = symbol->GetPins( 0 /* all units */, 1 /* single bodyStyle */ ).size();
611 SCH_FIELD* fp_field = symbol->GetFieldById( FOOTPRINT_FIELD );
612 wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
613
614 m_fp_sel_ctrl->FilterByPinCount( pinCount );
619 }
620 else
621 {
623 m_fp_sel_ctrl->Disable();
624 }
625}
626
627
628void PANEL_SYMBOL_CHOOSER::onFootprintSelected( wxCommandEvent& aEvent )
629{
630 m_fp_override = aEvent.GetString();
631
632 alg::delete_if( m_field_edits, []( std::pair<int, wxString> const& i )
633 {
634 return i.first == FOOTPRINT_FIELD;
635 } );
636
637 m_field_edits.emplace_back( std::make_pair( FOOTPRINT_FIELD, m_fp_override ) );
638
640}
641
642
643void PANEL_SYMBOL_CHOOSER::onSymbolSelected( wxCommandEvent& aEvent )
644{
646
647 if( node && node->m_LibId.IsValid() )
648 {
650
651 if( !node->m_Footprint.IsEmpty() )
652 showFootprint( node->m_Footprint );
653 else
654 showFootprintFor( node->m_LibId );
655
657 }
658 else
659 {
660 m_symbol_preview->SetStatusText( _( "No symbol selected" ) );
661
663 m_fp_preview->SetStatusText( wxEmptyString );
664
666 }
667}
668
669
670void PANEL_SYMBOL_CHOOSER::onSymbolChosen( wxCommandEvent& aEvent )
671{
673 {
674 // Got a selection. We can't just end the modal dialog here, because wx leaks some events
675 // back to the parent window (in particular, the MouseUp following a double click).
676 //
677 // NOW, here's where it gets really fun. wxTreeListCtrl eats MouseUp. This isn't really
678 // feasible to bypass without a fully custom wxDataViewCtrl implementation, and even then
679 // might not be fully possible (docs are vague). To get around this, we use a one-shot
680 // timer to schedule the dialog close.
681 //
682 // See PANEL_SYMBOL_CHOOSER::onCloseTimer for the other end of this spaghetti noodle.
684 }
685}
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
GAL_TYPE GetBackend() const
Return the type of backend currently used by GAL canvas.
Holds a list of FOOTPRINT_INFO objects, along with a list of IO_ERRORs or PARSE_ERRORs that were thro...
static FOOTPRINT_LIST * GetInstance(KIWAY &aKiway)
Factory function to return a FOOTPRINT_LIST via Kiway.
void DisplayFootprint(const LIB_ID &aFPID)
Set the currently displayed footprint.
void SetUserUnits(EDA_UNITS aUnits)
Set the units for the preview.
bool IsInitialized() const
Return whether the widget initialized properly.
void SetStatusText(const wxString &aText)
Set the contents of the status label and display it.
void ClearStatus()
Clear the contents of the status label and hide it.
virtual bool Enable(bool aEnable=true) override
Enable or disable the control for input.
void FilterByFootprintFilters(const wxArrayString &aFilters, bool aZeroFilters)
Filter by footprint filter list.
void SetDefaultFootprint(const wxString &aFp)
Set the default footprint for a part.
void FilterByPinCount(int aPinCount)
Filter by pin count.
bool UpdateList()
Update the contents of the list to match the filters.
void ClearFilters()
Clear all filters.
void Load(KIWAY &aKiway, PROJECT &aProject)
Start loading.
Add dark theme support to wxHtmlWindow.
Definition: html_window.h:35
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:55
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:51
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:172
const UTF8 & GetLibItemName() const
Definition: lib_id.h:102
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:87
Define a library symbol object.
Definition: lib_symbol.h:78
std::vector< SCH_PIN * > GetPins(int aUnit=0, int aBodyStyle=0) const
Return a list of pin object pointers from the draw item list.
Definition: lib_symbol.cpp:822
SCH_FIELD * GetFieldById(int aId) const
Return pointer to the requested field.
wxArrayString GetFPFilters() const
Definition: lib_symbol.h:206
bool GetIsVisible() const
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
void SetPreselectNode(const LIB_ID &aLibId, int aUnit)
Set the symbol name to be selected if there are no search results.
void DoAddLibrary(const wxString &aNodeName, const wxString &aDesc, const std::vector< LIB_TREE_ITEM * > &aItemList, bool pinned, bool presorted)
Add the given list of symbols by alias.
void AssignIntrinsicRanks()
Sort the tree and assign ranks after adding libraries.
void SetFilter(std::function< bool(LIB_TREE_NODE &aNode)> *aFilter)
Set the symbol filter type.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
wxString m_Footprint
Widget displaying a tree of symbols with optional search text control and description panel....
Definition: lib_tree.h:49
LIB_TREE_NODE * GetCurrentTreeNode() const
Definition: lib_tree.cpp:332
LIB_TREE_MODEL_ADAPTER::SORT_MODE GetSortMode() const
Definition: lib_tree.h:141
wxString GetSearchString() const
Definition: lib_tree.cpp:387
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:301
@ ALL_WIDGETS
Definition: lib_tree.h:58
void SetSearchString(const wxString &aSearchString)
Save/restore search string.
Definition: lib_tree.cpp:381
PANEL_SYMBOL_CHOOSER(SCH_BASE_FRAME *aFrame, wxWindow *aParent, const SYMBOL_LIBRARY_FILTER *aFilter, std::vector< PICKED_SYMBOL > &aHistoryList, std::vector< PICKED_SYMBOL > &aAlreadyPlaced, bool aAllowFieldEdits, bool aShowFootprints, std::function< void()> aAcceptHandler, std::function< void()> aEscapeHandler)
Create dialog to choose symbol.
SYMBOL_PREVIEW_WIDGET * m_symbol_preview
void onSymbolSelected(wxCommandEvent &aEvent)
void showFootprintFor(const LIB_ID &aLibId)
Look up the footprint for a given symbol specified in the LIB_ID and display it.
wxSplitterWindow * m_hsplitter
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
std::function< void()> m_escapeHandler
void OnDetailsCharHook(wxKeyEvent &aEvt)
static wxString g_symbolSearchString
void onCloseTimer(wxTimerEvent &aEvent)
wxSplitterWindow * m_vsplitter
std::vector< std::pair< int, wxString > > m_field_edits
void showFootprint(const wxString &aFootprint)
Display the given footprint by name.
void populateFootprintSelector(const LIB_ID &aLibId)
Populate the footprint selector for a given alias.
void onOpenLibsTimer(wxTimerEvent &aEvent)
void onFootprintSelected(wxCommandEvent &aEvent)
static wxString g_powerSearchString
void OnChar(wxKeyEvent &aEvent)
void SetPreselect(const LIB_ID &aPreselect)
std::function< void()> m_acceptHandler
static constexpr int DBLCLICK_DELAY
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > m_adapter
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
To be called after this dialog returns from ShowModal().
void onSymbolChosen(wxCommandEvent &aEvent)
Handle the selection of an item.
wxPanel * constructRightPanel(wxWindow *aParent)
virtual COMMON_SETTINGS * GetCommonSettings() const
Definition: pgm_base.cpp:679
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:142
The backing store for a PROJECT, in JSON format.
Definition: project_file.h:72
static SYMBOL_LIB_TABLE * SchSymbolLibTable(PROJECT *aProject)
Accessor for project symbol library table.
virtual PROJECT_FILE & GetProjectFile() const
Definition: project.h:200
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
LIB_SYMBOL * GetLibSymbol(const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
Load symbol from symbol library table.
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Definition: sch_field.h:51
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: sch_field.cpp:335
void SetText(const wxString &aText) override
Definition: sch_field.cpp:1210
T * GetAppSettings()
Returns a handle to the a given settings by type If the settings have already been loaded,...
Helper object to filter a list of libraries.
const wxArrayString & GetAllowedLibList() const
LIB_SYMBOL * LoadSymbol(const wxString &aNickname, const wxString &aName)
Load a LIB_SYMBOL having aName from the library given by aNickname.
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
void SetStatusText(const wxString &aText)
Set the contents of the status label and display it.
void DisplaySymbol(const LIB_ID &aSymbolID, int aUnit, int aBodyStyle=0)
Set the currently displayed symbol.
bool AddLibraries(const std::vector< wxString > &aNicknames, SCH_BASE_FRAME *aFrame)
Add all the libraries in a SYMBOL_LIB_TABLE to the model.
static wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > Create(SCH_BASE_FRAME *aParent, LIB_TABLE *aLibs)
Factory function: create a model adapter in a reference-counting container.
void AddLibrary(wxString const &aLibNickname, bool pinned)
EDA_UNITS GetUserUnits() const
wxString wx_str() const
Definition: utf8.cpp:45
#define _(s)
void delete_if(_Container &__c, _Function &&__f)
Deletes all values from __c for which __f returns true.
Definition: kicad_algo.h:174
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:100
STL namespace.
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: pgm_base.cpp:1060
see class PGM_BASE
std::vector< wxString > pinned_symbol_libs
Definition for symbol library class.
@ FOOTPRINT_FIELD
Field Name Module PCB, i.e. "16DIP300".