DIALOG_CHOOSE_SYMBOL Class Reference

Dialog class to select a symbol from the libraries. More...

#include <dialog_choose_symbol.h>

Inheritance diagram for DIALOG_CHOOSE_SYMBOL:

Public Types
enum	HOLDER_TYPE { DIALOG , FRAME , PANEL }

Public Member Functions
	DIALOG_CHOOSE_SYMBOL (SCH_BASE_FRAME *aParent, const wxString &aTitle, wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > &aAdapter, int aDeMorganConvert, bool aAllowFieldEdits, bool aShowFootprints, bool aAllowBrowser)
	Create dialog to choose symbol. More...
	~DIALOG_CHOOSE_SYMBOL ()
LIB_ID	GetSelectedLibId (int *aUnit=nullptr) const
	To be called after this dialog returns from ShowModal(). More...
bool	GetUseAllUnits () const
	To be called after this dialog returns from ShowModal() More...
bool	GetKeepSymbol () const
	To be called after this dialog returns from ShowModal() More...
std::vector< std::pair< int, wxString > >	GetFields () const
	Get a list of fields edited by the user. More...
bool	IsExternalBrowserSelected () const
void	SetInitialFocus (wxWindow *aWindow)
	Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...
int	ShowQuasiModal ()
void	EndQuasiModal (int retCode)
bool	IsQuasiModal () const
bool	Show (bool show) override
bool	Enable (bool enable) override
void	OnPaint (wxPaintEvent &event)
void	OnModify ()
void	SetPosition (const wxPoint &aNewPosition)
	Force the position of the dialog to a new position. More...
EDA_UNITS	GetUserUnits () const
void	SetupStandardButtons (std::map< int, wxString > aLabels={})
HOLDER_TYPE	GetType () const
KIWAY &	Kiway () const
	Return a reference to the KIWAY that this object has an opportunity to participate in. More...
bool	HasKiway () const
	Safety check before asking for the Kiway reference. More...
PROJECT &	Prj () const
	Return a reference to the PROJECT associated with this KIWAY. More...
void	SetKiway (wxWindow *aDest, KIWAY *aKiway)
	It is only used for debugging, since "this" is not a wxWindow*. More...

Static Public Member Functions
static bool	IsCtrl (int aChar, const wxKeyEvent &e)
static bool	IsShiftCtrl (int aChar, const wxKeyEvent &e)

Static Public Attributes
static std::mutex	g_Mutex

Protected Member Functions
wxPanel *	ConstructRightPanel (wxWindow *aParent)
void	OnInitDialog (wxInitDialogEvent &aEvent)
void	OnCharHook (wxKeyEvent &aEvt) override
void	OnCloseTimer (wxTimerEvent &aEvent)
void	OnUseBrowser (wxCommandEvent &aEvent)
void	OnFootprintSelected (wxCommandEvent &aEvent)
void	OnComponentPreselected (wxCommandEvent &aEvent)
void	OnComponentSelected (wxCommandEvent &aEvent)
	Handle the selection of an item. More...
void	ShowFootprintFor (const LIB_ID &aLibId)
	Look up the footprint for a given symbol specified in the LIB_ID and display it. More...
void	ShowFootprint (const wxString &aFootprint)
	Display the given footprint by name. More...
void	PopulateFootprintSelector (const LIB_ID &aLibId)
	Populate the footprint selector for a given alias. More...
void	finishDialogSettings ()
	In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...
void	setSizeInDU (int x, int y)
	Set the dialog to the given dimensions in "dialog units". More...
int	horizPixelsFromDU (int x) const
	Convert an integer number of dialog units to pixels, horizontally. More...
int	vertPixelsFromDU (int y) const
	Convert an integer number of dialog units to pixels, vertically. More...
void	resetSize ()
	Clear the existing dialog size and position. More...

Protected Attributes
wxTimer *	m_dbl_click_timer
SYMBOL_PREVIEW_WIDGET *	m_symbol_preview
wxButton *	m_browser_button
wxSplitterWindow *	m_hsplitter
wxSplitterWindow *	m_vsplitter
FOOTPRINT_SELECT_WIDGET *	m_fp_sel_ctrl
FOOTPRINT_PREVIEW_WIDGET *	m_fp_preview
wxCheckBox *	m_keepSymbol
wxCheckBox *	m_useUnits
LIB_TREE *	m_tree
HTML_WINDOW *	m_details
SCH_BASE_FRAME *	m_parent
bool	m_showPower
int	m_deMorganConvert
bool	m_allow_field_edits
bool	m_show_footprints
bool	m_external_browser_requested
wxString	m_fp_override
std::vector< std::pair< int, wxString > >	m_field_edits
EDA_UNITS	m_units
std::string	m_hash_key
bool	m_useCalculatedSize
bool	m_firstPaintEvent
wxWindow *	m_initialFocusTarget
WX_EVENT_LOOP *	m_qmodal_loop
bool	m_qmodal_showing
WDO_ENABLE_DISABLE *	m_qmodal_parent_disabler
EDA_BASE_FRAME *	m_parentFrame
std::vector< wxWindow * >	m_tabOrder
wxSize	m_initialSize
std::map< wxWindow *, wxString >	m_beforeEditValues

Static Protected Attributes
static constexpr int	DblClickDelay = 100
static wxString	g_symbolSearchString
static wxString	g_powerSearchString

Private Member Functions
void	selectAllInTextCtrls (wxWindowList &children)
void	OnCloseWindow (wxCloseEvent &aEvent)
	Properly handle the wxCloseEvent when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM. More...
void	OnButton (wxCommandEvent &aEvent)
	Properly handle the default button events when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM. More...
void	onChildSetFocus (wxFocusEvent &aEvent)
	DECLARE_EVENT_TABLE ()

Private Attributes
KIWAY *	m_kiway
HOLDER_TYPE	m_type

