#include <panel_footprint_chooser.h>

Inheritance diagram for PANEL_FOOTPRINT_CHOOSER:

Public Member Functions
	PANEL_FOOTPRINT_CHOOSER (PCB_BASE_FRAME aFrame, wxTopLevelWindow aParent, const wxArrayString &aFootprintHistoryList, std::function< bool(LIB_TREE_NODE &)> aFilter, std::function< void()> aAcceptHandler, std::function< void()> aEscapeHandler)
	Create dialog to choose component.

	~PANEL_FOOTPRINT_CHOOSER ()

void	FinishSetup ()

void	SetPreselect (const LIB_ID &aPreselect)

LIB_ID	GetSelectedLibId () const
	To be called after this dialog returns from ShowModal().

int	GetItemCount () const

wxWindow *	GetFocusTarget () const

wxSizer *	GetFiltersSizer () const

void	Regenerate ()

FOOTPRINT_PREVIEW_WIDGET *	GetViewerPanel () const

wxSplitterWindow *	GetVerticalSpliter () const

wxPanel *	GetDetailsPanel () const

Public Attributes
wxPanel *	m_RightPanel

wxBoxSizer *	m_RightPanelSizer

const FOOTPRINT *	m_CurrFootprint

Protected Member Functions
void	OnDetailsCharHook (wxKeyEvent &aEvt)

void	onCloseTimer (wxTimerEvent &aEvent)

void	onOpenLibsTimer (wxTimerEvent &aEvent)

void	onMenuOpen (wxMenuEvent &aEvent)
	Handle parent frame menu events to block tree preview.

void	onMenuClose (wxMenuEvent &aEvent)

void	onFootprintSelected (wxCommandEvent &aEvent)

void	onFootprintChosen (wxCommandEvent &aEvent)
	Handle the selection of an item.

Protected Attributes
wxPanel *	m_detailsPanel

wxTimer *	m_dbl_click_timer

wxTimer *	m_open_libs_timer

wxSplitterWindow *	m_hsplitter

wxSplitterWindow *	m_vsplitter

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER >	m_adapter

FOOTPRINT_PREVIEW_WIDGET *	m_preview_ctrl

LIB_TREE *	m_tree

HTML_WINDOW *	m_details

PCB_BASE_FRAME *	m_frame

std::function< bool(LIB_TREE_NODE &)>	m_filter

std::function< void()>	m_acceptHandler

std::function< void()>	m_escapeHandler

Static Protected Attributes
static constexpr int	DblClickDelay = 100

Detailed Description

Definition at line 42 of file panel_footprint_chooser.h.

Constructor & Destructor Documentation

◆ PANEL_FOOTPRINT_CHOOSER()

PANEL_FOOTPRINT_CHOOSER::PANEL_FOOTPRINT_CHOOSER	(	PCB_BASE_FRAME *	aFrame,
		wxTopLevelWindow *	aParent,
		const wxArrayString &	aFootprintHistoryList,
		std::function< bool(LIB_TREE_NODE &)>	aFilter,
		std::function< void()>	aAcceptHandler,
		std::function< void()>	aEscapeHandler )

Create dialog to choose component.

Parameters

aFrame	the parent frame (usually a PCB_EDIT_FRAME or FOOTPRINT_CHOOSER_FRAME)
aParent	the parent window (usually a DIALOG_SHIM or FOOTPRINT_CHOOSER_FRAME)
aAcceptHandler	a handler to be called on double-click of a footprint
aEscapeHandler	a handler to be called on <ESC>

Definition at line 53 of file panel_footprint_chooser.cpp.

References _, FP_TREE_MODEL_ADAPTER::AddLibraries(), LIB_TREE::ALL_WIDGETS, FP_TREE_MODEL_ADAPTER::Create(), LIB_TREE_MODEL_ADAPTER::DoAddLibrary(), GFootprintList, m_acceptHandler, m_adapter, m_CurrFootprint, m_dbl_click_timer, m_details, m_detailsPanel, m_escapeHandler, m_filter, m_frame, m_hsplitter, LIB_TREE_NODE::m_IsRecentlyUsedGroup, m_open_libs_timer, m_preview_ctrl, m_RightPanel, m_RightPanelSizer, m_tree, m_vsplitter, move, onCloseTimer(), OnDetailsCharHook(), onFootprintChosen(), onFootprintSelected(), onMenuClose(), onMenuOpen(), onOpenLibsTimer(), PROJECT_PCB::PcbFootprintLibs(), PR_CAN_ABORT, KIWAY_HOLDER::Prj(), LIB_TREE_MODEL_ADAPTER::SetFilter(), and LIB_TREE_MODEL_ADAPTER::SetPreselectNode().

