KiCad PCB EDA Suite
FOOTPRINT_SELECT_WIDGET Class Reference

#include <footprint_select_widget.h>

Inheritance diagram for FOOTPRINT_SELECT_WIDGET:

Public Member Functions

 FOOTPRINT_SELECT_WIDGET (wxWindow *aParent, FOOTPRINT_LIST *aFpList, bool aUpdate=true, int aMaxItems=400)
 Construct a footprint selector widget. More...
 
virtual ~FOOTPRINT_SELECT_WIDGET ()
 
void Load (KIWAY &aKiway, PROJECT &aProject)
 Start loading. More...
 
void ClearFilters ()
 Clear all filters. More...
 
void FilterByPinCount (int aPinCount)
 Filter by pin count. More...
 
void FilterByFootprintFilters (wxArrayString const &aFilters, bool aZeroFilters)
 Filter by footprint filter list. More...
 
void SetDefaultFootprint (wxString const &aFp)
 Set the default footprint for a part. More...
 
bool UpdateList ()
 Update the contents of the list to match the filters. More...
 
void SelectDefault ()
 Set current selection to the default footprint. More...
 
virtual bool Enable (bool aEnable=true) override
 Enable or disable the control for input. More...
 

Private Member Functions

void FootprintsLoaded ()
 
void OnComboBox (wxCommandEvent &aEvent)
 
void OnComboInteractive (wxCommandEvent &aEvent)
 
wxString ShowPicker ()
 Show the component picker and return the selected component. Used by DoOther() More...
 
void DoOther ()
 Handle activation of the "Other..." item. More...
 

Private Attributes

KIWAYm_kiway
 
GAUGE_PROGRESS_REPORTERm_progress_ctrl
 
FOOTPRINT_CHOICEm_fp_sel_ctrl
 
wxSizer * m_sizer
 
wxSimplebook * m_book
 
bool m_update
 
bool m_finished_loading
 
int m_max_items
 
wxString m_default_footprint
 
wxString m_other_footprint
 
int m_last_item
 
FOOTPRINT_LISTm_fp_list
 
FOOTPRINT_FILTER m_fp_filter
 
bool m_zero_filter
 

Detailed Description

Definition at line 45 of file footprint_select_widget.h.

Constructor & Destructor Documentation

FOOTPRINT_SELECT_WIDGET::FOOTPRINT_SELECT_WIDGET ( wxWindow *  aParent,
FOOTPRINT_LIST aFpList,
bool  aUpdate = true,
int  aMaxItems = 400 
)

Construct a footprint selector widget.

This requires references to an external footprint loader, and an external unique_ptr-to-FOOTPRINT_LIST. The latter will be populated with a FOOTPRINT_LIST instance the first time Load() is called.

The reason for this is that footprint loading tends to be very expensive, especially when using online libraries. The caller is expected to keep these objects around (e.g. they may be statics on the dialog this FOOTPRINT_SELECT_WIDGET is created in) so footprints do not have to be loaded more than once.

Parameters
aParent- parent window
aFpList- FOOTPRINT_LIST container
aUpdate- whether to call UpdateList() automatically when finished loading
aMaxItems- maximum number of filter items to display, in addition to Default and Other

Definition at line 63 of file footprint_select_widget.cpp.

References m_book, m_fp_sel_ctrl, m_progress_ctrl, m_sizer, m_zero_filter, OnComboBox(), and OnComboInteractive().

