#include <footprint_select_widget.h>

Inheritance diagram for FOOTPRINT_SELECT_WIDGET:

Public Member Functions
	FOOTPRINT_SELECT_WIDGET (EDA_DRAW_FRAME aFrame, wxWindow aParent, FOOTPRINT_LIST *aFpList, bool aUpdate=true, int aMaxItems=400)
	Construct a footprint selector widget.

virtual	~FOOTPRINT_SELECT_WIDGET ()

void	Load (KIWAY &aKiway, PROJECT &aProject)
	Start loading.

void	ClearFilters ()
	Clear all filters.

void	FilterByPinCount (int aPinCount)
	Filter by pin count.

void	FilterByFootprintFilters (const wxArrayString &aFilters, bool aZeroFilters)
	Filter by footprint filter list.

void	SetDefaultFootprint (const wxString &aFp)
	Set the default footprint for a part.

bool	UpdateList ()
	Update the contents of the list to match the filters.

void	SelectDefault ()
	Set current selection to the default footprint.

virtual bool	Enable (bool aEnable=true) override
	Enable or disable the control for input.

Private Member Functions
void	OnComboBox (wxCommandEvent &aEvent)

Private Attributes
FOOTPRINT_CHOICE *	m_fp_sel_ctrl

wxSizer *	m_sizer

bool	m_update

int	m_max_items

wxString	m_default_footprint

FOOTPRINT_LIST *	m_fp_list

FOOTPRINT_FILTER	m_fp_filter

bool	m_zero_filter

EDA_DRAW_FRAME *	m_frame

Detailed Description

Definition at line 39 of file footprint_select_widget.h.

Constructor & Destructor Documentation

◆ FOOTPRINT_SELECT_WIDGET()

FOOTPRINT_SELECT_WIDGET::FOOTPRINT_SELECT_WIDGET	(	EDA_DRAW_FRAME *	aFrame,
		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 36 of file footprint_select_widget.cpp.

References m_fp_sel_ctrl, m_sizer, m_zero_filter, and OnComboBox().

◆ ~FOOTPRINT_SELECT_WIDGET()

virtual FOOTPRINT_SELECT_WIDGET::~FOOTPRINT_SELECT_WIDGET ( )

inlinevirtual

Definition at line 64 of file footprint_select_widget.h.

Member Function Documentation

◆ ClearFilters()

void FOOTPRINT_SELECT_WIDGET::ClearFilters ( )

Clear all filters.

Does not update the list.

Definition at line 106 of file footprint_select_widget.cpp.

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

Referenced by PANEL_SYMBOL_CHOOSER::populateFootprintSelector().

◆ Enable()

bool FOOTPRINT_SELECT_WIDGET::Enable ( bool aEnable = true )

overridevirtual

Enable or disable the control for input.

Definition at line 177 of file footprint_select_widget.cpp.

References m_fp_sel_ctrl.

Referenced by PANEL_SYMBOL_CHOOSER::populateFootprintSelector().

◆ FilterByFootprintFilters()

void FOOTPRINT_SELECT_WIDGET::FilterByFootprintFilters	(	const wxArrayString &	aFilters,
		bool	aZeroFilters
	)

Filter by footprint filter list.

Does not update the list.

Parameters

aFilters	is 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 120 of file footprint_select_widget.cpp.

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

Referenced by PANEL_SYMBOL_CHOOSER::populateFootprintSelector().