◆ ~PANEL_FOOTPRINT_CHOOSER()

PANEL_FOOTPRINT_CHOOSER::~PANEL_FOOTPRINT_CHOOSER ( )

Definition at line 217 of file panel_footprint_chooser.cpp.

References GetAppSettings(), m_adapter, m_dbl_click_timer, m_details, m_frame, m_hsplitter, m_open_libs_timer, m_tree, m_vsplitter, onCloseTimer(), OnDetailsCharHook(), onFootprintChosen(), onFootprintSelected(), onMenuClose(), and onMenuOpen().

Member Function Documentation

◆ FinishSetup()

void PANEL_FOOTPRINT_CHOOSER::FinishSetup ( )

Definition at line 265 of file panel_footprint_chooser.cpp.

References GetAppSettings(), PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::height, m_adapter, m_hsplitter, m_vsplitter, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::sash_h, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::sash_v, PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::sort_mode, and PCBNEW_SETTINGS::FOOTPRINT_CHOOSER::width.

◆ GetDetailsPanel()

wxPanel * PANEL_FOOTPRINT_CHOOSER::GetDetailsPanel ( ) const

inline

Definition at line 84 of file panel_footprint_chooser.h.

References m_detailsPanel.

◆ GetFiltersSizer()

wxSizer * PANEL_FOOTPRINT_CHOOSER::GetFiltersSizer ( ) const

inline

Definition at line 76 of file panel_footprint_chooser.h.

References m_tree.

◆ GetFocusTarget()

wxWindow * PANEL_FOOTPRINT_CHOOSER::GetFocusTarget ( ) const

inline

Definition at line 74 of file panel_footprint_chooser.h.

References m_tree.

◆ GetItemCount()

int PANEL_FOOTPRINT_CHOOSER::GetItemCount ( ) const

inline

Definition at line 72 of file panel_footprint_chooser.h.

References m_adapter.

◆ GetSelectedLibId()

LIB_ID PANEL_FOOTPRINT_CHOOSER::GetSelectedLibId ( ) const

To be called after this dialog returns from ShowModal().

Returns: the LIB_ID of the symbol that has been selected.

Definition at line 308 of file panel_footprint_chooser.cpp.

References m_tree.

◆ GetVerticalSpliter()

wxSplitterWindow * PANEL_FOOTPRINT_CHOOSER::GetVerticalSpliter ( ) const

inline

Definition at line 82 of file panel_footprint_chooser.h.

References m_vsplitter.

◆ GetViewerPanel()

FOOTPRINT_PREVIEW_WIDGET * PANEL_FOOTPRINT_CHOOSER::GetViewerPanel ( ) const

inline

Definition at line 80 of file panel_footprint_chooser.h.

References m_preview_ctrl.

◆ onCloseTimer()

void PANEL_FOOTPRINT_CHOOSER::onCloseTimer ( wxTimerEvent & aEvent )

protected

Definition at line 314 of file panel_footprint_chooser.cpp.

References DblClickDelay, m_acceptHandler, and m_dbl_click_timer.

Referenced by PANEL_FOOTPRINT_CHOOSER(), and ~PANEL_FOOTPRINT_CHOOSER().

◆ OnDetailsCharHook()

void PANEL_FOOTPRINT_CHOOSER::OnDetailsCharHook ( wxKeyEvent & aEvt )

protected

Definition at line 386 of file panel_footprint_chooser.cpp.

References m_details.

Referenced by PANEL_FOOTPRINT_CHOOSER(), and ~PANEL_FOOTPRINT_CHOOSER().

◆ onFootprintChosen()

void PANEL_FOOTPRINT_CHOOSER::onFootprintChosen ( wxCommandEvent & aEvent )

protected

Handle the selection of an item.

This is called when either the search box or the tree receive an Enter, or the tree receives a double click. If the item selected is a category, it is expanded or collapsed; if it is a component, the component is picked.

Definition at line 368 of file panel_footprint_chooser.cpp.

References DblClickDelay, m_dbl_click_timer, and m_tree.

Referenced by PANEL_FOOTPRINT_CHOOSER(), and ~PANEL_FOOTPRINT_CHOOSER().