KiCad PCB EDA Suite
Loading...
Searching...
No Matches
panel_footprint_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) 2023 CERN
6 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
27#include <wx/button.h>
28#include <wx/clipbrd.h>
29#include <wx/log.h>
30#include <wx/panel.h>
31#include <wx/sizer.h>
32#include <wx/splitter.h>
33#include <wx/timer.h>
34#include <wx/wxhtml.h>
35#include <pcb_base_frame.h>
36#include <pcbnew_settings.h>
37#include <pgm_base.h>
38#include <fp_lib_table.h>
40#include <widgets/lib_tree.h>
43#include <footprint_info_impl.h>
44#include <project_pcb.h>
45#include <kiface_base.h>
46#include <tool/actions.h>
47#include <tool/tool_manager.h>
48
49// When a new footprint is selected, a custom event is sent, for instance to update
50// 3D viewer. So define a FP_SELECTION_EVENT event
51wxDEFINE_EVENT(FP_SELECTION_EVENT, wxCommandEvent);
52
54 const wxArrayString& aFootprintHistoryList,
55 std::function<bool( LIB_TREE_NODE& )> aFilter,
56 std::function<void()> aAcceptHandler,
57 std::function<void()> aEscapeHandler ) :
58 wxPanel( aParent, wxID_ANY, wxDefaultPosition, wxDefaultSize ),
59 m_hsplitter( nullptr ),
60 m_vsplitter( nullptr ),
61 m_frame( aFrame ),
62 m_filter( std::move( aFilter ) ),
63 m_acceptHandler( std::move( aAcceptHandler ) ),
64 m_escapeHandler( std::move( aEscapeHandler ) )
65{
66 m_CurrFootprint = nullptr;
67 FP_LIB_TABLE* fpTable = PROJECT_PCB::PcbFootprintLibs( &aFrame->Prj() );
68
69 // Load footprint files:
70 auto* progressReporter = new WX_PROGRESS_REPORTER( aParent, _( "Load Footprint Libraries" ), 1,
72 GFootprintList.ReadFootprintFiles( fpTable, nullptr, progressReporter );
73
74 // Force immediate deletion of the WX_PROGRESS_REPORTER. Do not use Destroy(), or use
75 // Destroy() followed by wxSafeYield() because on Windows, APP_PROGRESS_DIALOG and
76 // WX_PROGRESS_REPORTER have some side effects on the event loop manager. For instance, a
77 // subsequent call to ShowModal() or ShowQuasiModal() for a dialog following the use of a
78 // WX_PROGRESS_REPORTER results in incorrect modal or quasi modal behavior.
79 delete progressReporter;
80
83
84 m_adapter = FP_TREE_MODEL_ADAPTER::Create( aFrame, fpTable );
85 FP_TREE_MODEL_ADAPTER* adapter = static_cast<FP_TREE_MODEL_ADAPTER*>( m_adapter.get() );
86
87 std::vector<LIB_TREE_ITEM*> historyInfos;
88
89 for( const wxString& item : aFootprintHistoryList )
90 {
92
93 // this can be null, for example, if the footprint has been deleted from a library.
94 if( fp_info != nullptr )
95 historyInfos.push_back( fp_info );
96 }
97
98 adapter->DoAddLibrary( wxT( "-- " ) + _( "Recently Used" ) + wxT( " --" ), wxEmptyString,
99 historyInfos, false, true )
100 .m_IsRecentlyUsedGroup = true;
101
102 if( historyInfos.size() )
103 adapter->SetPreselectNode( historyInfos[0]->GetLIB_ID(), 0 );
104
105 adapter->SetFilter( &m_filter );
106 adapter->AddLibraries( m_frame );
107
108 // -------------------------------------------------------------------------------------
109 // Construct the actual panel
110 //
111
112 wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
113
114 m_vsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
115 wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );
116
117 m_hsplitter = new wxSplitterWindow( m_vsplitter, wxID_ANY, wxDefaultPosition, wxDefaultSize,
118 wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );
119
120 //Avoid the splitter window being assigned as the Parent to additional windows
121 m_vsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
122 m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
123
124 m_detailsPanel = new wxPanel( m_vsplitter );
125 auto detailsSizer = new wxBoxSizer( wxVERTICAL );
126 m_detailsPanel->SetSizer( detailsSizer );
127
128 m_details = new HTML_WINDOW( m_detailsPanel, wxID_ANY, wxDefaultPosition, wxDefaultSize );
129 detailsSizer->Add( m_details, 1, wxEXPAND, 5 );
130 m_detailsPanel->Layout();
131 detailsSizer->Fit( m_detailsPanel );
132
133 m_vsplitter->SetSashGravity( 0.5 );
134 // Ensure splitted areas are always shown (i.e. 0 size not allowed) when m_detailsPanel is shown
135 m_vsplitter->SetMinimumPaneSize( 80 ); // arbitrary value but reasonable min size
136 m_vsplitter->SplitHorizontally( m_hsplitter, m_detailsPanel );
137
138 sizer->Add( m_vsplitter, 1, wxEXPAND, 5 );
139
140 m_tree = new LIB_TREE( m_hsplitter, wxT( "footprints" ), fpTable, m_adapter,
142
143 m_hsplitter->SetSashGravity( 0.8 );
144 m_hsplitter->SetMinimumPaneSize( 20 );
145
146 m_RightPanel = new wxPanel( m_hsplitter );
147 m_RightPanelSizer = new wxBoxSizer( wxVERTICAL );
148
151 m_RightPanelSizer->Add( m_preview_ctrl, 1, wxEXPAND, 5 );
152
153 m_RightPanel->SetSizer( m_RightPanelSizer );
154 m_RightPanel->Layout();
156
157 m_hsplitter->SplitVertically( m_tree, m_RightPanel );
158
159 m_dbl_click_timer = new wxTimer( this );
160 m_open_libs_timer = new wxTimer( this );
161
162 SetSizer( sizer );
163
164 m_adapter->FinishTreeInitialization();
165
166 Bind( wxEVT_TIMER, &PANEL_FOOTPRINT_CHOOSER::onCloseTimer, this, m_dbl_click_timer->GetId() );
167 Bind( wxEVT_TIMER, &PANEL_FOOTPRINT_CHOOSER::onOpenLibsTimer, this, m_open_libs_timer->GetId() );
168 Bind( EVT_LIBITEM_SELECTED, &PANEL_FOOTPRINT_CHOOSER::onFootprintSelected, this );
169 Bind( EVT_LIBITEM_CHOSEN, &PANEL_FOOTPRINT_CHOOSER::onFootprintChosen, this );
170 m_frame->Bind( wxEVT_MENU_OPEN, &PANEL_FOOTPRINT_CHOOSER::onMenuOpen, this );
171 m_frame->Bind( wxEVT_MENU_CLOSE, &PANEL_FOOTPRINT_CHOOSER::onMenuClose, this );
172
173 m_details->Connect( wxEVT_CHAR_HOOK,
175 nullptr, this );
176
177 Bind( wxEVT_CHAR_HOOK,
178 [&]( wxKeyEvent& aEvent )
179 {
180 if( aEvent.GetKeyCode() == WXK_ESCAPE )
181 {
182 wxObject* eventSource = aEvent.GetEventObject();
183
184 if( wxTextCtrl* textCtrl = dynamic_cast<wxTextCtrl*>( eventSource ) )
185 {
186 // First escape cancels search string value
187 if( textCtrl->GetValue() == m_tree->GetSearchString()
188 && !m_tree->GetSearchString().IsEmpty() )
189 {
190 m_tree->SetSearchString( wxEmptyString );
191 return;
192 }
193 }
194
196 }
197 else
198 {
199 // aEvent.Skip() should be sufficient to allow the normal key events to be
200 // generated (at least according to the wxWidgets documentation). And yet,
201 // here we are.
202 aEvent.DoAllowNextEvent();
203
204 aEvent.Skip();
205 }
206 } );
207
208 Layout();
209
210 // Open the user's previously opened libraries on timer expiration.
211 // This is done on a timer because we need a gross hack to keep GTK from garbling the
212 // display. Must be longer than the search debounce timer.
213 m_open_libs_timer->StartOnce( 300 );
214}
215
216
218{
219 m_frame->Unbind( wxEVT_MENU_OPEN, &PANEL_FOOTPRINT_CHOOSER::onMenuOpen, this );
220 m_frame->Unbind( wxEVT_MENU_CLOSE, &PANEL_FOOTPRINT_CHOOSER::onMenuClose, this );
221 Unbind( wxEVT_TIMER, &PANEL_FOOTPRINT_CHOOSER::onCloseTimer, this );
222 Unbind( EVT_LIBITEM_SELECTED, &PANEL_FOOTPRINT_CHOOSER::onFootprintSelected, this );
223 Unbind( EVT_LIBITEM_CHOSEN, &PANEL_FOOTPRINT_CHOOSER::onFootprintChosen, this );
224
225 m_details->Disconnect( wxEVT_CHAR_HOOK, wxKeyEventHandler( PANEL_FOOTPRINT_CHOOSER::OnDetailsCharHook ),
226 nullptr, this );
227
228 // I am not sure the following two lines are necessary, but they will not hurt anyone
229 m_dbl_click_timer->Stop();
230 m_open_libs_timer->Stop();
231 delete m_dbl_click_timer;
232 delete m_open_libs_timer;
233
234 if( PCBNEW_SETTINGS* cfg = GetAppSettings<PCBNEW_SETTINGS>( "pcbnew" ) )
235 {
236 // Save any changes to column widths, etc.
237 m_adapter->SaveSettings();
238
239 cfg->m_FootprintChooser.width = GetParent()->GetSize().x;
240 cfg->m_FootprintChooser.height = GetParent()->GetSize().y;
241 cfg->m_FootprintChooser.sash_h = m_hsplitter->GetSashPosition();
242
243 if( m_vsplitter )
244 cfg->m_FootprintChooser.sash_v = m_vsplitter->GetSashPosition();
245
246 cfg->m_FootprintChooser.sort_mode = m_tree->GetSortMode();
247 }
248}
249
250
251void PANEL_FOOTPRINT_CHOOSER::onMenuOpen( wxMenuEvent& aEvent )
252{
253 m_tree->BlockPreview( true );
254 aEvent.Skip();
255}
256
257
258void PANEL_FOOTPRINT_CHOOSER::onMenuClose( wxMenuEvent& aEvent )
259{
260 m_tree->BlockPreview( false );
261 aEvent.Skip();
262}
263
264
266{
267 if( PCBNEW_SETTINGS* settings = GetAppSettings<PCBNEW_SETTINGS>( "pcbnew" ) )
268 {
269 auto horizPixelsFromDU =
270 [&]( int x ) -> int
271 {
272 wxSize sz( x, 0 );
273 return GetParent()->ConvertDialogToPixels( sz ).x;
274 };
275
276 PCBNEW_SETTINGS::FOOTPRINT_CHOOSER& cfg = settings->m_FootprintChooser;
277
278 int w = cfg.width < 40 ? horizPixelsFromDU( 440 ) : cfg.width;
279 int h = cfg.height < 40 ? horizPixelsFromDU( 340 ) : cfg.height;
280
281 GetParent()->SetSize( wxSize( w, h ) );
282 GetParent()->Layout();
283
284 // We specify the width of the right window (m_symbol_view_panel), because specify
285 // the width of the left window does not work as expected when SetSashGravity() is called
286 if( cfg.sash_h < 0 )
287 cfg.sash_h = horizPixelsFromDU( 220 );
288
289 m_hsplitter->SetSashPosition( cfg.sash_h );
290
291 if( cfg.sash_v < 0 )
292 cfg.sash_v = horizPixelsFromDU( 230 );
293
294 if( m_vsplitter )
295 m_vsplitter->SetSashPosition( cfg.sash_v );
296
298 }
299}
300
301
303{
304 m_adapter->SetPreselectNode( aPreselect, 0 );
305}
306
307
309{
310 return m_tree->GetSelectedLibId();
311}
312
313
314void PANEL_FOOTPRINT_CHOOSER::onCloseTimer( wxTimerEvent& aEvent )
315{
316 // Hack because of eaten MouseUp event. See PANEL_FOOTPRINT_CHOOSER::onFootprintChosen
317 // for the beginning of this spaghetti noodle.
318
319 auto state = wxGetMouseState();
320
321 if( state.LeftIsDown() )
322 {
323 // Mouse hasn't been raised yet, so fire the timer again. Otherwise the
324 // purpose of this timer is defeated.
326 }
327 else
328 {
330 }
331}
332
335{
336 if( PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( Kiface().KifaceSettings() ) )
337 m_adapter->OpenLibs( cfg->m_LibTree.open_libs );
338}
339
340
342{
344 return;
345
346 LIB_ID lib_id = m_tree->GetSelectedLibId();
347
348 if( !lib_id.IsValid() )
349 {
350 m_preview_ctrl->SetStatusText( _( "No footprint selected" ) );
351 }
352 else
353 {
356 }
357
358 m_CurrFootprint = static_cast<FOOTPRINT_PREVIEW_PANEL*>(m_preview_ctrl->GetPreviewPanel())->GetCurrentFootprint();
359
360 // Send a FP_SELECTION_EVENT event after a footprint change
361 wxCommandEvent event( FP_SELECTION_EVENT, GetId() );
362 event.SetEventObject( this );
363
364 ProcessWindowEvent( event );
365}
366
367
368void PANEL_FOOTPRINT_CHOOSER::onFootprintChosen( wxCommandEvent& aEvent )
369{
371 {
372 // Got a selection. We can't just end the modal dialog here, because wx leaks some
373 // events back to the parent window (in particular, the MouseUp following a double click).
374 //
375 // NOW, here's where it gets really fun. wxTreeListCtrl eats MouseUp. This isn't really
376 // feasible to bypass without a fully custom wxDataViewCtrl implementation, and even then
377 // might not be fully possible (docs are vague). To get around this, we use a one-shot
378 // timer to schedule the dialog close.
379 //
380 // See PANEL_FOOTPRINT_CHOOSER::onCloseTimer for the other end of this spaghetti noodle.
382 }
383}
384
385
387{
388 if( m_details && e.GetKeyCode() == 'C' && e.ControlDown() &&
389 !e.AltDown() && !e.ShiftDown() && !e.MetaDown() )
390 {
391 wxString txt = m_details->SelectionToText();
392 wxLogNull doNotLog; // disable logging of failed clipboard actions
393
394 if( wxTheClipboard->Open() )
395 {
396 wxTheClipboard->SetData( new wxTextDataObject( txt ) );
397 wxTheClipboard->Flush(); // Allow data to be available after closing KiCad
398 wxTheClipboard->Close();
399 }
400 }
401 else
402 {
403 e.Skip();
404 }
405}
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
bool ReadFootprintFiles(FP_LIB_TABLE *aTable, const wxString *aNickname=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr) override
Read all the footprints provided by the combination of aTable and aNickname.
void DisplayErrors(wxTopLevelWindow *aCaller=nullptr)
unsigned GetErrorCount() const
FOOTPRINT_INFO * GetFootprintInfo(const wxString &aFootprintName)
Get info for a footprint by id.
Panel that renders a single footprint via Cairo GAL, meant to be exported through Kiface.
FOOTPRINT_PREVIEW_PANEL_BASE * GetPreviewPanel()
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.
void AddLibraries(EDA_BASE_FRAME *aParent)
static wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > Create(PCB_BASE_FRAME *aParent, LIB_TABLE *aLibs)
Factory function: create a model adapter in a reference-counting container.
Add dark theme support to wxHtmlWindow.
Definition: html_window.h:35
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
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:172
A mix-in to provide polymorphism between items stored in libraries (symbols, aliases and footprints).
Definition: lib_tree_item.h:41
void SetPreselectNode(const LIB_ID &aLibId, int aUnit)
Set the symbol name to be selected if there are no search results.
LIB_TREE_NODE_LIBRARY & 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 SetFilter(std::function< bool(LIB_TREE_NODE &aNode)> *aFilter)
Set the filter.
Model class in the component selector Model-View-Adapter (mediated MVC) architecture.
Widget displaying a tree of symbols with optional search text control and description panel.
Definition: lib_tree.h:49
LIB_TREE_MODEL_ADAPTER::SORT_MODE GetSortMode() const
Definition: lib_tree.h:155
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:298
@ ALL_WIDGETS
Definition: lib_tree.h:58
void BlockPreview(bool aBlock)
Definition: lib_tree.h:178
void onFootprintSelected(wxCommandEvent &aEvent)
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > m_adapter
void onCloseTimer(wxTimerEvent &aEvent)
std::function< void()> m_acceptHandler
FOOTPRINT_PREVIEW_WIDGET * m_preview_ctrl
std::function< void()> m_escapeHandler
void onMenuOpen(wxMenuEvent &aEvent)
Handle parent frame menu events to block tree preview.
static constexpr int DblClickDelay
std::function< bool(LIB_TREE_NODE &)> m_filter
void OnDetailsCharHook(wxKeyEvent &aEvt)
void onOpenLibsTimer(wxTimerEvent &aEvent)
void SetPreselect(const LIB_ID &aPreselect)
PANEL_FOOTPRINT_CHOOSER(PCB_BASE_FRAME *aFrame, wxTopLevelWindow *aParent, const wxArrayString &aFootprintHistoryList, std::function< bool(LIB_TREE_NODE &)> aFilter, std::function< void()> aAcceptHandler, std::function< void()> aEscapeHandler)
Create dialog to choose component.
void onMenuClose(wxMenuEvent &aEvent)
void onFootprintChosen(wxCommandEvent &aEvent)
Handle the selection of an item.
LIB_ID GetSelectedLibId() const
To be called after this dialog returns from ShowModal().
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
static FP_LIB_TABLE * PcbFootprintLibs(PROJECT *aProject)
Return the table of footprint libraries without Kiway.
Definition: project_pcb.cpp:37
EDA_UNITS GetUserUnits() const
Multi-thread safe progress reporter dialog, intended for use of tasks that parallel reporting back of...
#define _(s)
FOOTPRINT_LIST_IMPL GFootprintList
The global footprint info table.
Definition: cvpcb.cpp:156
STL namespace.
wxDEFINE_EVENT(FP_SELECTION_EVENT, wxCommandEvent)
see class PGM_BASE
#define PR_CAN_ABORT