66  : wxPanel( aParent ),
67  m_kiway( nullptr ),
68  m_update( aUpdate ),
69  m_finished_loading( false ),
70  m_max_items( aMaxItems ),
71  m_last_item( 0 ),
72  m_fp_list( aFpList )
73 {
74  m_zero_filter = true;
75  m_sizer = new wxBoxSizer( wxVERTICAL );
76  m_book = new wxSimplebook( this, wxID_ANY );
78  m_fp_sel_ctrl = new FOOTPRINT_CHOICE( m_book, wxID_ANY );
79 
80  m_book->SetEffect( wxSHOW_EFFECT_BLEND );
81  m_book->AddPage( m_progress_ctrl, "", true );
82  m_book->AddPage( m_fp_sel_ctrl, "", false );
83  m_sizer->Add( m_book, 1, wxEXPAND | wxALL, 5 );
84 
85  SetSizer( m_sizer );
86  Layout();
87  m_sizer->Fit( this );
88 
89  m_fp_sel_ctrl->Bind( wxEVT_COMBOBOX, &FOOTPRINT_SELECT_WIDGET::OnComboBox, this );
90  m_fp_sel_ctrl->Bind(
91  EVT_INTERACTIVE_CHOICE, &FOOTPRINT_SELECT_WIDGET::OnComboInteractive, this );
92 }
void OnComboInteractive(wxCommandEvent &aEvent)
Customized combo box for footprint selection.
GAUGE_PROGRESS_REPORTER * m_progress_ctrl
void OnComboBox(wxCommandEvent &aEvent)
virtual FOOTPRINT_SELECT_WIDGET::~FOOTPRINT_SELECT_WIDGET ( )
inlinevirtual

Member Function Documentation

void FOOTPRINT_SELECT_WIDGET::ClearFilters ( )

Clear all filters.

Does not update the list.

Definition at line 209 of file footprint_select_widget.cpp.

References FOOTPRINT_FILTER::ClearFilters(), m_default_footprint, m_fp_filter, m_other_footprint, and m_zero_filter.

Referenced by DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), and ~FOOTPRINT_SELECT_WIDGET().

210 {
212  m_default_footprint.Clear();
213  m_other_footprint.Clear();
214  m_zero_filter = false;
215 }
void ClearFilters()
Clear all filter criteria.
void FOOTPRINT_SELECT_WIDGET::DoOther ( )
private

Handle activation of the "Other..." item.

Definition at line 171 of file footprint_select_widget.cpp.

References m_fp_sel_ctrl, m_last_item, m_other_footprint, POS_OTHER, ShowPicker(), and UpdateList().

Referenced by OnComboInteractive().

172 {
173  wxCommandEvent evt( EVT_FOOTPRINT_SELECTED );
174 
175  wxString fpname = ShowPicker();
176  m_other_footprint = fpname;
177  UpdateList();
178  m_fp_sel_ctrl->SetSelection( POS_OTHER );
180 
181  evt.SetString( m_other_footprint );
182  wxPostEvent( this, evt );
183 }
wxString ShowPicker()
Show the component picker and return the selected component. Used by DoOther()
bool UpdateList()
Update the contents of the list to match the filters.
bool FOOTPRINT_SELECT_WIDGET::Enable ( bool  aEnable = true)
overridevirtual

Enable or disable the control for input.

Definition at line 292 of file footprint_select_widget.cpp.

References m_fp_sel_ctrl.

Referenced by DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), and ~FOOTPRINT_SELECT_WIDGET().

293 {
294  return m_fp_sel_ctrl->Enable( aEnable );
295 }
void FOOTPRINT_SELECT_WIDGET::FilterByFootprintFilters ( wxArrayString const &  aFilters,
bool  aZeroFilters 
)

Filter by footprint filter list.

Does not update the list.

Parameters
aFiltersis a wxArrayString of strings used to filter the list of available footprints (can be empty). The final fp list is the list of footprint names matching at least one filtering string. A filtering string is something like sm0402 or DIP*
aZeroFilters- if true, zero filters = zero footprints. If false, zero filters = not filtering.

Definition at line 224 of file footprint_select_widget.cpp.

References FOOTPRINT_FILTER::FilterByFootprintFilters(), m_fp_filter, and m_zero_filter.

Referenced by DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), and ~FOOTPRINT_SELECT_WIDGET().

226 {
227  if( aZeroFilters && aFilters.size() == 0 )
228  m_zero_filter = true;
229  else
230  m_zero_filter = false;
231 
233 }
void FilterByFootprintFilters(wxArrayString const &aFilters)
Set a list of footprint filters to filter by.
void FOOTPRINT_SELECT_WIDGET::FilterByPinCount ( int  aPinCount)