Detailed Description

Dialog class to select a symbol from the libraries.

This is the master View class in a Model-View-Adapter (mediated MVC) architecture. The other pieces are in:

• Adapter: SYM_TREE_MODEL_ADAPTER in common/cmp_tree_model_adapter.h
• Model: SYM_TREE_NODE and descendants in common/cmp_tree_model.h

Because everything is tied together in the adapter class, see that file for thorough documentation. A simple example usage follows:

// Create the adapter class
auto adapter( SYMBOL_TREE_MODEL_ADAPTER::Create( Prj().SchSymbolLibTable() ) );

// Perform any configuration of adapter properties here
adapter->SetPreselectNode( "LIB_NICKNAME", "SYMBO_NAME", 2 );

// Initialize model from #SYMBOL_LIB_TABLE
libNicknames = libs->GetLogicalLibs();

for( auto nickname : libNicknames )
    adapter->AddLibrary( nickname );

// Create and display dialog
DIALOG_CHOOSE_SYMBOL dlg( this, title, adapter, 1 );
bool selected = ( dlg.ShowModal() != wxID_CANCEL );

// Receive part
if( selected )
{
    int unit;
    #LIB_ID id = dlg.GetSelectedAlias( &unit );
    do_something( id, unit );
}

Definition at line 88 of file dialog_choose_symbol.h.

Member Enumeration Documentation

HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 39 of file kiway_holder.h.

Constructor & Destructor Documentation

DIALOG_CHOOSE_SYMBOL()

DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL	(	SCH_BASE_FRAME *	aParent,
		const wxString &	aTitle,
		wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > &	aAdapter,
		int	aDeMorganConvert,
		bool	aAllowFieldEdits,
		bool	aShowFootprints,
		bool	aAllowBrowser
	)

Create dialog to choose symbol.

Parameters

aParent	a SCH_BASE_FRAME parent window.
aTitle	Dialog title.
aAdapter	SYMBOL_TREE_MODEL_ADAPTER::PTR. See SYM_TREE_MODEL_ADAPTER for documentation.
aDeMorganConvert	preferred deMorgan conversion. (TODO: should happen in dialog)
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.
aAllowBrowser	show a Select with Browser button.

Definition at line 54 of file dialog_choose_symbol.cpp.

References _, LIB_TREE::ALL_WIDGETS, ConstructRightPanel(), g_powerSearchString, g_symbolSearchString, LIB_TREE::GetFocusTarget(), EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::height, DIALOG_SHIM::horizPixelsFromDU(), Kiface(), m_browser_button, m_dbl_click_timer, m_details, m_fp_sel_ctrl, m_hsplitter, m_keepSymbol, m_show_footprints, m_showPower, m_tree, m_useUnits, m_vsplitter, OnCharHook(), OnCloseTimer(), OnComponentPreselected(), OnComponentSelected(), OnFootprintSelected(), OnInitDialog(), OnUseBrowser(), KIWAY_HOLDER::Prj(), EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::sash_pos_h, EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::sash_pos_v, DIALOG_SHIM::SetInitialFocus(), LIB_TREE::SetSearchString(), DIALOG_SHIM::SetupStandardButtons(), LIB_TREE_MODEL_ADAPTER::SYM_FILTER_POWER, DIALOG_SHIM::vertPixelsFromDU(), and EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::width.

~DIALOG_CHOOSE_SYMBOL()

DIALOG_CHOOSE_SYMBOL::~DIALOG_CHOOSE_SYMBOL

(

)

Definition at line 238 of file dialog_choose_symbol.cpp.

References g_powerSearchString, g_symbolSearchString, LIB_TREE::GetSearchString(), LIB_TREE::GetSortMode(), Kiface(), m_browser_button, m_dbl_click_timer, m_details, m_fp_sel_ctrl, m_hsplitter, m_keepSymbol, m_showPower, m_tree, m_useUnits, m_vsplitter, OnCharHook(), OnCloseTimer(), OnComponentPreselected(), OnComponentSelected(), OnFootprintSelected(), OnInitDialog(), and OnUseBrowser().

Member Function Documentation

ConstructRightPanel()

wxPanel * DIALOG_CHOOSE_SYMBOL::ConstructRightPanel ( wxWindow *  aParent )

protected

Definition at line 291 of file dialog_choose_symbol.cpp.

References EDA_DRAW_PANEL_GAL::GetBackend(), SCH_BASE_FRAME::GetCanvas(), FOOTPRINT_LIST::GetInstance(), DIALOG_SHIM::GetUserUnits(), KIWAY_HOLDER::Kiway(), m_allow_field_edits, m_fp_preview, m_fp_sel_ctrl, m_parent, m_show_footprints, m_symbol_preview, and FOOTPRINT_PREVIEW_WIDGET::SetUserUnits().

Referenced by DIALOG_CHOOSE_SYMBOL().

DECLARE_EVENT_TABLE()

DIALOG_SHIM::DECLARE_EVENT_TABLE ( )

privateinherited

Enable()

bool DIALOG_SHIM::Enable ( bool  enable )

overrideinherited

Definition at line 314 of file dialog_shim.cpp.

EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode )

inherited

Definition at line 490 of file dialog_shim.cpp.

References DIALOG_SHIM::IsQuasiModal(), DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, and DIALOG_SHIM::Show().

