#include <panel_symbol_chooser.h>

Inheritance diagram for PANEL_SYMBOL_CHOOSER:

Public Member Functions
	PANEL_SYMBOL_CHOOSER (SCH_BASE_FRAME aFrame, wxWindow aParent, const SYMBOL_LIBRARY_FILTER *aFilter, std::vector< PICKED_SYMBOL > &aHistoryList, std::vector< PICKED_SYMBOL > &aAlreadyPlaced, bool aAllowFieldEdits, bool aShowFootprints, std::function< void()> aAcceptHandler, std::function< void()> aEscapeHandler)
	Create dialog to choose symbol.

	~PANEL_SYMBOL_CHOOSER ()

void	OnChar (wxKeyEvent &aEvent)

void	FinishSetup ()

void	SetPreselect (const LIB_ID &aPreselect)

LIB_ID	GetSelectedLibId (int *aUnit=nullptr) const
	To be called after this dialog returns from ShowModal().

int	GetItemCount () const

wxWindow *	GetFocusTarget () const

std::vector< std::pair< int, wxString > >	GetFields () const
	Get a list of fields edited by the user.

Static Public Attributes
static std::mutex	g_Mutex

Protected Member Functions
wxPanel *	constructRightPanel (wxWindow *aParent)

void	OnDetailsCharHook (wxKeyEvent &aEvt)

void	onCloseTimer (wxTimerEvent &aEvent)

void	onOpenLibsTimer (wxTimerEvent &aEvent)

void	onFootprintSelected (wxCommandEvent &aEvent)

void	onSymbolSelected (wxCommandEvent &aEvent)

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

void	showFootprintFor (const LIB_ID &aLibId)
	Look up the footprint for a given symbol specified in the LIB_ID and display it.

void	showFootprint (const wxString &aFootprint)
	Display the given footprint by name.

void	populateFootprintSelector (const LIB_ID &aLibId)
	Populate the footprint selector for a given alias.

Protected Attributes
wxTimer *	m_dbl_click_timer

wxTimer *	m_open_libs_timer

SYMBOL_PREVIEW_WIDGET *	m_symbol_preview

wxSplitterWindow *	m_hsplitter

wxSplitterWindow *	m_vsplitter

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER >	m_adapter

FOOTPRINT_SELECT_WIDGET *	m_fp_sel_ctrl

FOOTPRINT_PREVIEW_WIDGET *	m_fp_preview

LIB_TREE *	m_tree

HTML_WINDOW *	m_details

SCH_BASE_FRAME *	m_frame

std::function< void()>	m_acceptHandler

std::function< void()>	m_escapeHandler

bool	m_showPower

bool	m_allow_field_edits

bool	m_show_footprints

wxString	m_fp_override

std::vector< std::pair< int, wxString > >	m_field_edits

Static Protected Attributes
static constexpr int	DBLCLICK_DELAY = 100

static wxString	g_symbolSearchString

static wxString	g_powerSearchString

Detailed Description

Definition at line 44 of file panel_symbol_chooser.h.

Constructor & Destructor Documentation

◆ PANEL_SYMBOL_CHOOSER()

PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER	(	SCH_BASE_FRAME *	aFrame,
		wxWindow *	aParent,
		const SYMBOL_LIBRARY_FILTER *	aFilter,
		std::vector< PICKED_SYMBOL > &	aHistoryList,
		std::vector< PICKED_SYMBOL > &	aAlreadyPlaced,
		bool	aAllowFieldEdits,
		bool	aShowFootprints,
		std::function< void()>	aAcceptHandler,
		std::function< void()>	aEscapeHandler
	)

Create dialog to choose symbol.

Parameters

aFrame	the parent frame (usually a SCH_EDIT_FRAME or SYMBOL_CHOOSER_FRAME)
aParent	the parent window (usually a DIALOG_SHIM or SYMBOL_CHOOSER_FRAME)
aAllowFieldEdits	if false, all functions that allow the user to edit fields (currently just footprint selection) will not be available.
aShowFootprints	if false, all footprint preview and selection features are disabled. This forces aAllowFieldEdits false too.
aAcceptHandler	a handler to be called on double-click of a footprint
aEscapeHandler	a handler to be called on <ESC>

Definition at line 55 of file panel_symbol_chooser.cpp.