Filter by pin count.

Does not update the list.

Definition at line 218 of file footprint_select_widget.cpp.

References FOOTPRINT_FILTER::FilterByPinCount(), and m_fp_filter.

Referenced by DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), and ~FOOTPRINT_SELECT_WIDGET().

219 {
220  m_fp_filter.FilterByPinCount( aPinCount );
221 }
void FilterByPinCount(int aPinCount)
Set a pin count to filter by.
void FOOTPRINT_SELECT_WIDGET::FootprintsLoaded ( )
private

Definition at line 114 of file footprint_select_widget.cpp.

References m_book, m_finished_loading, m_fp_filter, m_fp_list, m_update, PAGE_SELECT, FOOTPRINT_FILTER::SetList(), and UpdateList().

Referenced by Load().

115 {
117 
118  m_book->SetSelection( PAGE_SELECT );
119  m_finished_loading = true;
120 
121  if( m_update )
122  UpdateList();
123 }
void SetList(FOOTPRINT_LIST &aList)
Set the list to filter.
bool UpdateList()
Update the contents of the list to match the filters.
void FOOTPRINT_SELECT_WIDGET::Load ( KIWAY aKiway,
PROJECT aProject 
)

Start loading.

This function returns immediately; footprints will continue to load in the background.

Parameters
aKiway- active kiway instance. This is cached for use when "Other" is selected.
aProject- current project

Definition at line 95 of file footprint_select_widget.cpp.

References FootprintsLoaded(), FOOTPRINT_LIST::GetInstance(), m_fp_list, m_kiway, m_progress_ctrl, PROJECT::PcbFootprintLibs(), and FOOTPRINT_LIST::ReadFootprintFiles().

Referenced by DIALOG_CHOOSE_COMPONENT::OnIdle(), and ~FOOTPRINT_SELECT_WIDGET().

96 {
97  m_kiway = &aKiway;
98 
99  try
100  {
101  auto fp_lib_table = aProject.PcbFootprintLibs( aKiway );
103 
104  m_fp_list->ReadFootprintFiles( fp_lib_table, nullptr, m_progress_ctrl );
106  }
107  catch( ... )
108  {
109  // no footprint libraries available
110  }
111 }
GAUGE_PROGRESS_REPORTER * m_progress_ctrl
static FOOTPRINT_LIST * GetInstance(KIWAY &aKiway)
Factory function to return a FOOTPRINT_LIST via Kiway.
virtual bool ReadFootprintFiles(FP_LIB_TABLE *aTable, const wxString *aNickname=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr)=0
Read all the footprints provided by the combination of aTable and aNickname.
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
void FOOTPRINT_SELECT_WIDGET::OnComboBox ( wxCommandEvent &  aEvent)
private

Definition at line 126 of file footprint_select_widget.cpp.

References m_fp_sel_ctrl, m_last_item, POS_OTHER, and POS_SEPARATOR.

Referenced by FOOTPRINT_SELECT_WIDGET().

127 {
128  wxCommandEvent evt( EVT_FOOTPRINT_SELECTED );
129  int sel = m_fp_sel_ctrl->GetSelection();
130 
131  switch( sel )
132  {
133  case wxNOT_FOUND: return;
134 
135  case POS_SEPARATOR:
136  // User somehow managed to select the separator. This should not be
137  // possible, but just in case... deselect it
138  m_fp_sel_ctrl->SetSelection( m_last_item );
139  break;
140 
141  case POS_OTHER:
142  // When POS_OTHER is selected, a dialog should be shown. However, we don't want to
143  // do this ALL the time, as some times (e.g. when moving around with the arrow keys)
144  // it could be very annoying. Therefore showing the picker is done from the custom
145  // "interactive select" event on FOOTPRINT_CHOICE, which only fires for more direct
146  // choice actions.
147  break;
148 
149  default:
150  {
151  wxStringClientData* clientdata =
152  static_cast<wxStringClientData*>( m_fp_sel_ctrl->GetClientObject( sel ) );
153  wxASSERT( clientdata );
154 
155  evt.SetString( clientdata->GetData() );
156  wxPostEvent( this, evt );
157  }
158  }
159 }
void FOOTPRINT_SELECT_WIDGET::OnComboInteractive ( wxCommandEvent &  aEvent)
private