Referenced by EDA_3D_CONTROLLER::Main(), DIALOG_EXPORT_NETLIST::OnAddGenerator(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_EXPORT_NETLIST::OnDelGenerator(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), PCB_ONE_LAYER_SELECTOR::OnLeftGridCellClick(), PCB_ONE_LAYER_SELECTOR::OnRightGridCellClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept(), and DIALOG_SHIM::~DIALOG_SHIM().

finishDialogSettings()

void DIALOG_SHIM::finishDialogSettings ( )

protectedinherited

In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls.

finishDialogSettings must be called from derived classes after all widgets have been initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at the end of TransferDataToWindow, or better yet, at end of a wxInitDialogEvent handler.

Definition at line 153 of file dialog_shim.cpp.

Referenced by CONVERT_SETTINGS_DIALOG::CONVERT_SETTINGS_DIALOG(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_BOOK_REPORTER::DIALOG_BOOK_REPORTER(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DATABASE_LIB_SETTINGS::DIALOG_DATABASE_LIB_SETTINGS(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_SYMBOLS_LIBID::DIALOG_EDIT_SYMBOLS_LIBID(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEARDROPS::DIALOG_GLOBAL_EDIT_TEARDROPS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMAGE_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MANAGE_REPOSITORIES::DIALOG_MANAGE_REPOSITORIES(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PCM::DIALOG_PCM(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_PCBNEW::DIALOG_PRINT_PCBNEW(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SELECT_3DMODEL::DIALOG_SELECT_3DMODEL(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SIM_MODEL< T_symbol, T_field >::DIALOG_SIM_MODEL(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), DIALOG_USER_DEFINED_SIGNALS::DIALOG_USER_DEFINED_SIGNALS(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), PAGED_DIALOG::finishInitialization(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_VIEW_DIALOG::NETLIST_VIEW_DIALOG(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SIM_COMMAND::onInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_COLOR_PICKER::TransferDataToWindow(), and DIALOG_BOARD_STATISTICS::TransferDataToWindow().

GetFields()

std::vector< std::pair< int, wxString > > DIALOG_CHOOSE_SYMBOL::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 151 of file dialog_choose_symbol.h.

References m_field_edits.

Referenced by SCH_BASE_FRAME::PickSymbolFromLibTree().

GetKeepSymbol()

bool DIALOG_CHOOSE_SYMBOL::GetKeepSymbol

(

)

const

To be called after this dialog returns from ShowModal()

Keeps a new copy of the symbol on the mouse cursor, allowing the user to rapidly place multiple copies of the same symbol on their schematic.

Returns

The value of the keep symbol preference checkbox.

Definition at line 574 of file dialog_choose_symbol.cpp.

References m_keepSymbol.

GetSelectedLibId()

LIB_ID DIALOG_CHOOSE_SYMBOL::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 369 of file dialog_choose_symbol.cpp.

References LIB_TREE::GetSelectedLibId(), and m_tree.

Referenced by SYMBOL_VIEWER_FRAME::OnSelectSymbol(), and SCH_BASE_FRAME::PickSymbolFromLibTree().

GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const

inlineinherited

Definition at line 46 of file kiway_holder.h.

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

GetUseAllUnits()

bool DIALOG_CHOOSE_SYMBOL::GetUseAllUnits

(

)

const

To be called after this dialog returns from ShowModal()

In the case of multi-unit symbols, this preferences asks to iterate through all units of the symbol, one per click.

Returns

The value of the dialog preference checkbox.

Definition at line 568 of file dialog_choose_symbol.cpp.

References m_useUnits.

GetUserUnits()

EDA_UNITS DIALOG_SHIM::GetUserUnits ( ) const

inlineinherited

Definition at line 121 of file dialog_shim.h.

References DIALOG_SHIM::m_units.

Referenced by ConstructRightPanel(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_SHIM::DIALOG_SHIM(), POSITION_RELATIVE_TOOL::PositionRelative(), DIALOG_POSITION_RELATIVE::updateAnchorInfo(), DIALOG_MOVE_EXACT::updateDialogControls(), DIALOG_POSITION_RELATIVE::updateDialogControls(), and DIALOG_DRC::writeReport().

HasKiway()

bool KIWAY_HOLDER::HasKiway ( ) const

inlineinherited

Safety check before asking for the Kiway reference.

Returns

true if kiway is non-null

Definition at line 63 of file kiway_holder.h.

References KIWAY_HOLDER::m_kiway.

Referenced by DIALOG_SHIM::~DIALOG_SHIM().

horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int  x ) const

protectedinherited

Convert an integer number of dialog units to pixels, horizontally.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 171 of file dialog_shim.cpp.

Referenced by DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL(), and DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE().

IsCtrl()

static bool DIALOG_SHIM::IsCtrl ( int  aChar, const wxKeyEvent &  e  )

inlinestaticinherited

Definition at line 128 of file dialog_shim.h.

IsExternalBrowserSelected()

bool DIALOG_CHOOSE_SYMBOL::IsExternalBrowserSelected ( ) const

inline

Returns

true if the user requested the symbol browser.

Definition at line 159 of file dialog_choose_symbol.h.

References m_external_browser_requested.

Referenced by SCH_BASE_FRAME::PickSymbolFromLibTree().

IsQuasiModal()

bool DIALOG_SHIM::IsQuasiModal ( ) const

inlineinherited

Definition at line 106 of file dialog_shim.h.

References DIALOG_SHIM::m_qmodal_showing.

Referenced by DIALOG_SHIM::EndQuasiModal(), EDA_3D_CONTROLLER::Main(), DIALOG_EXPORT_NETLIST::OnAddGenerator(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_SYMBOLS_LIBID::onCancel(), DIALOG_BOOK_REPORTER::OnClose(), DIALOG_NET_INSPECTOR::onClose(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_SHIM::OnCloseWindow(), DIALOG_EXPORT_NETLIST::OnDelGenerator(), PCB_ONE_LAYER_SELECTOR::OnLeftGridCellClick(), PCB_ONE_LAYER_SELECTOR::OnRightGridCellClick(), DIALOG_PUSH_PAD_PROPERTIES::PadPropertiesAccept(), and DIALOG_SHIM::~DIALOG_SHIM().

IsShiftCtrl()

static bool DIALOG_SHIM::IsShiftCtrl ( int  aChar, const wxKeyEvent &  e  )

inlinestaticinherited

Definition at line 134 of file dialog_shim.h.

Kiway()

KIWAY & KIWAY_HOLDER::Kiway ( ) const

inlineinherited

Return a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 53 of file kiway_holder.h.

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), IMPORT_PROJ_HELPER::AssociateFileWithProj(), CVPCB_MAINFRAME::BuildLibrariesListBox(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), BOARD_INSPECTION_TOOL::constructDiffPanel(), ConstructRightPanel(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), PGM_SINGLE_TOP::MacOpenFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), SAVE_AS_TRAVERSER::OnFile(), OnInitDialog(), KIGFX::WX_VIEW_CONTROLS::onMotion(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_FIELD_PROPERTIES::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), KIWAY_HOLDER::Prj(), SIMULATOR_CONTROL::Probe(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPluginManager(), EDA_BASE_FRAME::ShowPreferences(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), SIMULATOR_CONTROL::Tune(), BOARD_EDITOR_CONTROL::UpdateSchematicFromPCB(), DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint(), and DIALOG_SHIM::~DIALOG_SHIM().

OnButton()

void DIALOG_SHIM::OnButton ( wxCommandEvent &  aEvent )

privateinherited

Properly handle the default button events when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.

Definition at line 536 of file dialog_shim.cpp.

References DIALOG_SHIM::EndQuasiModal(), ignore_unused(), and DIALOG_SHIM::IsQuasiModal().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

OnCharHook()

void DIALOG_CHOOSE_SYMBOL::OnCharHook ( wxKeyEvent &  aEvt )

overrideprotectedvirtual

Reimplemented from DIALOG_SHIM.

Definition at line 347 of file dialog_choose_symbol.cpp.

References m_details.

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

onChildSetFocus()

void DIALOG_SHIM::onChildSetFocus ( wxFocusEvent &  aEvent )

privateinherited

Definition at line 574 of file dialog_shim.cpp.

References DIALOG_SHIM::m_beforeEditValues.

Referenced by DIALOG_SHIM::selectAllInTextCtrls().

OnCloseTimer()

void DIALOG_CHOOSE_SYMBOL::OnCloseTimer ( wxTimerEvent &  aEvent )

protected

Definition at line 383 of file dialog_choose_symbol.cpp.

References DblClickDelay, and m_dbl_click_timer.

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

OnCloseWindow()

void DIALOG_SHIM::OnCloseWindow ( wxCloseEvent &  aEvent )

privateinherited

Properly handle the wxCloseEvent when in the quasimodal mode when not calling EndQuasiModal which is possible with any dialog derived from DIALOG_SHIM.

Definition at line 523 of file dialog_shim.cpp.

References DIALOG_SHIM::EndQuasiModal(), and DIALOG_SHIM::IsQuasiModal().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

OnComponentPreselected()

void DIALOG_CHOOSE_SYMBOL::OnComponentPreselected ( wxCommandEvent &  aEvent )

protected

Definition at line 520 of file dialog_choose_symbol.cpp.

References _, SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), LIB_TREE::GetCurrentTreeNode(), FOOTPRINT_PREVIEW_WIDGET::IsInitialized(), LIB_ID::IsValid(), LIB_TREE_NODE::m_Footprint, m_fp_preview, LIB_TREE_NODE::m_LibId, m_symbol_preview, m_tree, LIB_TREE_NODE::m_Unit, PopulateFootprintSelector(), SYMBOL_PREVIEW_WIDGET::SetStatusText(), FOOTPRINT_PREVIEW_WIDGET::SetStatusText(), ShowFootprint(), and ShowFootprintFor().

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

OnComponentSelected()

void DIALOG_CHOOSE_SYMBOL::OnComponentSelected ( 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 547 of file dialog_choose_symbol.cpp.

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

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

OnFootprintSelected()

void DIALOG_CHOOSE_SYMBOL::OnFootprintSelected ( wxCommandEvent &  aEvent )

protected

Definition at line 505 of file dialog_choose_symbol.cpp.

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

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

OnInitDialog()

void DIALOG_CHOOSE_SYMBOL::OnInitDialog ( wxInitDialogEvent &  aEvent )

protected

Definition at line 334 of file dialog_choose_symbol.cpp.

References FOOTPRINT_PREVIEW_WIDGET::IsInitialized(), KIWAY_HOLDER::Kiway(), FOOTPRINT_SELECT_WIDGET::Load(), m_fp_preview, m_fp_sel_ctrl, KIWAY_HOLDER::Prj(), and FOOTPRINT_PREVIEW_WIDGET::SetStatusText().

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

OnModify()

void DIALOG_SHIM::OnModify ( )

inherited

Definition at line 410 of file dialog_shim.cpp.

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddFootprintFilter(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCheckBox(), DIALOG_SYMBOL_PROPERTIES::OnCheckBox(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCombobox(), DIALOG_LIB_SYMBOL_PROPERTIES::OnDeleteField(), DIALOG_SYMBOL_PROPERTIES::OnDeleteField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnDeleteFootprintFilter(), DIALOG_LIB_SYMBOL_PROPERTIES::OnEditFootprintFilter(), DIALOG_LIB_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_SYMBOL_PROPERTIES::OnEditSpiceModel(), DIALOG_LIB_SYMBOL_PROPERTIES::OnExcludeFromSimulation(), DIALOG_SYMBOL_PROPERTIES::OnExcludeFromSimulation(), DIALOG_LIB_SYMBOL_PROPERTIES::OnMoveDown(), DIALOG_SYMBOL_PROPERTIES::OnMoveDown(), DIALOG_LIB_SYMBOL_PROPERTIES::OnMoveUp(), DIALOG_SYMBOL_PROPERTIES::OnMoveUp(), DIALOG_SYMBOL_PROPERTIES::OnPinTableCellEdited(), DIALOG_LIB_SYMBOL_PROPERTIES::onPowerCheckBox(), DIALOG_LIB_SYMBOL_PROPERTIES::OnSpinCtrl(), DIALOG_LIB_SYMBOL_PROPERTIES::OnSpinCtrlText(), DIALOG_LIB_SYMBOL_PROPERTIES::OnText(), and DIALOG_SYMBOL_PROPERTIES::OnUnitChoice().

OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event )

inherited

Definition at line 390 of file dialog_shim.cpp.

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), KIPLATFORM::UI::ForceFocus(), DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and DIALOG_SHIM::selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

OnUseBrowser()

void DIALOG_CHOOSE_SYMBOL::OnUseBrowser ( wxCommandEvent &  aEvent )

protected

Definition at line 375 of file dialog_choose_symbol.cpp.

References m_external_browser_requested.

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

PopulateFootprintSelector()

void DIALOG_CHOOSE_SYMBOL::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 459 of file dialog_choose_symbol.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(), LIB_FIELD::GetFullText(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_SYMBOL::GetPins(), LIB_ID::IsValid(), m_fp_sel_ctrl, KIWAY_HOLDER::Prj(), FOOTPRINT_SELECT_WIDGET::SetDefaultFootprint(), FOOTPRINT_SELECT_WIDGET::UpdateList(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by OnComponentPreselected().

Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const

inherited

Return a reference to the PROJECT associated with this KIWAY.

Definition at line 36 of file kiway_holder.cpp.

References KIWAY_HOLDER::Kiway(), and KIWAY::Prj().

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_LIBRARY_MANAGER::addLibrary(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLibrariesListBox(), PCB_BASE_FRAME::canCloseWindow(), SIMULATOR_FRAME::canCloseWindow(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), EE_INSPECTION_TOOL::DiffSymbol(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), FIELDS_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), BOARD_EDITOR_CONTROL::ExportNetlist(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SYMBOL_EDITOR_CONTROL::ExportView(), BACK_ANNOTATE::FetchNetlistFromPCB(), DIALOG_TEXT_PROPERTIES::getContextualTextVars(), SIMULATOR_CONTROL::getDefaultFilename(), SIMULATOR_CONTROL::getDefaultPath(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), KICAD_MANAGER_FRAME::GetProjectFileName(), SCH_NAVIGATE_TOOL::HypertextCommand(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FIELDS_GRID_TABLE< T >::initGrid(), SIMULATOR_FRAME::initWorkbook(), EDA_DRAW_FRAME::LibraryFileBrowser(), PCB_BASE_FRAME::loadFootprint(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SIMULATOR_FRAME::LoadSettings(), EDA_BASE_FRAME::LoadWindowState(), SIMULATOR_FRAME::LoadWorkbook(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_IMPORT_NETLIST::onBrowseNetlistFiles(), WX_HTML_REPORT_PANEL::onBtnSaveToFile(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_SYMBOL_FIELDS_TABLE::OnExport(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_FIELDS_TABLE::OnOutputFileBrowseClicked(), DIALOG_SCHEMATIC_SETUP::onPageChanged(), DIALOG_BOARD_SETUP::onPageChanged(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), DIALOG_SCH_FIELD_PROPERTIES::onScintillaCharAdded(), PROPERTIES_FRAME::onScintillaCharAdded(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), PANEL_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), SYMBOL_EDITOR_CONTROL::PinLibrary(), FOOTPRINT_EDITOR_CONTROL::PinLibrary(), LIB_TREE_MODEL_ADAPTER::PinLibrary(), PopulateFootprintSelector(), EDA_DRAW_FRAME::PrintDrawingSheet(), KICAD_MANAGER_FRAME::PrintPrjInfo(), CVPCB_MAINFRAME::readNetListAndFpFiles(), APPEARANCE_CONTROLS::rebuildNets(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SIMULATOR_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), SIMULATOR_CONTROL::SaveWorkbook(), SIMULATOR_FRAME::SaveWorkbook(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), SCH_BASE_FRAME::SelectSymLibTable(), GERBVIEW_FRAME::SetPageSettings(), DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties(), EE_INSPECTION_TOOL::ShowDatasheet(), ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), APPEARANCE_CONTROLS::showNetclass(), SCH_EDITOR_CONTROL::SimProbe(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), EDA_3D_VIEWER_FRAME::takeScreenshot(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_EXPORT_NETLIST::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_ASSIGN_NETCLASS::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), SYMBOL_EDITOR_CONTROL::UnpinLibrary(), FOOTPRINT_EDITOR_CONTROL::UnpinLibrary(), LIB_TREE_MODEL_ADAPTER::UnpinLibrary(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), SIMULATOR_FRAME::updateTitle(), SIMULATOR_FRAME::UpdateTunerValue(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), EDA_3D_VIEWER_FRAME::~EDA_3D_VIEWER_FRAME(), and PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL().

resetSize()

void DIALOG_SHIM::resetSize ( )

protectedinherited

Clear the existing dialog size and position.

This will cause the dialog size to be clear so the next time the dialog is shown the sizers will layout the dialog accordingly. This useful when there are dialog windows that size changes due to layout dependency hidden controls.

Definition at line 289 of file dialog_shim.cpp.

References class_map, and DIALOG_SHIM::m_hash_key.

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

selectAllInTextCtrls()

void DIALOG_SHIM::selectAllInTextCtrls ( wxWindowList &  children )

privateinherited

Definition at line 324 of file dialog_shim.cpp.

References ignore_unused(), DIALOG_SHIM::m_beforeEditValues, minSize, DIALOG_SHIM::onChildSetFocus(), and DIALOG_SHIM::selectAllInTextCtrls().

Referenced by DIALOG_SHIM::OnPaint(), and DIALOG_SHIM::selectAllInTextCtrls().

SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow )

inlineinherited

Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.

Definition at line 97 of file dialog_shim.h.

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_GET_FOOTPRINT_BY_NAME::DIALOG_GET_FOOTPRINT_BY_NAME(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLUGIN_OPTIONS::DIALOG_PLUGIN_OPTIONS(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), DIALOG_COPPER_ZONE::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

SetKiway()

void KIWAY_HOLDER::SetKiway ( wxWindow *  aDest, KIWAY *  aKiway  )

inherited

It is only used for debugging, since "this" is not a wxWindow*.

"this" is a KIWAY_HOLDER mix-in.

Parameters

aDest	is the recipient of aKiway pointer.
aKiway	is often from a parent window or from KIFACE::CreateKiWindow().

Definition at line 43 of file kiway_holder.cpp.

References ignore_unused(), KIWAY_HOLDER::m_kiway, and name.

Referenced by PCB::IFACE::CreateKiWindow(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), and PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME().

SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint &  aNewPosition )

inherited

Force the position of the dialog to a new position.

Parameters

aNewPosition

is the new forced position

Definition at line 192 of file dialog_shim.cpp.

References class_map, and DIALOG_SHIM::m_hash_key.

Referenced by PCB_BASE_FRAME::SelectOneLayer().

setSizeInDU()

void DIALOG_SHIM::setSizeInDU ( int  x, int  y  )

protectedinherited

Set the dialog to the given dimensions in "dialog units".

These are units equivalent to 4* the average character width and 8* the average character height, allowing a dialog to be sized in a way that scales it with the system font.

Definition at line 164 of file dialog_shim.cpp.

Referenced by HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

SetupStandardButtons()

void DIALOG_SHIM::SetupStandardButtons ( std::map< int, wxString >  aLabels = {} )

inherited

Definition at line 732 of file dialog_shim.cpp.

References recursiveDescent().

Referenced by CONVERT_SETTINGS_DIALOG::CONVERT_SETTINGS_DIALOG(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_ASSIGN_NETCLASS::DIALOG_ASSIGN_NETCLASS(), DIALOG_BOM::DIALOG_BOM(), DIALOG_BOOK_REPORTER::DIALOG_BOOK_REPORTER(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL(), DIALOG_CLEANUP_GRAPHICS::DIALOG_CLEANUP_GRAPHICS(), DIALOG_COLOR_PICKER::DIALOG_COLOR_PICKER(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_CREATE_ARRAY::DIALOG_CREATE_ARRAY(), DIALOG_DATABASE_LIB_SETTINGS::DIALOG_DATABASE_LIB_SETTINGS(), DIALOG_DIELECTRIC_MATERIAL::DIALOG_DIELECTRIC_MATERIAL(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_NETLIST::DIALOG_EXPORT_NETLIST(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FILTER_SELECTION::DIALOG_FILTER_SELECTION(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_GET_FOOTPRINT_BY_NAME::DIALOG_GET_FOOTPRINT_BY_NAME(), DIALOG_GLOBAL_DELETION::DIALOG_GLOBAL_DELETION(), DIALOG_GLOBAL_EDIT_TEARDROPS::DIALOG_GLOBAL_EDIT_TEARDROPS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IBIS_PARSER_REPORTER::DIALOG_IBIS_PARSER_REPORTER(), DIALOG_IMAGE_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_IMPORT_NETLIST::DIALOG_IMPORT_NETLIST(), DIALOG_IMPORT_SETTINGS::DIALOG_IMPORT_SETTINGS(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_LIB_EDIT_PIN_TABLE::DIALOG_LIB_EDIT_PIN_TABLE(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIB_TEXT_PROPERTIES::DIALOG_LIB_TEXT_PROPERTIES(), DIALOG_LIB_TEXTBOX_PROPERTIES::DIALOG_LIB_TEXTBOX_PROPERTIES(), DIALOG_LINE_PROPERTIES::DIALOG_LINE_PROPERTIES(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MIGRATE_SETTINGS::DIALOG_MIGRATE_SETTINGS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PRIMITIVES_TRANSFORM::DIALOG_PAD_PRIMITIVES_TRANSFORM(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_PCM::DIALOG_PCM(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT::DIALOG_PLOT(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_PLUGIN_OPTIONS::DIALOG_PLUGIN_OPTIONS(), DIALOG_PNS_DIFF_PAIR_DIMENSIONS::DIALOG_PNS_DIFF_PAIR_DIMENSIONS(), DIALOG_PNS_LENGTH_TUNING_SETTINGS::DIALOG_PNS_LENGTH_TUNING_SETTINGS(), DIALOG_PNS_SETTINGS::DIALOG_PNS_SETTINGS(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCH_IMPORT_SETTINGS::DIALOG_SCH_IMPORT_SETTINGS(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SIM_COMMAND::DIALOG_SIM_COMMAND(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), DIALOG_USER_DEFINED_SIGNALS::DIALOG_USER_DEFINED_SIGNALS(), DIALOG_WIRE_BUS_PROPERTIES::DIALOG_WIRE_BUS_PROPERTIES(), EDA_LIST_DIALOG::EDA_LIST_DIALOG(), EDA_REORDERABLE_LIST_DIALOG::EDA_REORDERABLE_LIST_DIALOG(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), DIALOG_FIELD_PROPERTIES::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG_ADD_GENERATOR::NETLIST_DIALOG_ADD_GENERATOR(), PAGED_DIALOG::PAGED_DIALOG(), DIALOG_CLEANUP_TRACKS_AND_VIAS::setupOKButtonLabel(), WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG(), and WX_UNIT_ENTRY_DIALOG::WX_UNIT_ENTRY_DIALOG().

Show()

bool DIALOG_SHIM::Show ( bool  show )

overrideinherited

Definition at line 221 of file dialog_shim.cpp.

References class_map, DIALOG_SHIM::m_hash_key, DIALOG_SHIM::m_initialSize, and DIALOG_SHIM::m_useCalculatedSize.

Referenced by FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), FOOTPRINT_EDITOR_CONTROL::CrossProbe(), EE_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), BOARD_INSPECTION_TOOL::DiffFootprint(), EE_INSPECTION_TOOL::DiffSymbol(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), BOARD_INSPECTION_TOOL::ListNets(), EE_INSPECTION_TOOL::NextMarker(), DRC_TOOL::NextMarker(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), EE_INSPECTION_TOOL::PrevMarker(), DRC_TOOL::PrevMarker(), CVPCB_MAINFRAME::readNetListAndFpFiles(), DIALOG_PAD_PROPERTIES::Show(), EDA_VIEW_SWITCHER::Show(), EDA_LIST_DIALOG::Show(), DIALOG_FIND::Show(), DRC_TOOL::ShowDRCDialog(), EE_INSPECTION_TOOL::ShowERCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

ShowFootprint()

void DIALOG_CHOOSE_SYMBOL::ShowFootprint ( const wxString &  aFootprint )

protected

Display the given footprint by name.

Definition at line 433 of file dialog_choose_symbol.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 OnComponentPreselected(), OnFootprintSelected(), and ShowFootprintFor().

ShowFootprintFor()

void DIALOG_CHOOSE_SYMBOL::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 404 of file dialog_choose_symbol.cpp.

References _, FOOTPRINT_FIELD, LIB_SYMBOL::GetFieldById(), LIB_FIELD::GetFullText(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), FOOTPRINT_PREVIEW_WIDGET::IsInitialized(), m_fp_preview, KIWAY_HOLDER::Prj(), ShowFootprint(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by OnComponentPreselected().

ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )

inherited

Definition at line 440 of file dialog_shim.cpp.

References DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, KIPLATFORM::UI::ReparentQuasiModal(), DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by SCH_EDIT_TOOL::ChangeSymbols(), S3D::Configure3DPaths(), MICROWAVE_TOOL::createFootprint(), PCB::IFACE::CreateKiWindow(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTeardrops(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), SIMULATOR_CONTROL::EditUserDefinedSignals(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditSymbolsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), DRAWING_TOOL::PlaceText(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), PCB_BASE_EDIT_FRAME::ShowTextBoxPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog(), and PCB_EDIT_FRAME::ToPlotter().

vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int  y ) const

protectedinherited

Convert an integer number of dialog units to pixels, vertically.

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 178 of file dialog_shim.cpp.

Referenced by DIALOG_CHOOSE_SYMBOL(), and DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE().

Member Data Documentation

DblClickDelay

constexpr int DIALOG_CHOOSE_SYMBOL::DblClickDelay = 100

staticconstexprprotected

Definition at line 165 of file dialog_choose_symbol.h.

Referenced by OnCloseTimer(), and OnComponentSelected().

g_Mutex

std::mutex DIALOG_CHOOSE_SYMBOL::g_Mutex

static

Definition at line 203 of file dialog_choose_symbol.h.

Referenced by SYMBOL_VIEWER_FRAME::OnSelectSymbol(), and SCH_BASE_FRAME::PickSymbolFromLibTree().

g_powerSearchString

wxString DIALOG_CHOOSE_SYMBOL::g_powerSearchString

staticprotected

Definition at line 207 of file dialog_choose_symbol.h.

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

g_symbolSearchString

wxString DIALOG_CHOOSE_SYMBOL::g_symbolSearchString

staticprotected

Definition at line 206 of file dialog_choose_symbol.h.

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

m_allow_field_edits

bool DIALOG_CHOOSE_SYMBOL::m_allow_field_edits

protected

Definition at line 225 of file dialog_choose_symbol.h.

Referenced by ConstructRightPanel().

m_beforeEditValues

std::map<wxWindow*, wxString> DIALOG_SHIM::m_beforeEditValues

protectedinherited

Definition at line 229 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook(), DIALOG_SHIM::onChildSetFocus(), and DIALOG_SHIM::selectAllInTextCtrls().

m_browser_button

wxButton* DIALOG_CHOOSE_SYMBOL::m_browser_button

protected

Definition at line 211 of file dialog_choose_symbol.h.

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

m_dbl_click_timer

wxTimer* DIALOG_CHOOSE_SYMBOL::m_dbl_click_timer

protected

Definition at line 209 of file dialog_choose_symbol.h.

Referenced by DIALOG_CHOOSE_SYMBOL(), OnCloseTimer(), OnComponentSelected(), and ~DIALOG_CHOOSE_SYMBOL().

m_deMorganConvert

int DIALOG_CHOOSE_SYMBOL::m_deMorganConvert

protected

Definition at line 224 of file dialog_choose_symbol.h.

m_details

HTML_WINDOW* DIALOG_CHOOSE_SYMBOL::m_details

protected

Definition at line 220 of file dialog_choose_symbol.h.

Referenced by DIALOG_CHOOSE_SYMBOL(), OnCharHook(), and ~DIALOG_CHOOSE_SYMBOL().

m_external_browser_requested

bool DIALOG_CHOOSE_SYMBOL::m_external_browser_requested

protected

Definition at line 227 of file dialog_choose_symbol.h.

Referenced by IsExternalBrowserSelected(), and OnUseBrowser().

m_field_edits

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

protected

Definition at line 230 of file dialog_choose_symbol.h.

Referenced by GetFields(), and OnFootprintSelected().

m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent

protectedinherited

Definition at line 213 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

m_fp_override

wxString DIALOG_CHOOSE_SYMBOL::m_fp_override

protected

Definition at line 228 of file dialog_choose_symbol.h.

Referenced by OnFootprintSelected().

m_fp_preview

FOOTPRINT_PREVIEW_WIDGET* DIALOG_CHOOSE_SYMBOL::m_fp_preview

protected

Definition at line 216 of file dialog_choose_symbol.h.

Referenced by ConstructRightPanel(), OnComponentPreselected(), OnInitDialog(), ShowFootprint(), and ShowFootprintFor().

m_fp_sel_ctrl

FOOTPRINT_SELECT_WIDGET* DIALOG_CHOOSE_SYMBOL::m_fp_sel_ctrl

protected

Definition at line 215 of file dialog_choose_symbol.h.

Referenced by ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL(), OnInitDialog(), PopulateFootprintSelector(), and ~DIALOG_CHOOSE_SYMBOL().

m_hash_key

std::string DIALOG_SHIM::m_hash_key

protectedinherited

Definition at line 204 of file dialog_shim.h.

Referenced by DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), EDA_LIST_DIALOG::EDA_LIST_DIALOG(), EDA_REORDERABLE_LIST_DIALOG::EDA_REORDERABLE_LIST_DIALOG(), PAGED_DIALOG::PAGED_DIALOG(), DIALOG_SHIM::resetSize(), DIALOG_SHIM::SetPosition(), and DIALOG_SHIM::Show().

m_hsplitter

wxSplitterWindow* DIALOG_CHOOSE_SYMBOL::m_hsplitter

protected

Definition at line 212 of file dialog_choose_symbol.h.

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

m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget

protectedinherited

Definition at line 214 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint(), and DIALOG_SHIM::SetInitialFocus().

m_initialSize

wxSize DIALOG_SHIM::m_initialSize

protectedinherited

Definition at line 226 of file dialog_shim.h.

Referenced by DIALOG_SHIM::Show().

m_keepSymbol

wxCheckBox* DIALOG_CHOOSE_SYMBOL::m_keepSymbol

protected

Definition at line 217 of file dialog_choose_symbol.h.

Referenced by DIALOG_CHOOSE_SYMBOL(), GetKeepSymbol(), and ~DIALOG_CHOOSE_SYMBOL().

m_kiway

KIWAY* KIWAY_HOLDER::m_kiway

privateinherited

Definition at line 84 of file kiway_holder.h.

Referenced by KIWAY_HOLDER::HasKiway(), KIWAY_HOLDER::Kiway(), and KIWAY_HOLDER::SetKiway().

m_parent

SCH_BASE_FRAME* DIALOG_CHOOSE_SYMBOL::m_parent

protected

Definition at line 222 of file dialog_choose_symbol.h.

Referenced by ConstructRightPanel().

m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame

protectedinherited

Definition at line 221 of file dialog_shim.h.

Referenced by DIALOG_ANNOTATE::InitValues(), DIALOG_SHIM::OnCharHook(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), and DIALOG_ANNOTATE::~DIALOG_ANNOTATE().

m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop

protectedinherited

Definition at line 216 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

m_qmodal_parent_disabler

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler

protectedinherited

Definition at line 219 of file dialog_shim.h.

Referenced by DIALOG_SHIM::EndQuasiModal(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_SHIM::~DIALOG_SHIM().

m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing

protectedinherited

Definition at line 218 of file dialog_shim.h.

Referenced by DIALOG_SHIM::IsQuasiModal(), and DIALOG_SHIM::ShowQuasiModal().

m_show_footprints

bool DIALOG_CHOOSE_SYMBOL::m_show_footprints

protected

Definition at line 226 of file dialog_choose_symbol.h.

Referenced by ConstructRightPanel(), and DIALOG_CHOOSE_SYMBOL().

m_showPower

bool DIALOG_CHOOSE_SYMBOL::m_showPower

protected

Definition at line 223 of file dialog_choose_symbol.h.

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

m_symbol_preview

SYMBOL_PREVIEW_WIDGET* DIALOG_CHOOSE_SYMBOL::m_symbol_preview

protected

Definition at line 210 of file dialog_choose_symbol.h.

Referenced by ConstructRightPanel(), and OnComponentPreselected().

m_tabOrder

std::vector<wxWindow*> DIALOG_SHIM::m_tabOrder

protectedinherited

Definition at line 223 of file dialog_shim.h.

Referenced by DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), and DIALOG_SHIM::OnCharHook().

m_tree

LIB_TREE* DIALOG_CHOOSE_SYMBOL::m_tree

protected

Definition at line 219 of file dialog_choose_symbol.h.

Referenced by DIALOG_CHOOSE_SYMBOL(), GetSelectedLibId(), OnComponentPreselected(), OnComponentSelected(), and ~DIALOG_CHOOSE_SYMBOL().

m_type

HOLDER_TYPE KIWAY_HOLDER::m_type

privateinherited

Definition at line 85 of file kiway_holder.h.

Referenced by KIWAY_HOLDER::GetType(), and SCHEMATIC_COMMIT::pushSchEdit().

m_units

EDA_UNITS DIALOG_SHIM::m_units

protectedinherited

Definition at line 203 of file dialog_shim.h.

Referenced by DIALOG_PAD_PROPERTIES::displayPrimitivesList(), DIALOG_SHIM::GetUserUnits(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), and DIALOG_NET_INSPECTOR::onUnitsChanged().

m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize

protectedinherited

Definition at line 208 of file dialog_shim.h.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_ONE_LAYER_SELECTOR::PCB_ONE_LAYER_SELECTOR(), and DIALOG_SHIM::Show().

m_useUnits

wxCheckBox* DIALOG_CHOOSE_SYMBOL::m_useUnits

protected

Definition at line 218 of file dialog_choose_symbol.h.

Referenced by DIALOG_CHOOSE_SYMBOL(), GetUseAllUnits(), and ~DIALOG_CHOOSE_SYMBOL().

m_vsplitter

wxSplitterWindow* DIALOG_CHOOSE_SYMBOL::m_vsplitter

protected

Definition at line 213 of file dialog_choose_symbol.h.

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

---

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

• dialog_choose_symbol.h
• dialog_choose_symbol.cpp