References _, SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), LIB_TREE::ALL_WIDGETS, LIB_TREE_MODEL_ADAPTER::AssignIntrinsicRanks(), constructRightPanel(), alg::contains(), SYMBOL_TREE_MODEL_ADAPTER::Create(), LIB_TREE_MODEL_ADAPTER::DoAddLibrary(), SYMBOL_LIB_TABLE::FindRow(), g_powerSearchString, g_symbolSearchString, SYMBOL_LIBRARY_FILTER::GetAllowedLibList(), SETTINGS_MANAGER::GetAppSettings(), PGM_BASE::GetCommonSettings(), SYMBOL_LIBRARY_FILTER::GetFilterPowerSymbols(), LIB_TABLE_ROW::GetIsVisible(), SCH_BASE_FRAME::GetLibSymbol(), LIB_TABLE::GetLogicalLibs(), PROJECT::GetProjectFile(), PGM_BASE::GetSettingsManager(), LIB_TABLE::HasLibrary(), m_acceptHandler, m_adapter, m_dbl_click_timer, m_details, m_fp_sel_ctrl, m_frame, m_hsplitter, m_open_libs_timer, COMMON_SETTINGS::m_Session, m_show_footprints, m_showPower, m_tree, m_vsplitter, OnChar(), onCloseTimer(), OnDetailsCharHook(), onFootprintSelected(), onOpenLibsTimer(), onSymbolChosen(), onSymbolSelected(), Pgm(), COMMON_SETTINGS::SESSION::pinned_symbol_libs, KIWAY_HOLDER::Prj(), project, PROJECT_SCH::SchSymbolLibTable(), LIB_TREE_MODEL_ADAPTER::SetFilter(), LIB_TREE_MODEL_ADAPTER::SetPreselectNode(), LIB_TREE::SetSearchString(), and SCH_FIELD::SetText().

◆ ~PANEL_SYMBOL_CHOOSER()

PANEL_SYMBOL_CHOOSER::~PANEL_SYMBOL_CHOOSER ( )

Definition at line 292 of file panel_symbol_chooser.cpp.

References g_powerSearchString, g_symbolSearchString, LIB_TREE::GetSearchString(), LIB_TREE::GetSortMode(), Kiface(), m_adapter, m_dbl_click_timer, m_details, m_fp_sel_ctrl, m_hsplitter, m_open_libs_timer, m_showPower, m_tree, m_vsplitter, OnChar(), onCloseTimer(), OnDetailsCharHook(), onFootprintSelected(), onSymbolChosen(), and onSymbolSelected().

Member Function Documentation

◆ constructRightPanel()

wxPanel * PANEL_SYMBOL_CHOOSER::constructRightPanel ( wxWindow * aParent )

protected

◆ FinishSetup()

void PANEL_SYMBOL_CHOOSER::FinishSetup ( )

◆ GetFields()

std::vector< std::pair< int, wxString > > PANEL_SYMBOL_CHOOSER::GetFields ( ) const

inline

Get a list of fields edited by the user.

Returns: vector of pairs; each.first = field ID, each.second = new value.

Definition at line 97 of file panel_symbol_chooser.h.

References m_field_edits.

Referenced by DIALOG_SYMBOL_CHOOSER::GetFields().

◆ GetFocusTarget()

wxWindow * PANEL_SYMBOL_CHOOSER::GetFocusTarget ( ) const

inline

Definition at line 90 of file panel_symbol_chooser.h.

References LIB_TREE::GetFocusTarget(), and m_tree.

Referenced by DIALOG_SYMBOL_CHOOSER::DIALOG_SYMBOL_CHOOSER(), and SYMBOL_CHOOSER_FRAME::OnPaint().

◆ GetItemCount()

int PANEL_SYMBOL_CHOOSER::GetItemCount ( ) const

inline

Definition at line 88 of file panel_symbol_chooser.h.

References m_adapter.

Referenced by DIALOG_SYMBOL_CHOOSER::DIALOG_SYMBOL_CHOOSER(), and SYMBOL_CHOOSER_FRAME::SYMBOL_CHOOSER_FRAME().

◆ GetSelectedLibId()

LIB_ID PANEL_SYMBOL_CHOOSER::GetSelectedLibId ( int * aUnit = nullptr ) const

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

For multi-unit symbols, if the user selects the symbol itself rather than picking an individual unit, 0 will be returned in aUnit. Beware that this is an invalid unit number - this should be replaced with whatever default is desired (usually 1).

Parameters