Definition at line 162 of file footprint_select_widget.cpp.

References DoOther(), m_fp_sel_ctrl, and POS_OTHER.

Referenced by FOOTPRINT_SELECT_WIDGET().

163 {
164  if( aEvent.GetInt() == POS_OTHER && !m_fp_sel_ctrl->IsPopupShown() )
165  {
166  DoOther();
167  }
168 }
void DoOther()
Handle activation of the "Other..." item.
void FOOTPRINT_SELECT_WIDGET::SelectDefault ( )

Set current selection to the default footprint.

Definition at line 286 of file footprint_select_widget.cpp.

References m_fp_sel_ctrl, and POS_DEFAULT.

Referenced by UpdateList(), and ~FOOTPRINT_SELECT_WIDGET().

287 {
288  m_fp_sel_ctrl->SetSelection( POS_DEFAULT );
289 }
void FOOTPRINT_SELECT_WIDGET::SetDefaultFootprint ( wxString const &  aFp)

Set the default footprint for a part.

This will be listed at the top. May be an empty string.

Definition at line 236 of file footprint_select_widget.cpp.

References m_default_footprint.

Referenced by DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), and ~FOOTPRINT_SELECT_WIDGET().

237 {
238  m_default_footprint = aFp;
239 }
wxString FOOTPRINT_SELECT_WIDGET::ShowPicker ( )
private

Show the component picker and return the selected component. Used by DoOther()

Definition at line 186 of file footprint_select_widget.cpp.

References KIWAY_PLAYER::Destroy(), FRAME_PCB_MODULE_VIEWER_MODAL, DIALOG_SHIM::IsQuasiModal(), m_kiway, and KIWAY::Player().

Referenced by DoOther().

187 {
188  wxString fpname;
189  wxWindow* parent = ::wxGetTopLevelParent( this );
190  DIALOG_SHIM* dsparent = dynamic_cast<DIALOG_SHIM*>( parent );
191 
192  // Only quasimodal dialogs can launch modal kiface dialogs. Otherwise the
193  // event loop goes all silly.
194  wxASSERT( !dsparent || dsparent->IsQuasiModal() );
195 
196  auto frame = m_kiway->Player( FRAME_PCB_MODULE_VIEWER_MODAL, true );
197 
198  if( !frame->ShowModal( &fpname, parent ) )
199  {
200  fpname = wxEmptyString;
201  }
202 
203  frame->Destroy();
204 
205  return fpname;
206 }
Class DIALOG_SHIM may sit in the inheritance tree between wxDialog and any class written by wxFormBui...
Definition: dialog_shim.h:70
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:300
bool IsQuasiModal()
Definition: dialog_shim.h:103
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
bool FOOTPRINT_SELECT_WIDGET::UpdateList ( )

Update the contents of the list to match the filters.

Has no effect if the footprint list has not been loaded yet. The "default" footprint will be selected.

Returns
true if the footprint list has been loaded (and the list was updated)

Definition at line 242 of file footprint_select_widget.cpp.

References m_default_footprint, m_finished_loading, m_fp_filter, m_fp_list, m_fp_sel_ctrl, m_max_items, m_other_footprint, m_zero_filter, and SelectDefault().

Referenced by DoOther(), FootprintsLoaded(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), and ~FOOTPRINT_SELECT_WIDGET().

