KiCad PCB EDA Suite
footprint_select_widget.h
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) 2017 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by the
8  * Free Software Foundation, either version 3 of the License, or (at your
9  * option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with this program. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef FOOTPRINT_SELECT_WIDGET_H
21 #define FOOTPRINT_SELECT_WIDGET_H
22 
23 #include <footprint_filter.h>
24 #include <footprint_info.h>
25 #include <vector>
26 #include <wx/panel.h>
27 #include <wx/wx.h>
28 
29 class KIWAY;
30 class PROJECT;
31 class FOOTPRINT_CHOICE;
32 class wxWindow;
33 
38 wxDECLARE_EVENT( EVT_FOOTPRINT_SELECTED, wxCommandEvent );
39 
40 class FOOTPRINT_SELECT_WIDGET : public wxPanel
41 {
42 public:
62  FOOTPRINT_SELECT_WIDGET( wxWindow* aParent, FOOTPRINT_LIST* aFpList,
63  bool aUpdate = true, int aMaxItems = 400 );
64 
66  {
67  }
68 
77  void Load( KIWAY& aKiway, PROJECT& aProject );
78 
82  void ClearFilters();
83 
87  void FilterByPinCount( int aPinCount );
88 
99  void FilterByFootprintFilters( wxArrayString const& aFilters, bool aZeroFilters );
100 
105  void SetDefaultFootprint( wxString const& aFp );
106 
114  bool UpdateList();
115 
119  void SelectDefault();
120 
124  virtual bool Enable( bool aEnable = true ) override;
125 
126 private:
129  wxSizer* m_sizer;
130 
131  bool m_update;
137 
141 
142  void FootprintsLoaded();
143  void OnComboBox( wxCommandEvent& aEvent );
144  void OnComboInteractive( wxCommandEvent& aEvent );
145 
147  wxString ShowPicker();
148 
150  void DoOther();
151 };
152 
153 
154 #endif // FOOTPRINT_SELECT_WIDGET
wxDECLARE_EVENT(EVT_FOOTPRINT_SELECTED, wxCommandEvent)
This event is fired when a footprint is selected.
Class PROJECT holds project specific data.
Definition: project.h:56
void FilterByFootprintFilters(wxArrayString const &aFilters, bool aZeroFilters)
Filter by footprint filter list.
void OnComboInteractive(wxCommandEvent &aEvent)
void DoOther()
Handle activation of the "Other..." item.
FOOTPRINT_SELECT_WIDGET(wxWindow *aParent, FOOTPRINT_LIST *aFpList, bool aUpdate=true, int aMaxItems=400)
Construct a footprint selector widget.
void SetDefaultFootprint(wxString const &aFp)
Set the default footprint for a part.
Customized combo box for footprint selection.
wxString ShowPicker()
Show the component picker and return the selected component. Used by DoOther()
void ClearFilters()
Clear all filters.
bool UpdateList()
Update the contents of the list to match the filters.
void OnComboBox(wxCommandEvent &aEvent)
Class KIWAY is a minimalistic software bus for communications between various DLLs/DSOs (DSOs) within...
Definition: kiway.h:258
virtual bool Enable(bool aEnable=true) override
Enable or disable the control for input.
Footprint display filter.
void SelectDefault()
Set current selection to the default footprint.
Holds a list of FOOTPRINT_INFO objects, along with a list of IO_ERRORs or PARSE_ERRORs that were thro...
void Load(KIWAY &aKiway, PROJECT &aProject)
Start loading.
void FilterByPinCount(int aPinCount)
Filter by pin count.