#include <listboxes.h>

Inheritance diagram for FOOTPRINTS_LISTBOX:

Public Types
enum	FP_FILTER_T : int { UNFILTERED_FP_LIST = 0 , FILTERING_BY_COMPONENT_FP_FILTERS = 0x0001 , FILTERING_BY_PIN_COUNT = 0x0002 , FILTERING_BY_LIBRARY = 0x0004 }
	Filter setting constants. More...

Public Member Functions
	FOOTPRINTS_LISTBOX (CVPCB_MAINFRAME *parent, wxWindowID id)

virtual	~FOOTPRINTS_LISTBOX ()=default

int	GetCount ()

void	SetSelection (int aIndex, bool aState=true)

void	SetSelectedFootprint (const LIB_ID &aFPID)

void	SetString (unsigned linecount, const wxString &text)

void	SetFootprints (FOOTPRINT_LIST &aList, const wxString &aLibName, COMPONENT *aComponent, const wxString &aFootPrintFilterPattern, int aFilterType)
	Populate the wxListCtrl with the footprints from aList that meet the filter criteria defined by aFilterType.

wxString	GetSelectedFootprint ()

wxString	OnGetItemText (long item, long column) const override
	This overloaded function MUST be provided for the wxLC_VIRTUAL mode because real data is not handled by ITEMS_LISTBOX_BASE.

void	OnLeftClick (wxListEvent &event)

void	OnLeftDClick (wxListEvent &event)

void	OnChar (wxKeyEvent &event)

	DECLARE_EVENT_TABLE ()

int	GetSelection ()

void	DeselectAll ()
	Remove all selection in lists which can have more than one item selected.

virtual CVPCB_MAINFRAME *	GetParent () const

void	UpdateWidth (int aLine=-1)
	Update the width of the column based on its contents.

void	Shutdown ()

Protected Attributes
bool	m_isClosing

Private Member Functions
void	UpdateLineWidth (unsigned aLine, wxClientDC &dc)
	Calculate the width of the given line, and increase the column width if needed.

Private Attributes
wxArrayString	m_footprintList

int	m_columnWidth

Detailed Description

Definition at line 91 of file listboxes.h.

Member Enumeration Documentation

◆ FP_FILTER_T

enum FOOTPRINTS_LISTBOX::FP_FILTER_T : int

Filter setting constants.

The filter type is a bitwise OR of these flags, and only footprints matching all selected filter types are shown.

Enumerator
UNFILTERED_FP_LIST
FILTERING_BY_COMPONENT_FP_FILTERS
FILTERING_BY_PIN_COUNT
FILTERING_BY_LIBRARY

Definition at line 98 of file listboxes.h.

Constructor & Destructor Documentation

◆ FOOTPRINTS_LISTBOX()

FOOTPRINTS_LISTBOX::FOOTPRINTS_LISTBOX	(	CVPCB_MAINFRAME *	parent,
		wxWindowID	id )

Definition at line 35 of file footprints_listbox.cpp.

References ITEMS_LISTBOX_BASE::ITEMS_LISTBOX_BASE().

Referenced by OnLeftClick().

◆ ~FOOTPRINTS_LISTBOX()

virtual FOOTPRINTS_LISTBOX::~FOOTPRINTS_LISTBOX ( )

virtualdefault

References text.

Member Function Documentation

◆ DECLARE_EVENT_TABLE()

FOOTPRINTS_LISTBOX::DECLARE_EVENT_TABLE ( )

◆ DeselectAll()

void ITEMS_LISTBOX_BASE::DeselectAll ( )

inherited

Remove all selection in lists which can have more than one item selected.

Definition at line 98 of file listbox_base.cpp.

Referenced by FOOTPRINTS_LISTBOX::SetFootprints().

◆ GetCount()

int FOOTPRINTS_LISTBOX::GetCount ( )

Definition at line 41 of file footprints_listbox.cpp.

References m_footprintList.

Referenced by SetSelectedFootprint(), and SetSelection().

◆ GetParent()