243 {
244  int n_items = 0;
245 
246  if( !m_fp_list || !m_finished_loading )
247  return false;
248 
249  wxWindowUpdateLocker lock( m_fp_sel_ctrl );
250  m_fp_sel_ctrl->Clear();
251 
252  // Be careful adding items! "Default" must occupy POS_DEFAULT,
253  // "Other" must occupy POS_OTHER, and the separator must occupy POS_SEPARATOR.
254 
255  m_fp_sel_ctrl->Append( m_default_footprint.IsEmpty() ?
256  _( "No default footprint" ) :
257  "[" + _( "Default" ) + "] " + m_default_footprint,
258  new wxStringClientData( m_default_footprint ) );
259 
260  m_fp_sel_ctrl->Append( m_other_footprint.IsEmpty() ?
261  _( "Other..." ) :
262  "[" + _( "Other..." ) + "] " + m_other_footprint,
263  new wxStringClientData( m_other_footprint ) );
264 
265  m_fp_sel_ctrl->Append( "", new wxStringClientData( "" ) );
266 
267  if( !m_zero_filter )
268  {
269  for( auto& fpinfo : m_fp_filter )
270  {
271  wxString display_name( fpinfo.GetNickname() + ":" + fpinfo.GetFootprintName() );
272 
273  m_fp_sel_ctrl->Append( display_name, new wxStringClientData( display_name ) );
274  ++n_items;
275 
276  if( n_items >= m_max_items )
277  break;
278  }
279  }
280 
281  SelectDefault();
282  return true;
283 }
void SelectDefault()
Set current selection to the default footprint.

Member Data Documentation

wxSimplebook* FOOTPRINT_SELECT_WIDGET::m_book
private

Definition at line 136 of file footprint_select_widget.h.

Referenced by FOOTPRINT_SELECT_WIDGET(), and FootprintsLoaded().

wxString FOOTPRINT_SELECT_WIDGET::m_default_footprint
private

Definition at line 141 of file footprint_select_widget.h.

Referenced by ClearFilters(), SetDefaultFootprint(), and UpdateList().

bool FOOTPRINT_SELECT_WIDGET::m_finished_loading
private

Definition at line 139 of file footprint_select_widget.h.

Referenced by FootprintsLoaded(), and UpdateList().

FOOTPRINT_FILTER FOOTPRINT_SELECT_WIDGET::m_fp_filter
private
FOOTPRINT_LIST* FOOTPRINT_SELECT_WIDGET::m_fp_list
private

Definition at line 145 of file footprint_select_widget.h.

Referenced by FootprintsLoaded(), Load(), and UpdateList().

FOOTPRINT_CHOICE* FOOTPRINT_SELECT_WIDGET::m_fp_sel_ctrl
private
KIWAY* FOOTPRINT_SELECT_WIDGET::m_kiway
private

Definition at line 132 of file footprint_select_widget.h.

Referenced by Load(), and ShowPicker().

int FOOTPRINT_SELECT_WIDGET::m_last_item
private

Definition at line 143 of file footprint_select_widget.h.

Referenced by DoOther(), and OnComboBox().

int FOOTPRINT_SELECT_WIDGET::m_max_items
private

Definition at line 140 of file footprint_select_widget.h.

Referenced by UpdateList().

wxString FOOTPRINT_SELECT_WIDGET::m_other_footprint
private

Definition at line 142 of file footprint_select_widget.h.

Referenced by ClearFilters(), DoOther(), and UpdateList().

GAUGE_PROGRESS_REPORTER* FOOTPRINT_SELECT_WIDGET::m_progress_ctrl
private

Definition at line 133 of file footprint_select_widget.h.

Referenced by FOOTPRINT_SELECT_WIDGET(), and Load().

wxSizer* FOOTPRINT_SELECT_WIDGET::m_sizer
private

Definition at line 135 of file footprint_select_widget.h.

Referenced by FOOTPRINT_SELECT_WIDGET().

bool FOOTPRINT_SELECT_WIDGET::m_update
private

Definition at line 138 of file footprint_select_widget.h.

Referenced by FootprintsLoaded().

bool FOOTPRINT_SELECT_WIDGET::m_zero_filter
private

The documentation for this class was generated from the following files: