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_ASYNC_LOADER &aLoader, std::unique_ptr< 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 OnProgressTimer (wxTimerEvent &aEvent)
 
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
 
wxGauge * m_progress_ctrl
 
FOOTPRINT_CHOICEm_fp_sel_ctrl
 
wxSizer * m_sizer
 
wxSimplebook * m_book
 
std::unique_ptr< wxTimer > m_progress_timer
 
bool m_update
 
bool m_finished_loading
 
int m_max_items
 
wxString m_default_footprint
 
wxString m_other_footprint
 
int m_last_item
 
FOOTPRINT_ASYNC_LOADERm_fp_loader
 
std::unique_ptr< FOOTPRINT_LIST > & m_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_ASYNC_LOADER aLoader,
std::unique_ptr< 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
aLoader- FOOTPRINT_ASYNC_LOADER instance
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_progress_timer, m_sizer, m_zero_filter, OnComboBox(), OnComboInteractive(), and OnProgressTimer().

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_loader( aLoader ),
73  m_fp_list( aFpList )
74 {
75  m_zero_filter = true;
76  m_sizer = new wxBoxSizer( wxVERTICAL );
77  m_progress_timer = std::make_unique<wxTimer>( this );
78  m_book = new wxSimplebook( this, wxID_ANY );
79  m_progress_ctrl = new wxGauge( m_book, wxID_ANY, 100 );
80  m_fp_sel_ctrl = new FOOTPRINT_CHOICE( m_book, wxID_ANY );
81 
82  m_book->SetEffect( wxSHOW_EFFECT_BLEND );
83  m_book->AddPage( m_progress_ctrl, "", true );
84  m_book->AddPage( m_fp_sel_ctrl, "", false );
85  m_sizer->Add( m_book, 1, wxEXPAND | wxALL, 5 );
86 
87  SetSizer( m_sizer );
88  Layout();
89  m_sizer->Fit( this );
90 
91  Bind( wxEVT_TIMER, &FOOTPRINT_SELECT_WIDGET::OnProgressTimer, this, m_progress_timer->GetId() );
92  m_fp_sel_ctrl->Bind( wxEVT_COMBOBOX, &FOOTPRINT_SELECT_WIDGET::OnComboBox, this );
93  m_fp_sel_ctrl->Bind(
94  EVT_INTERACTIVE_CHOICE, &FOOTPRINT_SELECT_WIDGET::OnComboInteractive, this );
95 }
void OnComboInteractive(wxCommandEvent &aEvent)
FOOTPRINT_ASYNC_LOADER & m_fp_loader
std::unique_ptr< FOOTPRINT_LIST > & m_fp_list
Customized combo box for footprint selection.
void OnComboBox(wxCommandEvent &aEvent)
void OnProgressTimer(wxTimerEvent &aEvent)
std::unique_ptr< wxTimer > m_progress_timer
virtual FOOTPRINT_SELECT_WIDGET::~FOOTPRINT_SELECT_WIDGET ( )
inlinevirtual

Definition at line 71 of file footprint_select_widget.h.

72  {
73  }

Member Function Documentation

void FOOTPRINT_SELECT_WIDGET::ClearFilters ( )

Clear all filters.

Does not update the list.

Definition at line 227 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().

228 {
230  m_default_footprint.Clear();
231  m_other_footprint.Clear();
232  m_zero_filter = false;
233 }
void ClearFilters()
Clear all filter criteria.
void FOOTPRINT_SELECT_WIDGET::DoOther ( )
private

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

Definition at line 189 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().

190 {
191  wxCommandEvent evt( EVT_FOOTPRINT_SELECTED );
192 
193  wxString fpname = ShowPicker();
194  m_other_footprint = fpname;
195  UpdateList();
196  m_fp_sel_ctrl->SetSelection( POS_OTHER );
198 
199  evt.SetString( m_other_footprint );
200  wxPostEvent( this, evt );
201 }
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 310 of file footprint_select_widget.cpp.

References m_fp_sel_ctrl.

Referenced by DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector().

311 {
312  return m_fp_sel_ctrl->Enable( aEnable );
313 }
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 242 of file footprint_select_widget.cpp.

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

Referenced by DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector().

244 {
245  if( aZeroFilters && aFilters.size() == 0 )
246  m_zero_filter = true;
247  else
248  m_zero_filter = false;
249 
251 }
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 236 of file footprint_select_widget.cpp.

References FOOTPRINT_FILTER::FilterByPinCount(), and m_fp_filter.

Referenced by DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector().

237 {
238  m_fp_filter.FilterByPinCount( aPinCount );
239 }
void FilterByPinCount(int aPinCount)
Set a pin count to filter by.
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 98 of file footprint_select_widget.cpp.

References FOOTPRINT_LIST::GetInstance(), FOOTPRINT_ASYNC_LOADER::GetProgress(), FOOTPRINT_ASYNC_LOADER::IsSameTable(), m_fp_list, m_fp_loader, m_kiway, m_progress_timer, PROJECT::PcbFootprintLibs(), FOOTPRINT_ASYNC_LOADER::SetList(), and FOOTPRINT_ASYNC_LOADER::Start().

Referenced by DIALOG_CHOOSE_COMPONENT::OnInitDialog().

99 {
100  m_kiway = &aKiway;
101 
102  try
103  {
104  auto fp_lib_table = aProject.PcbFootprintLibs( aKiway );
105 
106  if( m_fp_loader.GetProgress() == 0 || !m_fp_loader.IsSameTable( fp_lib_table ) )
107  {
110  m_fp_loader.Start( fp_lib_table );
111  }
112 
113  m_progress_timer->Start( 200 );
114  }
115  catch( ... )
116  {
117  // no footprint libraries available
118  }
119 }
FOOTPRINT_ASYNC_LOADER & m_fp_loader
std::unique_ptr< FOOTPRINT_LIST > & m_fp_list
static std::unique_ptr< FOOTPRINT_LIST > GetInstance(KIWAY &aKiway)
Factory function to return a new FOOTPRINT_LIST via Kiway.
void Start(FP_LIB_TABLE *aTable, wxString const *aNickname=nullptr, unsigned aNThreads=DEFAULT_THREADS)
Launch the worker threads.
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
int GetProgress() const
Get the current completion percentage.
void SetList(FOOTPRINT_LIST *aList)
Assign a FOOTPRINT_LIST to the loader.
std::unique_ptr< wxTimer > m_progress_timer
bool IsSameTable(FP_LIB_TABLE *aOther)
Return true if the given table is the same as the last table loaded.
void FOOTPRINT_SELECT_WIDGET::OnComboBox ( wxCommandEvent &  aEvent)
private

Definition at line 144 of file footprint_select_widget.cpp.

References m_fp_sel_ctrl, m_last_item, POS_OTHER, and POS_SEPARATOR.

Referenced by FOOTPRINT_SELECT_WIDGET().

145 {
146  wxCommandEvent evt( EVT_FOOTPRINT_SELECTED );
147  int sel = m_fp_sel_ctrl->GetSelection();
148 
149  switch( sel )
150  {
151  case wxNOT_FOUND: return;
152 
153  case POS_SEPARATOR:
154  // User somehow managed to select the separator. This should not be
155  // possible, but just in case... deselect it
156  m_fp_sel_ctrl->SetSelection( m_last_item );
157  break;
158 
159  case POS_OTHER:
160  // When POS_OTHER is selected, a dialog should be shown. However, we don't want to
161  // do this ALL the time, as some times (e.g. when moving around with the arrow keys)
162  // it could be very annoying. Therefore showing the picker is done from the custom
163  // "interactive select" event on FOOTPRINT_CHOICE, which only fires for more direct
164  // choice actions.
165  break;
166 
167  default:
168  {
169  wxStringClientData* clientdata =
170  static_cast<wxStringClientData*>( m_fp_sel_ctrl->GetClientObject( sel ) );
171  wxASSERT( clientdata );
172 
173  evt.SetString( clientdata->GetData() );
174  wxPostEvent( this, evt );
175  }
176  }
177 }
void FOOTPRINT_SELECT_WIDGET::OnComboInteractive ( wxCommandEvent &  aEvent)
private

Definition at line 180 of file footprint_select_widget.cpp.

References DoOther(), m_fp_sel_ctrl, and POS_OTHER.

Referenced by FOOTPRINT_SELECT_WIDGET().

181 {
182  if( aEvent.GetInt() == POS_OTHER && !m_fp_sel_ctrl->IsPopupShown() )
183  {
184  DoOther();
185  }
186 }
void DoOther()
Handle activation of the "Other..." item.
void FOOTPRINT_SELECT_WIDGET::OnProgressTimer ( wxTimerEvent &  aEvent)
private

Definition at line 122 of file footprint_select_widget.cpp.

References FOOTPRINT_ASYNC_LOADER::GetProgress(), FOOTPRINT_ASYNC_LOADER::Join(), m_book, m_finished_loading, m_fp_filter, m_fp_list, m_fp_loader, m_progress_ctrl, m_progress_timer, m_update, PAGE_SELECT, FOOTPRINT_FILTER::SetList(), and UpdateList().

Referenced by FOOTPRINT_SELECT_WIDGET().

123 {
124  int prog = m_fp_loader.GetProgress();
125  m_progress_ctrl->SetValue( prog );
126 
127  if( prog == 100 )
128  {
129  wxBusyCursor busy;
130 
131  m_fp_loader.Join();
133  m_progress_timer->Stop();
134 
135  m_book->SetSelection( PAGE_SELECT );
136  m_finished_loading = true;
137 
138  if( m_update )
139  UpdateList();
140  }
141 }
void SetList(FOOTPRINT_LIST &aList)
Set the list to filter.
FOOTPRINT_ASYNC_LOADER & m_fp_loader
std::unique_ptr< FOOTPRINT_LIST > & m_fp_list
bool UpdateList()
Update the contents of the list to match the filters.
bool Join()
Wait until the worker threads are finished, and then perform any required single-threaded finishing o...
int GetProgress() const
Get the current completion percentage.
std::unique_ptr< wxTimer > m_progress_timer
void FOOTPRINT_SELECT_WIDGET::SelectDefault ( )

Set current selection to the default footprint.

Definition at line 304 of file footprint_select_widget.cpp.

References m_fp_sel_ctrl, and POS_DEFAULT.

Referenced by UpdateList().

305 {
306  m_fp_sel_ctrl->SetSelection( POS_DEFAULT );
307 }
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 254 of file footprint_select_widget.cpp.

References m_default_footprint.

Referenced by DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector().

255 {
256  m_default_footprint = aFp;
257 }
wxString FOOTPRINT_SELECT_WIDGET::ShowPicker ( )
private

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

Definition at line 204 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().

205 {
206  wxString fpname;
207  wxWindow* parent = ::wxGetTopLevelParent( this );
208  DIALOG_SHIM* dsparent = dynamic_cast<DIALOG_SHIM*>( parent );
209 
210  // Only quasimodal dialogs can launch modal kiface dialogs. Otherwise the
211  // event loop goes all silly.
212  wxASSERT( !dsparent || dsparent->IsQuasiModal() );
213 
214  auto frame = m_kiway->Player( FRAME_PCB_MODULE_VIEWER_MODAL, true );
215 
216  if( !frame->ShowModal( &fpname, parent ) )
217  {
218  fpname = wxEmptyString;
219  }
220 
221  frame->Destroy();
222 
223  return fpname;
224 }
Class DIALOG_SHIM may sit in the inheritance tree between wxDialog and any class written by wxFormBui...
Definition: dialog_shim.h:60
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, KIWAY_PLAYER *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:302
bool IsQuasiModal()
Definition: dialog_shim.h:93
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 260 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(), OnProgressTimer(), and DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector().

261 {
262  int n_items = 0;
263 
264  if( !m_fp_list || !m_finished_loading )
265  return false;
266 
267  wxWindowUpdateLocker lock( m_fp_sel_ctrl );
268  m_fp_sel_ctrl->Clear();
269 
270  // Be careful adding items! "Default" must occupy POS_DEFAULT,
271  // "Other" must occupy POS_OTHER, and the separator must occupy POS_SEPARATOR.
272 
273  m_fp_sel_ctrl->Append( m_default_footprint.IsEmpty() ?
274  _( "No default footprint" ) :
275  "[" + _( "Default" ) + "] " + m_default_footprint,
276  new wxStringClientData( m_default_footprint ) );
277 
278  m_fp_sel_ctrl->Append( m_other_footprint.IsEmpty() ?
279  _( "Other..." ) :
280  "[" + _( "Other..." ) + "] " + m_other_footprint,
281  new wxStringClientData( m_other_footprint ) );
282 
283  m_fp_sel_ctrl->Append( "", new wxStringClientData( "" ) );
284 
285  if( !m_zero_filter )
286  {
287  for( auto& fpinfo : m_fp_filter )
288  {
289  wxString display_name( fpinfo.GetNickname() + ":" + fpinfo.GetFootprintName() );
290 
291  m_fp_sel_ctrl->Append( display_name, new wxStringClientData( display_name ) );
292  ++n_items;
293 
294  if( n_items >= m_max_items )
295  break;
296  }
297  }
298 
299  SelectDefault();
300  return true;
301 }
std::unique_ptr< FOOTPRINT_LIST > & m_fp_list
void SelectDefault()
Set current selection to the default footprint.

Member Data Documentation

wxSimplebook* FOOTPRINT_SELECT_WIDGET::m_book
private

Definition at line 137 of file footprint_select_widget.h.

Referenced by FOOTPRINT_SELECT_WIDGET(), and OnProgressTimer().

wxString FOOTPRINT_SELECT_WIDGET::m_default_footprint
private

Definition at line 144 of file footprint_select_widget.h.

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

bool FOOTPRINT_SELECT_WIDGET::m_finished_loading
private

Definition at line 142 of file footprint_select_widget.h.

Referenced by OnProgressTimer(), and UpdateList().

FOOTPRINT_FILTER FOOTPRINT_SELECT_WIDGET::m_fp_filter
private
std::unique_ptr<FOOTPRINT_LIST>& FOOTPRINT_SELECT_WIDGET::m_fp_list
private

Definition at line 149 of file footprint_select_widget.h.

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

FOOTPRINT_ASYNC_LOADER& FOOTPRINT_SELECT_WIDGET::m_fp_loader
private

Definition at line 148 of file footprint_select_widget.h.

Referenced by Load(), and OnProgressTimer().

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

Definition at line 133 of file footprint_select_widget.h.

Referenced by Load(), and ShowPicker().

int FOOTPRINT_SELECT_WIDGET::m_last_item
private

Definition at line 146 of file footprint_select_widget.h.

Referenced by DoOther(), and OnComboBox().

int FOOTPRINT_SELECT_WIDGET::m_max_items
private

Definition at line 143 of file footprint_select_widget.h.

Referenced by UpdateList().

wxString FOOTPRINT_SELECT_WIDGET::m_other_footprint
private

Definition at line 145 of file footprint_select_widget.h.

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

wxGauge* FOOTPRINT_SELECT_WIDGET::m_progress_ctrl
private

Definition at line 134 of file footprint_select_widget.h.

Referenced by FOOTPRINT_SELECT_WIDGET(), and OnProgressTimer().

std::unique_ptr<wxTimer> FOOTPRINT_SELECT_WIDGET::m_progress_timer
private

Definition at line 139 of file footprint_select_widget.h.

Referenced by FOOTPRINT_SELECT_WIDGET(), Load(), and OnProgressTimer().

wxSizer* FOOTPRINT_SELECT_WIDGET::m_sizer
private

Definition at line 136 of file footprint_select_widget.h.

Referenced by FOOTPRINT_SELECT_WIDGET().

bool FOOTPRINT_SELECT_WIDGET::m_update
private

Definition at line 141 of file footprint_select_widget.h.

Referenced by OnProgressTimer().

bool FOOTPRINT_SELECT_WIDGET::m_zero_filter
private

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