aUnit if not NULL, the selected unit is filled in here.

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

Definition at line 496 of file panel_symbol_chooser.cpp.

References LIB_TREE::GetSelectedLibId(), and m_tree.

Referenced by DIALOG_SYMBOL_CHOOSER::GetSelectedLibId(), and SYMBOL_CHOOSER_FRAME::OnOK().

◆ OnChar()

void PANEL_SYMBOL_CHOOSER::OnChar ( wxKeyEvent & aEvent )

Definition at line 341 of file panel_symbol_chooser.cpp.

References LIB_TREE::GetSearchString(), m_escapeHandler, m_tree, and LIB_TREE::SetSearchString().

Referenced by DIALOG_SYMBOL_CHOOSER::DIALOG_SYMBOL_CHOOSER(), PANEL_SYMBOL_CHOOSER(), and ~PANEL_SYMBOL_CHOOSER().

◆ onCloseTimer()

void PANEL_SYMBOL_CHOOSER::onCloseTimer ( wxTimerEvent & aEvent )

protected

Definition at line 502 of file panel_symbol_chooser.cpp.

References DBLCLICK_DELAY, m_acceptHandler, and m_dbl_click_timer.

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

◆ OnDetailsCharHook()

void PANEL_SYMBOL_CHOOSER::OnDetailsCharHook ( wxKeyEvent & aEvt )

protected

Definition at line 468 of file panel_symbol_chooser.cpp.

References m_details.

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

◆ onFootprintSelected()

void PANEL_SYMBOL_CHOOSER::onFootprintSelected ( wxCommandEvent & aEvent )

protected

Definition at line 628 of file panel_symbol_chooser.cpp.

References alg::delete_if(), FOOTPRINT_FIELD, m_field_edits, m_fp_override, and showFootprint().

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

◆ onOpenLibsTimer()

void PANEL_SYMBOL_CHOOSER::onOpenLibsTimer ( wxTimerEvent & aEvent )

protected

Definition at line 522 of file panel_symbol_chooser.cpp.

References Kiface(), and m_adapter.

Referenced by PANEL_SYMBOL_CHOOSER().

◆ onSymbolChosen()

void PANEL_SYMBOL_CHOOSER::onSymbolChosen ( 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 symbol, the symbol is picked.

Definition at line 670 of file panel_symbol_chooser.cpp.

References DBLCLICK_DELAY, LIB_TREE::GetSelectedLibId(), LIB_ID::IsValid(), m_dbl_click_timer, and m_tree.

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

◆ onSymbolSelected()

void PANEL_SYMBOL_CHOOSER::onSymbolSelected ( wxCommandEvent & aEvent )

protected

◆ populateFootprintSelector()

void PANEL_SYMBOL_CHOOSER::populateFootprintSelector ( const LIB_ID & aLibId )

protected

Populate the footprint selector for a given alias.

Parameters

aLibId the LIB_ID of the selection or invalid to clear.

Definition at line 584 of file panel_symbol_chooser.cpp.

References _, FOOTPRINT_SELECT_WIDGET::ClearFilters(), FOOTPRINT_SELECT_WIDGET::Enable(), FOOTPRINT_SELECT_WIDGET::FilterByFootprintFilters(), FOOTPRINT_SELECT_WIDGET::FilterByPinCount(), FOOTPRINT_FIELD, LIB_SYMBOL::GetFieldById(), LIB_SYMBOL::GetFPFilters(), SCH_FIELD::GetFullText(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_SYMBOL::GetPins(), LIB_ID::IsValid(), SYMBOL_LIB_TABLE::LoadSymbol(), m_fp_sel_ctrl, m_frame, KIWAY_HOLDER::Prj(), PROJECT_SCH::SchSymbolLibTable(), FOOTPRINT_SELECT_WIDGET::SetDefaultFootprint(), FOOTPRINT_SELECT_WIDGET::UpdateList(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by onSymbolSelected().

◆ SetPreselect()

void PANEL_SYMBOL_CHOOSER::SetPreselect ( const LIB_ID & aPreselect )

Definition at line 490 of file panel_symbol_chooser.cpp.

References m_adapter.

Referenced by DIALOG_SYMBOL_CHOOSER::DIALOG_SYMBOL_CHOOSER(), and SYMBOL_CHOOSER_FRAME::ShowModal().

◆ showFootprint()

void PANEL_SYMBOL_CHOOSER::showFootprint ( const wxString & aFootprint )

protected

Display the given footprint by name.

Definition at line 558 of file panel_symbol_chooser.cpp.

References _, FOOTPRINT_PREVIEW_WIDGET::ClearStatus(), FOOTPRINT_PREVIEW_WIDGET::DisplayFootprint(), FOOTPRINT_PREVIEW_WIDGET::IsInitialized(), LIB_ID::IsValid(), m_fp_preview, LIB_ID::Parse(), and FOOTPRINT_PREVIEW_WIDGET::SetStatusText().

Referenced by onFootprintSelected(), onSymbolSelected(), and showFootprintFor().

◆ showFootprintFor()

void PANEL_SYMBOL_CHOOSER::showFootprintFor ( const LIB_ID & aLibId )

protected

Look up the footprint for a given symbol specified in the LIB_ID and display it.

Definition at line 529 of file panel_symbol_chooser.cpp.

References _, FOOTPRINT_FIELD, LIB_SYMBOL::GetFieldById(), SCH_FIELD::GetFullText(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), FOOTPRINT_PREVIEW_WIDGET::IsInitialized(), SYMBOL_LIB_TABLE::LoadSymbol(), m_fp_preview, m_frame, KIWAY_HOLDER::Prj(), PROJECT_SCH::SchSymbolLibTable(), showFootprint(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by onSymbolSelected().

Member Data Documentation

◆ DBLCLICK_DELAY

constexpr int PANEL_SYMBOL_CHOOSER::DBLCLICK_DELAY = 100

staticconstexprprotected

Definition at line 103 of file panel_symbol_chooser.h.

Referenced by onCloseTimer(), and onSymbolChosen().

◆ g_Mutex

std::mutex PANEL_SYMBOL_CHOOSER::g_Mutex

static

Definition at line 140 of file panel_symbol_chooser.h.

◆ g_powerSearchString

wxString PANEL_SYMBOL_CHOOSER::g_powerSearchString

staticprotected

Definition at line 144 of file panel_symbol_chooser.h.

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

◆ g_symbolSearchString

wxString PANEL_SYMBOL_CHOOSER::g_symbolSearchString

staticprotected

Definition at line 143 of file panel_symbol_chooser.h.

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

◆ m_acceptHandler

std::function<void()> PANEL_SYMBOL_CHOOSER::m_acceptHandler

protected

Definition at line 160 of file panel_symbol_chooser.h.

Referenced by onCloseTimer(), and PANEL_SYMBOL_CHOOSER().

◆ m_adapter

wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER> PANEL_SYMBOL_CHOOSER::m_adapter

protected

Definition at line 152 of file panel_symbol_chooser.h.

Referenced by FinishSetup(), GetItemCount(), onOpenLibsTimer(), PANEL_SYMBOL_CHOOSER(), SetPreselect(), and ~PANEL_SYMBOL_CHOOSER().

◆ m_allow_field_edits

bool PANEL_SYMBOL_CHOOSER::m_allow_field_edits

protected

Definition at line 164 of file panel_symbol_chooser.h.

Referenced by constructRightPanel().

◆ m_dbl_click_timer

wxTimer* PANEL_SYMBOL_CHOOSER::m_dbl_click_timer

protected

Definition at line 146 of file panel_symbol_chooser.h.

Referenced by onCloseTimer(), onSymbolChosen(), PANEL_SYMBOL_CHOOSER(), and ~PANEL_SYMBOL_CHOOSER().

◆ m_details

HTML_WINDOW* PANEL_SYMBOL_CHOOSER::m_details

protected

Definition at line 157 of file panel_symbol_chooser.h.

Referenced by OnDetailsCharHook(), PANEL_SYMBOL_CHOOSER(), and ~PANEL_SYMBOL_CHOOSER().

◆ m_escapeHandler

std::function<void()> PANEL_SYMBOL_CHOOSER::m_escapeHandler

protected

Definition at line 161 of file panel_symbol_chooser.h.

Referenced by OnChar().

◆ m_field_edits

std::vector<std::pair<int, wxString> > PANEL_SYMBOL_CHOOSER::m_field_edits

protected

Definition at line 168 of file panel_symbol_chooser.h.

Referenced by GetFields(), and onFootprintSelected().

◆ m_fp_override

wxString PANEL_SYMBOL_CHOOSER::m_fp_override

protected

Definition at line 166 of file panel_symbol_chooser.h.

Referenced by onFootprintSelected().

◆ m_fp_preview

FOOTPRINT_PREVIEW_WIDGET* PANEL_SYMBOL_CHOOSER::m_fp_preview

protected

Definition at line 155 of file panel_symbol_chooser.h.

Referenced by constructRightPanel(), FinishSetup(), onSymbolSelected(), showFootprint(), and showFootprintFor().

◆ m_fp_sel_ctrl

FOOTPRINT_SELECT_WIDGET* PANEL_SYMBOL_CHOOSER::m_fp_sel_ctrl

protected

Definition at line 154 of file panel_symbol_chooser.h.

Referenced by constructRightPanel(), FinishSetup(), PANEL_SYMBOL_CHOOSER(), populateFootprintSelector(), and ~PANEL_SYMBOL_CHOOSER().

◆ m_frame

SCH_BASE_FRAME* PANEL_SYMBOL_CHOOSER::m_frame

protected

Definition at line 159 of file panel_symbol_chooser.h.

Referenced by constructRightPanel(), FinishSetup(), PANEL_SYMBOL_CHOOSER(), populateFootprintSelector(), and showFootprintFor().

◆ m_hsplitter

wxSplitterWindow* PANEL_SYMBOL_CHOOSER::m_hsplitter

protected

Definition at line 149 of file panel_symbol_chooser.h.

Referenced by FinishSetup(), PANEL_SYMBOL_CHOOSER(), and ~PANEL_SYMBOL_CHOOSER().

◆ m_open_libs_timer

wxTimer* PANEL_SYMBOL_CHOOSER::m_open_libs_timer

protected

Definition at line 147 of file panel_symbol_chooser.h.

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

◆ m_show_footprints

bool PANEL_SYMBOL_CHOOSER::m_show_footprints

protected

Definition at line 165 of file panel_symbol_chooser.h.

Referenced by constructRightPanel(), and PANEL_SYMBOL_CHOOSER().

◆ m_showPower

bool PANEL_SYMBOL_CHOOSER::m_showPower

protected

Definition at line 163 of file panel_symbol_chooser.h.

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

◆ m_symbol_preview

SYMBOL_PREVIEW_WIDGET* PANEL_SYMBOL_CHOOSER::m_symbol_preview

protected

Definition at line 148 of file panel_symbol_chooser.h.

Referenced by constructRightPanel(), and onSymbolSelected().

◆ m_tree

LIB_TREE* PANEL_SYMBOL_CHOOSER::m_tree

protected

Definition at line 156 of file panel_symbol_chooser.h.

Referenced by GetFocusTarget(), GetSelectedLibId(), OnChar(), onSymbolChosen(), onSymbolSelected(), PANEL_SYMBOL_CHOOSER(), and ~PANEL_SYMBOL_CHOOSER().

◆ m_vsplitter

wxSplitterWindow* PANEL_SYMBOL_CHOOSER::m_vsplitter

protected

Definition at line 150 of file panel_symbol_chooser.h.

Referenced by FinishSetup(), PANEL_SYMBOL_CHOOSER(), and ~PANEL_SYMBOL_CHOOSER().

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PANEL_SYMBOL_CHOOSER()

◆ ~PANEL_SYMBOL_CHOOSER()

Member Function Documentation

◆ constructRightPanel()

◆ FinishSetup()

◆ GetFields()

◆ GetFocusTarget()

◆ GetItemCount()

◆ GetSelectedLibId()

◆ OnChar()

◆ onCloseTimer()

◆ OnDetailsCharHook()

◆ onFootprintSelected()

◆ onOpenLibsTimer()

◆ onSymbolChosen()

◆ onSymbolSelected()

◆ populateFootprintSelector()

◆ SetPreselect()

◆ showFootprint()

◆ showFootprintFor()

Member Data Documentation

◆ DBLCLICK_DELAY

◆ g_Mutex

◆ g_powerSearchString

◆ g_symbolSearchString

◆ m_acceptHandler

◆ m_adapter

◆ m_allow_field_edits

◆ m_dbl_click_timer

◆ m_details

◆ m_escapeHandler

◆ m_field_edits

◆ m_fp_override

◆ m_fp_preview

◆ m_fp_sel_ctrl

◆ m_frame

◆ m_hsplitter

◆ m_open_libs_timer

◆ m_show_footprints

◆ m_showPower

◆ m_symbol_preview

◆ m_tree

◆ m_vsplitter