CVPCB_MAINFRAME * ITEMS_LISTBOX_BASE::GetParent ( ) const

virtualinherited

Definition at line 107 of file listbox_base.cpp.

Referenced by FOOTPRINTS_LISTBOX::OnLeftClick(), FOOTPRINTS_LISTBOX::OnLeftDClick(), SYMBOLS_LISTBOX::OnSelectComponent(), and LIBRARY_LISTBOX::OnSelectLibrary().

◆ GetSelectedFootprint()

wxString FOOTPRINTS_LISTBOX::GetSelectedFootprint ( )

Definition at line 63 of file footprints_listbox.cpp.

References m_footprintList.

◆ GetSelection()

int ITEMS_LISTBOX_BASE::GetSelection ( )

inherited

Returns: the index of the selected item in lists allowing only one item selected and the index of the first selected item in lists allowing many selection

Definition at line 92 of file listbox_base.cpp.

Referenced by FOOTPRINTS_LISTBOX::SetFootprints().

◆ OnChar()

void FOOTPRINTS_LISTBOX::OnChar ( wxKeyEvent & event )

Definition at line 211 of file footprints_listbox.cpp.

References dump(), kicadTraceKeyEvent, m_footprintList, ITEMS_LISTBOX_BASE::m_isClosing, SetSelection(), and text.

◆ OnGetItemText()

wxString FOOTPRINTS_LISTBOX::OnGetItemText	(	long	item,
		long	column ) const

override

This overloaded function MUST be provided for the wxLC_VIRTUAL mode because real data is not handled by ITEMS_LISTBOX_BASE.

Definition at line 80 of file footprints_listbox.cpp.

References m_footprintList.

◆ OnLeftClick()

void FOOTPRINTS_LISTBOX::OnLeftClick ( wxListEvent & event )

Definition at line 193 of file footprints_listbox.cpp.

References FOOTPRINTS_LISTBOX(), ITEMS_LISTBOX_BASE::GetParent(), ITEMS_LISTBOX_BASE::m_isClosing, and OnLeftClick().

Referenced by OnLeftClick().

◆ OnLeftDClick()

void FOOTPRINTS_LISTBOX::OnLeftDClick ( wxListEvent & event )

Definition at line 202 of file footprints_listbox.cpp.

References CVPCB_ACTIONS::associate, ITEMS_LISTBOX_BASE::GetParent(), TOOLS_HOLDER::GetToolManager(), ITEMS_LISTBOX_BASE::m_isClosing, and TOOL_MANAGER::RunAction().

◆ SetFootprints()

void FOOTPRINTS_LISTBOX::SetFootprints	(	FOOTPRINT_LIST &	aList,
		const wxString &	aLibName,
		COMPONENT *	aComponent,
		const wxString &	aFootPrintFilterPattern,
		int	aFilterType )

Populate the wxListCtrl with the footprints from aList that meet the filter criteria defined by aFilterType.

Parameters

aList	is a FOOTPRINT_LIST item containing the footprints.
aLibName	is wxString containing the name of the selected library. Can be wxEmptyString.
aComponent	is the COMPONENT used by the filtering criteria. Can be NULL.
aFootPrintFilterPattern	is the filter used to filter list by names.
aFilterType	defines the criteria to filter aList.

Definition at line 120 of file footprints_listbox.cpp.

References ITEMS_LISTBOX_BASE::DeselectAll(), filter, FILTERING_BY_COMPONENT_FP_FILTERS, FILTERING_BY_LIBRARY, FILTERING_BY_PIN_COUNT, COMPONENT::GetFootprintFilters(), COMPONENT::GetPinCount(), COMPONENT::GetReference(), ITEMS_LISTBOX_BASE::GetSelection(), m_footprintList, SetSelection(), and ITEMS_LISTBOX_BASE::UpdateWidth().

◆ SetSelectedFootprint()

void FOOTPRINTS_LISTBOX::SetSelectedFootprint ( const LIB_ID & aFPID )

Definition at line 103 of file footprints_listbox.cpp.

References LIB_ID::Format(), GetCount(), m_footprintList, SetSelection(), and UTF8::wx_str().

◆ SetSelection()

void FOOTPRINTS_LISTBOX::SetSelection	(	int	aIndex,
		bool	aState = true )

Definition at line 89 of file footprints_listbox.cpp.

References GetCount(), and Refresh().

Referenced by OnChar(), SetFootprints(), and SetSelectedFootprint().

◆ SetString()

void FOOTPRINTS_LISTBOX::SetString	(	unsigned	linecount,
		const wxString &	text )

Definition at line 47 of file footprints_listbox.cpp.

References m_footprintList, text, and ITEMS_LISTBOX_BASE::UpdateWidth().

◆ Shutdown()

void ITEMS_LISTBOX_BASE::Shutdown ( )

inlineinherited

Definition at line 73 of file listboxes.h.

References m_isClosing.

◆ UpdateLineWidth()

void ITEMS_LISTBOX_BASE::UpdateLineWidth	(	unsigned	aLine,
		wxClientDC &	dc )

privateinherited

Calculate the width of the given line, and increase the column width if needed.

This is effectively the wxListCtrl code for autosizing. NB. it relies on the caller checking the given line number is valid.

Definition at line 67 of file listbox_base.cpp.

References m_columnWidth.

Referenced by UpdateWidth().

◆ UpdateWidth()

void ITEMS_LISTBOX_BASE::UpdateWidth ( int aLine = -1 )

inherited

Update the width of the column based on its contents.

Parameters

aLine is the line to calculate the width from. If positive, the width will only be increased if needed. If negative, we start from scratch and all lines are considered, i.e., the column may be shrunk.

Definition at line 45 of file listbox_base.cpp.

References m_columnWidth, and UpdateLineWidth().

Referenced by SYMBOLS_LISTBOX::AppendLine(), LIBRARY_LISTBOX::Finish(), FOOTPRINTS_LISTBOX::SetFootprints(), FOOTPRINTS_LISTBOX::SetString(), LIBRARY_LISTBOX::SetString(), and SYMBOLS_LISTBOX::SetString().

Member Data Documentation

◆ m_columnWidth

int ITEMS_LISTBOX_BASE::m_columnWidth

privateinherited

Definition at line 87 of file listboxes.h.

Referenced by ITEMS_LISTBOX_BASE(), UpdateLineWidth(), and UpdateWidth().

◆ m_footprintList

wxArrayString FOOTPRINTS_LISTBOX::m_footprintList

private

Definition at line 144 of file listboxes.h.

Referenced by GetCount(), GetSelectedFootprint(), OnChar(), OnGetItemText(), SetFootprints(), SetSelectedFootprint(), and SetString().

◆ m_isClosing

bool ITEMS_LISTBOX_BASE::m_isClosing

protectedinherited

Definition at line 84 of file listboxes.h.

Referenced by ITEMS_LISTBOX_BASE(), FOOTPRINTS_LISTBOX::OnChar(), SYMBOLS_LISTBOX::OnChar(), FOOTPRINTS_LISTBOX::OnLeftClick(), FOOTPRINTS_LISTBOX::OnLeftDClick(), SYMBOLS_LISTBOX::OnSelectComponent(), and Shutdown().

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

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ FP_FILTER_T

Constructor & Destructor Documentation

◆ FOOTPRINTS_LISTBOX()

◆ ~FOOTPRINTS_LISTBOX()

Member Function Documentation

◆ DECLARE_EVENT_TABLE()

◆ DeselectAll()

◆ GetCount()

◆ GetParent()

◆ GetSelectedFootprint()

◆ GetSelection()

◆ OnChar()

◆ OnGetItemText()

◆ OnLeftClick()

◆ OnLeftDClick()

◆ SetFootprints()

◆ SetSelectedFootprint()

◆ SetSelection()

◆ SetString()

◆ Shutdown()

◆ UpdateLineWidth()

◆ UpdateWidth()

Member Data Documentation

◆ m_columnWidth

◆ m_footprintList

◆ m_isClosing