KiCad PCB EDA Suite
DIALOG_CHOOSE_COMPONENT Class Reference

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

#include <dialog_choose_component.h>

Inheritance diagram for DIALOG_CHOOSE_COMPONENT:
DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 DIALOG_CHOOSE_COMPONENT (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 component. More...
 
 ~DIALOG_CHOOSE_COMPONENT ()
 
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
 Function IsExternalBrowserSelected. More...
 
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)
 
EDA_UNITS GetUserUnits () const
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. 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 (LIB_ID const &aLibId)
 Look up the footprint for a given symbol specified in the LIB_ID and display it. More...
 
void ShowFootprint (wxString const &aFootprint)
 Display the given footprint by name. More...
 
void PopulateFootprintSelector (LIB_ID const &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_WIDGETm_symbol_preview
 
wxButton * m_browser_button
 
wxSplitterWindow * m_hsplitter
 
wxSplitterWindow * m_vsplitter
 
FOOTPRINT_SELECT_WIDGETm_fp_sel_ctrl
 
FOOTPRINT_PREVIEW_WIDGETm_fp_preview
 
wxCheckBox * m_keepSymbol
 
wxCheckBox * m_useUnits
 
LIB_TREEm_tree
 
wxHtmlWindow * m_details
 
SCH_BASE_FRAMEm_parent
 
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_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
EDA_BASE_FRAMEm_parentFrame
 
std::vector< wxWindow * > m_tabOrder
 

Static Protected Attributes

static constexpr int DblClickDelay = 100
 

Detailed Description

Dialog class to select a component from the libraries.

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

  • Adapter: CMP_TREE_MODEL_ADAPTER in common/cmp_tree_model_adapter.h
  • Model: CMP_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_COMPONENT 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_component.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_CHOOSE_COMPONENT()

DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT ( 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 component.

Parameters
aParenta SCH_BASE_FRAME parent window.
aTitleDialog title.
aAdapterSYMBOL_TREE_MODEL_ADAPTER::PTR. See CMP_TREE_MODEL_ADAPTER for documentation.
aDeMorganConvertpreferred deMorgan conversion (TODO: should happen in dialog)
aAllowFieldEditsif false, all functions that allow the user to edit fields (currently just footprint selection) will not be available.
aShowFootprintsif false, all footprint preview and selection features are disabled. This forces aAllowFieldEdits false too.
aAllowBrowsershow a Select with Browser button

Definition at line 50 of file dialog_choose_component.cpp.

54  : DIALOG_SHIM( aParent, wxID_ANY, aTitle, wxDefaultPosition, wxDefaultSize,
55  wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ),
56  m_symbol_preview( nullptr ),
57  m_browser_button( nullptr ),
58  m_hsplitter( nullptr ),
59  m_vsplitter( nullptr ),
60  m_fp_sel_ctrl( nullptr ),
61  m_fp_preview( nullptr ),
62  m_keepSymbol( nullptr ),
63  m_useUnits( nullptr ),
64  m_tree( nullptr ),
65  m_details( nullptr ),
66  m_parent( aParent ),
67  m_deMorganConvert( aDeMorganConvert >= 0 ? aDeMorganConvert : 0 ),
68  m_allow_field_edits( aAllowFieldEdits ),
69  m_show_footprints( aShowFootprints ),
71 {
72  // Never show footprints in power symbol mode
73  if( aAdapter->GetFilter() == SYMBOL_TREE_MODEL_ADAPTER::CMP_FILTER_POWER )
74  m_show_footprints = false;
75 
76  auto sizer = new wxBoxSizer( wxVERTICAL );
77 
78  // Use a slightly different layout, with a details pane spanning the entire window,
79  // if we're not showing footprints.
80  if( m_show_footprints )
81  {
82  m_hsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
83  wxSP_LIVE_UPDATE );
84 
85  //Avoid the splitter window being assigned as the Parent to additional windows
86  m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
87 
88  sizer->Add( m_hsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
89  }
90  else
91  {
92  m_vsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
93  wxSP_LIVE_UPDATE );
94 
95  m_hsplitter = new wxSplitterWindow( m_vsplitter, wxID_ANY, wxDefaultPosition, wxDefaultSize,
96  wxSP_LIVE_UPDATE );
97 
98  //Avoid the splitter window being assigned as the Parent to additional windows
99  m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
100 
101  auto detailsPanel = new wxPanel( m_vsplitter );
102  auto detailsSizer = new wxBoxSizer( wxVERTICAL );
103  detailsPanel->SetSizer( detailsSizer );
104 
105  m_details = new wxHtmlWindow( detailsPanel, wxID_ANY, wxDefaultPosition, wxDefaultSize,
106  wxHW_SCROLLBAR_AUTO );
107  detailsSizer->Add( m_details, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
108  detailsPanel->Layout();
109  detailsSizer->Fit( detailsPanel );
110 
111  m_vsplitter->SetSashGravity( 0.5 );
112  m_vsplitter->SetMinimumPaneSize( 20 );
113  m_vsplitter->SplitHorizontally( m_hsplitter, detailsPanel );
114 
115  sizer->Add( m_vsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
116  }
117 
118  m_tree = new LIB_TREE( m_hsplitter, Prj().SchSymbolLibTable(), aAdapter,
120 
121  m_hsplitter->SetSashGravity( 0.8 );
122  m_hsplitter->SetMinimumPaneSize( 20 );
123  m_hsplitter->SplitVertically( m_tree, ConstructRightPanel( m_hsplitter ) );
124 
125  m_dbl_click_timer = new wxTimer( this );
126 
127  auto buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
128 
129  if( aAllowBrowser )
130  {
131  m_browser_button = new wxButton( this, wxID_ANY, _( "Select with Browser" ) );
132  buttonsSizer->Add( m_browser_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
133  }
134 
135  auto sdbSizer = new wxStdDialogButtonSizer();
136  auto okButton = new wxButton( this, wxID_OK );
137  auto cancelButton = new wxButton( this, wxID_CANCEL );
138  sdbSizer->AddButton( okButton );
139  sdbSizer->AddButton( cancelButton );
140  sdbSizer->Realize();
141 
142  buttonsSizer->Add( sdbSizer, 1, wxALL, 5 );
143 
144  sizer->Add( buttonsSizer, 0, wxEXPAND | wxLEFT, 5 );
145  SetSizer( sizer );
146 
147  Layout();
148 
149  EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
150 
151  if( cfg )
152  {
154 
155  // We specify the width of the right window (m_symbol_view_panel), because specify
156  // the width of the left window does not work as expected when SetSashGravity() is called
157  m_hsplitter->SetSashPosition( panelCfg.sash_pos_h > 0 ? panelCfg.sash_pos_h :
158  horizPixelsFromDU( 220 ) );
159 
160  if( m_vsplitter )
161  m_vsplitter->SetSashPosition( panelCfg.sash_pos_v > 0 ? panelCfg.sash_pos_v :
162  vertPixelsFromDU( 230 ) );
163 
164  wxSize dlgSize( panelCfg.width > 0 ? panelCfg.width : horizPixelsFromDU( 390 ),
165  panelCfg.height > 0 ? panelCfg.height : vertPixelsFromDU( 300 ) );
166  SetSize( dlgSize );
167  }
168 
170  okButton->SetDefault();
171 
172  Bind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_COMPONENT::OnInitDialog, this );
173  Bind( wxEVT_TIMER, &DIALOG_CHOOSE_COMPONENT::OnCloseTimer, this, m_dbl_click_timer->GetId() );
174  Bind( COMPONENT_PRESELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentPreselected, this );
175  Bind( COMPONENT_SELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentSelected, this );
176 
177  if( m_browser_button )
178  m_browser_button->Bind( wxEVT_COMMAND_BUTTON_CLICKED,
180 
181  if( m_fp_sel_ctrl )
182  m_fp_sel_ctrl->Bind( EVT_FOOTPRINT_SELECTED,
184 
185  if( m_details )
186  m_details->Connect( wxEVT_CHAR_HOOK,
187  wxKeyEventHandler( DIALOG_CHOOSE_COMPONENT::OnCharHook ),
188  NULL, this );
189 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
void OnFootprintSelected(wxCommandEvent &aEvent)
SYMBOL_PREVIEW_WIDGET * m_symbol_preview
int horizPixelsFromDU(int x) const
Convert an integer number of dialog units to pixels, horizontally.
Item needs to be redrawn.
Definition: view_item.h:63
PANEL_SYM_CHOOSER m_SymChooserPanel
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:114
void OnComponentPreselected(wxCommandEvent &aEvent)
DIALOG_SHIM(wxWindow *aParent, wxWindowID id, const wxString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_FRAME_STYLE|wxRESIZE_BORDER, const wxString &name=wxDialogNameStr)
Definition: dialog_shim.cpp:76
void OnInitDialog(wxInitDialogEvent &aEvent)
#define NULL
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
void OnCloseTimer(wxTimerEvent &aEvent)
wxPanel * ConstructRightPanel(wxWindow *aParent)
void OnUseBrowser(wxCommandEvent &aEvent)
void OnCharHook(wxKeyEvent &aEvt) override
#define _(s)
Definition: 3d_actions.cpp:33
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
int vertPixelsFromDU(int y) const
Convert an integer number of dialog units to pixels, vertically.
void OnComponentSelected(wxCommandEvent &aEvent)
Handle the selection of an item.
Widget displaying a tree of components with optional search text control and description panel.
Definition: lib_tree.h:42

References _, KIGFX::ALL, LIB_TREE_MODEL_ADAPTER::CMP_FILTER_POWER, ConstructRightPanel(), 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_show_footprints, EESCHEMA_SETTINGS::m_SymChooserPanel, m_tree, m_vsplitter, NULL, 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(), DIALOG_SHIM::vertPixelsFromDU(), and EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::width.

◆ ~DIALOG_CHOOSE_COMPONENT()

DIALOG_CHOOSE_COMPONENT::~DIALOG_CHOOSE_COMPONENT ( )

Definition at line 192 of file dialog_choose_component.cpp.

193 {
194  Unbind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_COMPONENT::OnInitDialog, this );
195  Unbind( wxEVT_TIMER, &DIALOG_CHOOSE_COMPONENT::OnCloseTimer, this );
196  Unbind( COMPONENT_PRESELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentPreselected, this );
197  Unbind( COMPONENT_SELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentSelected, this );
198 
199  if( m_browser_button )
200  m_browser_button->Unbind( wxEVT_COMMAND_BUTTON_CLICKED,
202 
203  if( m_fp_sel_ctrl )
204  m_fp_sel_ctrl->Unbind( EVT_FOOTPRINT_SELECTED,
206 
207  if( m_details )
208  m_details->Disconnect( wxEVT_CHAR_HOOK,
209  wxKeyEventHandler( DIALOG_CHOOSE_COMPONENT::OnCharHook ),
210  NULL, this );
211 
212  // I am not sure the following two lines are necessary, but they will not hurt anyone
213  m_dbl_click_timer->Stop();
214  delete m_dbl_click_timer;
215 
216  auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
217 
218  wxCHECK( cfg, /*void*/ );
219 
220  cfg->m_SymChooserPanel.width = GetSize().x;
221  cfg->m_SymChooserPanel.height = GetSize().y;
222 
223  cfg->m_SymChooserPanel.keep_symbol = m_keepSymbol->GetValue();
224  cfg->m_SymChooserPanel.place_all_units = m_useUnits->GetValue();
225 
226  cfg->m_SymChooserPanel.sash_pos_h = m_hsplitter->GetSashPosition();
227 
228  if( m_vsplitter )
229  cfg->m_SymChooserPanel.sash_pos_v = m_vsplitter->GetSashPosition();
230 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
void OnFootprintSelected(wxCommandEvent &aEvent)
void OnComponentPreselected(wxCommandEvent &aEvent)
void OnInitDialog(wxInitDialogEvent &aEvent)
#define NULL
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
void OnCloseTimer(wxTimerEvent &aEvent)
void OnUseBrowser(wxCommandEvent &aEvent)
void OnCharHook(wxKeyEvent &aEvt) override
void OnComponentSelected(wxCommandEvent &aEvent)
Handle the selection of an item.

References Kiface(), m_browser_button, m_dbl_click_timer, m_details, m_fp_sel_ctrl, m_hsplitter, m_keepSymbol, m_useUnits, m_vsplitter, NULL, OnCharHook(), OnCloseTimer(), OnComponentPreselected(), OnComponentSelected(), OnFootprintSelected(), OnInitDialog(), and OnUseBrowser().

Member Function Documentation

◆ ConstructRightPanel()

wxPanel * DIALOG_CHOOSE_COMPONENT::ConstructRightPanel ( wxWindow *  aParent)
protected

Definition at line 233 of file dialog_choose_component.cpp.

234 {
235  wxPanel* panel = new wxPanel( aParent );
236  wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
238 
239  m_symbol_preview = new SYMBOL_PREVIEW_WIDGET( panel, Kiway(), backend );
240  m_symbol_preview->SetLayoutDirection( wxLayout_LeftToRight );
241 
242  if( m_show_footprints )
243  {
245 
246  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxTOP | wxBOTTOM | wxRIGHT, 5 );
247 
248  if ( fp_list )
249  {
250  if( m_allow_field_edits )
251  m_fp_sel_ctrl = new FOOTPRINT_SELECT_WIDGET( m_parent, panel, fp_list, true );
252 
253  m_fp_preview = new FOOTPRINT_PREVIEW_WIDGET( panel, Kiway() );
254  }
255 
256  if( m_fp_sel_ctrl )
257  sizer->Add( m_fp_sel_ctrl, 0, wxEXPAND | wxBOTTOM | wxTOP | wxRIGHT, 5 );
258 
259  if( m_fp_preview )
260  sizer->Add( m_fp_preview, 1, wxEXPAND | wxBOTTOM | wxRIGHT, 5 );
261  }
262  else
263  {
264  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxTOP | wxRIGHT, 5 );
265  }
266 
267  auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
268 
269  m_keepSymbol = new wxCheckBox( panel, 1000, _("Multi-Symbol Placement"), wxDefaultPosition,
270  wxDefaultSize, wxALIGN_RIGHT );
271  m_keepSymbol->SetValue( cfg ? cfg->m_SymChooserPanel.keep_symbol : true );
272  m_keepSymbol->SetToolTip( _( "Place multiple copies of the symbol." ) );
273 
274  m_useUnits = new wxCheckBox( panel, 1000, _("Place all units"), wxDefaultPosition,
275  wxDefaultSize, wxALIGN_RIGHT );
276  m_useUnits->SetValue( cfg ? cfg->m_SymChooserPanel.place_all_units : true );
277  m_useUnits->SetToolTip( _( "Sequentially place all units of the symbol." ) );
278 
279  auto fgSizer = new wxFlexGridSizer( 0, 2, 0, 1 );
280  fgSizer->AddGrowableCol( 0 );
281  fgSizer->SetFlexibleDirection( wxBOTH );
282  fgSizer->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_SPECIFIED );
283 
284  fgSizer->Add( 0, 0, 1, wxEXPAND );
285  fgSizer->Add( m_keepSymbol, 0, wxALIGN_CENTER_VERTICAL|wxALIGN_RIGHT|wxBOTTOM|wxRIGHT|wxLEFT, 5 );
286  fgSizer->Add( 0, 0, 1, wxEXPAND );
287  fgSizer->Add( m_useUnits, 0, wxALIGN_CENTER_VERTICAL|wxALIGN_RIGHT|wxBOTTOM|wxRIGHT|wxLEFT, 5 );
288 
289  sizer->Add( fgSizer, 0, wxALL | wxEXPAND, 5 );
290  panel->SetSizer( sizer );
291  panel->Layout();
292  sizer->Fit( panel );
293 
294  return panel;
295 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
SYMBOL_PREVIEW_WIDGET * m_symbol_preview
static FOOTPRINT_LIST * GetInstance(KIWAY &aKiway)
Factory function to return a FOOTPRINT_LIST via Kiway.
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Holds a list of FOOTPRINT_INFO objects, along with a list of IO_ERRORs or PARSE_ERRORs that were thro...
#define _(s)
Definition: 3d_actions.cpp:33
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
GAL_TYPE GetBackend() const
Function GetBackend Returns the type of backend currently used by GAL canvas.

References _, EDA_DRAW_PANEL_GAL::GetBackend(), SCH_BASE_FRAME::GetCanvas(), FOOTPRINT_LIST::GetInstance(), Kiface(), KIWAY_HOLDER::Kiway(), m_allow_field_edits, m_fp_preview, m_fp_sel_ctrl, m_keepSymbol, m_parent, m_show_footprints, m_symbol_preview, and m_useUnits.

Referenced by DIALOG_CHOOSE_COMPONENT().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 269 of file dialog_shim.cpp.

270 {
271  // so we can do logging of this state change:
272  return wxDialog::Enable( enable );
273 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 406 of file dialog_shim.cpp.

407 {
408  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
409  // handle validation in the same way as other dialogs.
410  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
411  return;
412 
413  SetReturnCode( retCode );
414 
415  if( !IsQuasiModal() )
416  {
417  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
418  "wasn't called" );
419  return;
420  }
421 
422  if( m_qmodal_loop )
423  {
424  if( m_qmodal_loop->IsRunning() )
425  m_qmodal_loop->Exit( 0 );
426  else
427  m_qmodal_loop->ScheduleExit( 0 );
428 
430  }
431 
434 
435  Show( false );
436 }
bool IsQuasiModal() const
Definition: dialog_shim.h:123
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:199
#define NULL
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:202

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), OnUseBrowser(), 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 147 of file dialog_shim.cpp.

148 {
149  // must be called from the constructor of derived classes,
150  // when all widgets are initialized, and therefore their size fixed
151 
152  // SetSizeHints fixes the minimal size of sizers in the dialog
153  // (SetSizeHints calls Fit(), so no need to call it)
154  GetSizer()->SetSizeHints( this );
155 }

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), 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_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), 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_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NETLIST::DIALOG_NETLIST(), 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_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), 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_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_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(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetFields()

std::vector<std::pair<int, wxString> > DIALOG_CHOOSE_COMPONENT::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 149 of file dialog_choose_component.h.

150  {
151  return m_field_edits;
152  }
std::vector< std::pair< int, wxString > > m_field_edits

References m_field_edits.

Referenced by SCH_BASE_FRAME::PickSymbolFromLibTree().

◆ GetKeepSymbol()

bool DIALOG_CHOOSE_COMPONENT::GetKeepSymbol ( ) const
inline

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 143 of file dialog_choose_component.h.

143 { return m_keepSymbol->GetValue(); }

References m_keepSymbol.

◆ GetSelectedLibId()

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

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

For multi-unit components, if the user selects the component 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
aUnitif not NULL, the selected unit is filled in here.
Returns
the LIB_ID of the symbol that has been selected.

Definition at line 331 of file dialog_choose_component.cpp.

332 {
333  return m_tree->GetSelectedLibId( aUnit );
334 }
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit components, if the user selects the component itself rather than picking an individual...
Definition: lib_tree.cpp:151

References LIB_TREE::GetSelectedLibId(), and m_tree.

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

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 49 of file kiway_holder.h.

49 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:82

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUseAllUnits()

bool DIALOG_CHOOSE_COMPONENT::GetUseAllUnits ( ) const
inline

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 133 of file dialog_choose_component.h.

133 { return m_useUnits->GetValue(); }

References m_useUnits.

◆ GetUserUnits()

◆ 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 165 of file dialog_shim.cpp.

166 {
167  wxSize sz( x, 0 );
168  return ConvertDialogToPixels( sz ).x;
169 }

Referenced by DIALOG_CHOOSE_COMPONENT(), and DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT().

◆ IsCtrl()

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

Definition at line 136 of file dialog_shim.h.

137  {
138  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
139  !e.ShiftDown() && !e.MetaDown();
140  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsExternalBrowserSelected()

bool DIALOG_CHOOSE_COMPONENT::IsExternalBrowserSelected ( ) const
inline

Function IsExternalBrowserSelected.

Returns
true, iff the user pressed the thumbnail view of the component to launch the component browser.

Definition at line 159 of file dialog_choose_component.h.

160  {
162  }

References m_external_browser_requested.

Referenced by SCH_BASE_FRAME::PickSymbolFromLibTree().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 142 of file dialog_shim.h.

143  {
144  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
145  e.ShiftDown() && !e.MetaDown();
146  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Function Kiway returns 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 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:81

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_TOOLS::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), SYMBOL_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), SCH_BASE_FRAME::PickSymbolFromLibBrowser(), KIWAY_HOLDER::Prj(), SCH_EDIT_TOOL::Properties(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), SYMBOL_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), SCH_EDIT_FRAME::SetCrossProbeConnection(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), LIB_CONTROL::UpdateSymbolInSchematic(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnCharHook()

void DIALOG_CHOOSE_COMPONENT::OnCharHook ( wxKeyEvent &  aEvt)
overrideprotectedvirtual

Reimplemented from DIALOG_SHIM.

Definition at line 311 of file dialog_choose_component.cpp.

312 {
313  if( m_details && e.GetKeyCode() == 'C' && e.ControlDown() &&
314  !e.AltDown() && !e.ShiftDown() && !e.MetaDown() )
315  {
316  wxString txt = m_details->SelectionToText();
317 
318  if( wxTheClipboard->Open() )
319  {
320  wxTheClipboard->SetData( new wxTextDataObject( txt ) );
321  wxTheClipboard->Close();
322  }
323  }
324  else
325  {
326  e.Skip();
327  }
328 }

References m_details.

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

◆ OnCloseTimer()

void DIALOG_CHOOSE_COMPONENT::OnCloseTimer ( wxTimerEvent &  aEvent)
protected

Definition at line 350 of file dialog_choose_component.cpp.

351 {
352  // Hack handler because of eaten MouseUp event. See
353  // DIALOG_CHOOSE_COMPONENT::OnComponentSelected for the beginning
354  // of this spaghetti noodle.
355 
356  auto state = wxGetMouseState();
357 
358  if( state.LeftIsDown() )
359  {
360  // Mouse hasn't been raised yet, so fire the timer again. Otherwise the
361  // purpose of this timer is defeated.
363  }
364  else
365  {
366  if( IsQuasiModal() )
367  EndQuasiModal( wxID_OK );
368  else if( IsModal() )
369  EndModal( wxID_OK );
370  else
371  wxFAIL_MSG( "Dialog called with neither Modal nor QuasiModal" );
372  }
373 }
bool IsQuasiModal() const
Definition: dialog_shim.h:123
void EndQuasiModal(int retCode)
static constexpr int DblClickDelay

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

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

◆ OnComponentPreselected()

void DIALOG_CHOOSE_COMPONENT::OnComponentPreselected ( wxCommandEvent &  aEvent)
protected

Definition at line 496 of file dialog_choose_component.cpp.

497 {
498  int unit = 0;
499 
500  LIB_ID id = m_tree->GetSelectedLibId( &unit );
501 
502  if( id.IsValid() )
503  {
504  m_symbol_preview->DisplaySymbol( id, unit );
505 
506  ShowFootprintFor( id );
508  }
509  else
510  {
511  m_symbol_preview->SetStatusText( _( "No symbol selected" ) );
512 
514  m_fp_preview->SetStatusText( wxEmptyString );
515 
517  }
518 }
void PopulateFootprintSelector(LIB_ID const &aLibId)
Populate the footprint selector for a given alias.
SYMBOL_PREVIEW_WIDGET * m_symbol_preview
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit components, if the user selects the component itself rather than picking an individual...
Definition: lib_tree.cpp:151
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
void DisplaySymbol(const LIB_ID &aSymbolID, int aUnit, int aConvert=0)
Set the currently displayed symbol.
#define _(s)
Definition: 3d_actions.cpp:33
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
void ShowFootprintFor(LIB_ID const &aLibId)
Look up the footprint for a given symbol specified in the LIB_ID and display it.
bool IsInitialized() const
Return whether the widget initialized properly.

References _, SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), LIB_TREE::GetSelectedLibId(), FOOTPRINT_PREVIEW_WIDGET::IsInitialized(), m_fp_preview, m_symbol_preview, m_tree, PopulateFootprintSelector(), SYMBOL_PREVIEW_WIDGET::SetStatusText(), FOOTPRINT_PREVIEW_WIDGET::SetStatusText(), and ShowFootprintFor().

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

◆ OnComponentSelected()

void DIALOG_CHOOSE_COMPONENT::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 component, the component is picked.

Definition at line 521 of file dialog_choose_component.cpp.

522 {
523  if( m_tree->GetSelectedLibId().IsValid() )
524  {
525  // Got a selection. We can't just end the modal dialog here, because
526  // wx leaks some events back to the parent window (in particular, the
527  // MouseUp following a double click).
528  //
529  // NOW, here's where it gets really fun. wxTreeListCtrl eats MouseUp.
530  // This isn't really feasible to bypass without a fully custom
531  // wxDataViewCtrl implementation, and even then might not be fully
532  // possible (docs are vague). To get around this, we use a one-shot
533  // timer to schedule the dialog close.
534  //
535  // See DIALOG_CHOOSE_COMPONENT::OnCloseTimer for the other end of this
536  // spaghetti noodle.
538  }
539 }
bool IsValid() const
Definition: lib_id.h:171
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
For multi-unit components, if the user selects the component itself rather than picking an individual...
Definition: lib_tree.cpp:151
static constexpr int DblClickDelay

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

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

◆ OnFootprintSelected()

void DIALOG_CHOOSE_COMPONENT::OnFootprintSelected ( wxCommandEvent &  aEvent)
protected

Definition at line 479 of file dialog_choose_component.cpp.

480 {
481  m_fp_override = aEvent.GetString();
482 
483  m_field_edits.erase( std::remove_if( m_field_edits.begin(), m_field_edits.end(),
484  []( std::pair<int, wxString> const& i )
485  {
486  return i.first == FOOTPRINT_FIELD;
487  } ),
488  m_field_edits.end() );
489 
490  m_field_edits.emplace_back( std::make_pair( FOOTPRINT_FIELD, m_fp_override ) );
491 
493 }
std::vector< std::pair< int, wxString > > m_field_edits
void ShowFootprint(wxString const &aFootprint)
Display the given footprint by name.
Field Name Module PCB, i.e. "16DIP300".

References FOOTPRINT_FIELD, m_field_edits, m_fp_override, and ShowFootprint().

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

◆ OnInitDialog()

void DIALOG_CHOOSE_COMPONENT::OnInitDialog ( wxInitDialogEvent &  aEvent)
protected

Definition at line 298 of file dialog_choose_component.cpp.

299 {
301  {
302  // This hides the GAL panel and shows the status label
303  m_fp_preview->SetStatusText( wxEmptyString );
304  }
305 
306  if( m_fp_sel_ctrl )
307  m_fp_sel_ctrl->Load( Kiway(), Prj() );
308 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
void Load(KIWAY &aKiway, PROJECT &aProject)
Start loading.
bool IsInitialized() const
Return whether the widget initialized properly.

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_COMPONENT(), and ~DIALOG_CHOOSE_COMPONENT().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 313 of file dialog_shim.cpp.

314 {
315  if( m_firstPaintEvent )
316  {
318 
319  selectAllInTextCtrls( GetChildren() );
320 
322  m_initialFocusTarget->SetFocus();
323  else
324  SetFocus(); // Focus the dialog itself
325 
326  m_firstPaintEvent = false;
327  }
328 
329  event.Skip();
330 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:197
bool m_firstPaintEvent
Definition: dialog_shim.h:196
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:56
static void selectAllInTextCtrls(wxWindowList &children)

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

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnUseBrowser()

void DIALOG_CHOOSE_COMPONENT::OnUseBrowser ( wxCommandEvent &  aEvent)
protected

Definition at line 337 of file dialog_choose_component.cpp.

338 {
340 
341  if( IsQuasiModal() )
342  EndQuasiModal( wxID_OK );
343  else if( IsModal() )
344  EndModal( wxID_OK );
345  else
346  wxFAIL_MSG( "Dialog called with neither Modal nor QuasiModal" );
347 }
bool IsQuasiModal() const
Definition: dialog_shim.h:123
void EndQuasiModal(int retCode)

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

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

◆ PopulateFootprintSelector()

void DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector ( LIB_ID const &  aLibId)
protected

Populate the footprint selector for a given alias.

Parameters
aLibIdthe LIB_ID of the selection or invalid to clear

Definition at line 432 of file dialog_choose_component.cpp.

433 {
434  if( !m_fp_sel_ctrl )
435  return;
436 
438 
439  LIB_PART* symbol = nullptr;
440 
441  if( aLibId.IsValid() )
442  {
443  try
444  {
445  symbol = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
446  }
447  catch( const IO_ERROR& ioe )
448  {
449  wxLogError( wxString::Format( _( "Error occurred loading symbol %s from library %s."
450  "\n\n%s" ),
451  aLibId.GetLibItemName().wx_str(),
452  aLibId.GetLibNickname().wx_str(),
453  ioe.What() ) );
454  }
455  }
456 
457  if( symbol != nullptr )
458  {
459  LIB_PINS temp_pins;
460  LIB_FIELD* fp_field = symbol->GetField( FOOTPRINT_FIELD );
461  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
462 
463  symbol->GetPins( temp_pins );
464 
465  m_fp_sel_ctrl->FilterByPinCount( temp_pins.size() );
470  }
471  else
472  {
474  m_fp_sel_ctrl->Disable();
475  }
476 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
void FilterByFootprintFilters(wxArrayString const &aFilters, bool aZeroFilters)
Filter by footprint filter list.
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:56
Field object used in symbol libraries.
Definition: lib_field.h:59
void SetDefaultFootprint(wxString const &aFp)
Set the default footprint for a part.
void ClearFilters()
Clear all filters.
bool UpdateList()
Update the contents of the list to match the filters.
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0)
Return a list of pin object pointers from the draw item list.
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
Define a library symbol object.
virtual bool Enable(bool aEnable=true) override
Enable or disable the control for input.
wxArrayString GetFootprints() const
Field Name Module PCB, i.e. "16DIP300".
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:297
LIB_FIELD * GetField(int aId) const
Return pointer to the requested field.
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
void FilterByPinCount(int aPinCount)
Filter by pin count.

References _, FOOTPRINT_SELECT_WIDGET::ClearFilters(), FOOTPRINT_SELECT_WIDGET::Enable(), FOOTPRINT_SELECT_WIDGET::FilterByFootprintFilters(), FOOTPRINT_SELECT_WIDGET::FilterByPinCount(), FOOTPRINT_FIELD, Format(), LIB_PART::GetField(), LIB_PART::GetFootprints(), LIB_FIELD::GetFullText(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_PART::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

Function Prj returns a reference to the PROJECT "associated with" this KIWAY.

Definition at line 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:174

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), AskSaveBoardFileName(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_PROPERTIES::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), DIALOG_EXPORT_SVG::ExportSVGFile(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), SYMBOL_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), SYMBOL_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), EDA_BASE_FRAME::LoadWindowState(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_PROPERTIES::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::Save_File(), FOOTPRINT_EDITOR_TOOLS::SaveAs(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_EDIT_FRAME::SaveOneSymbol(), SYMBOL_EDIT_FRAME::savePartAs(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), EDA_BASE_FRAME::SaveSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), PCB_BASE_FRAME::SelectLibrary(), SYMBOL_EDIT_FRAME::SelectLibraryFromList(), SYMBOL_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), SYMBOL_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), SYMBOL_EDIT_FRAME::SetCurPart(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_LIBRARY_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ 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 244 of file dialog_shim.cpp.

245 {
246  const char* hash_key;
247 
248  if( m_hash_key.size() )
249  {
250  // a special case like EDA_LIST_DIALOG, which has multiple uses.
251  hash_key = m_hash_key.c_str();
252  }
253  else
254  {
255  hash_key = typeid(*this).name();
256  }
257 
258  RECT_MAP::iterator it = class_map.find( hash_key );
259 
260  if( it == class_map.end() )
261  return;
262 
263  EDA_RECT rect = it->second;
264  rect.SetSize( 0, 0 );
265  class_map[ hash_key ] = rect;
266 }
std::string m_hash_key
Definition: dialog_shim.h:191
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:144
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

References class_map, DIALOG_SHIM::m_hash_key, and EDA_RECT::SetSize().

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

◆ 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 114 of file dialog_shim.h.

115  {
116  m_initialFocusTarget = aWindow;
117  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:197

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), 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_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), DIALOG_EDIT_ONE_FIELD::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(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetKiway()

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

Function SetKiway.

Parameters
aDestis the recipient of aKiway pointer. It is only used for debugging, since "this" is not a wxWindow*. "this" is a KIWAY_HOLDER mix-in.
aKiwayis often from a parent window, or from KIFACE::CreateWindow().

Definition at line 42 of file kiway_holder.cpp.

43 {
44 #if defined(DEBUG)
45  // offer a trap point for debugging most any window
46  wxASSERT( aDest );
47  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
48  {
49  int breakhere=1;
50  (void) breakhere;
51  }
52 #endif
53 
54  (void) aDest;
55 
56  m_kiway = aKiway;
57 }
KIWAY * m_kiway
Definition: kiway_holder.h:81
const char * name
Definition: DXF_plotter.cpp:59

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ 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 158 of file dialog_shim.cpp.

159 {
160  wxSize sz( x, y );
161  SetSize( ConvertDialogToPixels( sz ) );
162 }

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

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 185 of file dialog_shim.cpp.

186 {
187  bool ret;
188  const char* hash_key;
189 
190  if( m_hash_key.size() )
191  {
192  // a special case like EDA_LIST_DIALOG, which has multiple uses.
193  hash_key = m_hash_key.c_str();
194  }
195  else
196  {
197  hash_key = typeid(*this).name();
198  }
199 
200  // Show or hide the window. If hiding, save current position and size.
201  // If showing, use previous position and size.
202  if( show )
203  {
204 #ifndef __WINDOWS__
205  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
206 #endif
207  ret = wxDialog::Show( show );
208 
209  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
210  EDA_RECT savedDialogRect = class_map[ hash_key ];
211 
212  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
213  {
214  SetSize( savedDialogRect.GetPosition().x,
215  savedDialogRect.GetPosition().y,
216  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
217  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
218  0 );
219  }
220 
221  // Be sure that the dialog appears in a visible area
222  // (the dialog position might have been stored at the time when it was
223  // shown on another display)
224  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
225  Centre();
226  }
227  else
228  {
229  // Save the dialog's position & size before hiding, using classname as key
230  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
231 
232 #ifdef __WXMAC__
233  if ( m_eventLoop )
234  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
235 #endif
236 
237  ret = wxDialog::Show( show );
238  }
239 
240  return ret;
241 }
std::string m_hash_key
Definition: dialog_shim.h:191
static RECT_MAP class_map
const wxPoint GetPosition() const
Definition: eda_rect.h:115
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
const wxSize GetSize() const
Definition: eda_rect.h:103

References class_map, EDA_RECT::GetPosition(), EDA_RECT::GetSize(), and DIALOG_SHIM::m_hash_key.

Referenced by FOOTPRINT_EDITOR_TOOLS::CheckFootprint(), DIALOG_SHIM::EndQuasiModal(), GROUP_TOOL::GroupProperties(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), DIALOG_FOOTPRINT_CHECKER::OnLeftDClickItem(), GROUP_TOOL::PickNewMember(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), EE_INSPECTION_TOOL::RunERC(), EDA_VIEW_SWITCHER::Show(), DIALOG_PAD_PROPERTIES::Show(), DRC_TOOL::ShowDRCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), HTML_MESSAGE_BOX::ShowModeless(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

◆ ShowFootprint()

void DIALOG_CHOOSE_COMPONENT::ShowFootprint ( wxString const &  aFootprint)
protected

Display the given footprint by name.

Definition at line 405 of file dialog_choose_component.cpp.

406 {
408  return;
409 
410  if( aName == wxEmptyString )
411  {
412  m_fp_preview->SetStatusText( _( "No footprint specified" ) );
413  }
414  else
415  {
416  LIB_ID lib_id;
417 
418  if( lib_id.Parse( aName, LIB_ID::ID_PCB ) == -1 && lib_id.IsValid() )
419  {
421  m_fp_preview->CacheFootprint( lib_id );
422  m_fp_preview->DisplayFootprint( lib_id );
423  }
424  else
425  {
426  m_fp_preview->SetStatusText( _( "Invalid footprint specified" ) );
427  }
428  }
429 }
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
bool IsValid() const
Definition: lib_id.h:171
void ClearStatus()
Clear the contents of the status label and hide it.
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
void CacheFootprint(const LIB_ID &aFPID)
Preload a footprint into the cache.
#define _(s)
Definition: 3d_actions.cpp:33
void DisplayFootprint(const LIB_ID &aFPID)
Set the currently displayed footprint.
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
int Parse(const UTF8 &aId, LIB_ID_TYPE aType, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:122
bool IsInitialized() const
Return whether the widget initialized properly.

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

Referenced by OnFootprintSelected(), and ShowFootprintFor().

◆ ShowFootprintFor()

void DIALOG_CHOOSE_COMPONENT::ShowFootprintFor ( LIB_ID const &  aLibId)
protected

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

Definition at line 376 of file dialog_choose_component.cpp.

377 {
379  return;
380 
381  LIB_PART* symbol = nullptr;
382 
383  try
384  {
385  symbol = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
386  }
387  catch( const IO_ERROR& ioe )
388  {
389  wxLogError( wxString::Format( _( "Error loading symbol %s from library %s.\n\n%s" ),
390  aLibId.GetLibItemName().wx_str(),
391  aLibId.GetLibNickname().wx_str(),
392  ioe.What() ) );
393  }
394 
395  if( !symbol )
396  return;
397 
398  LIB_FIELD* fp_field = symbol->GetField( FOOTPRINT_FIELD );
399  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
400 
401  ShowFootprint( fp_name );
402 }
Field object used in symbol libraries.
Definition: lib_field.h:59
void ShowFootprint(wxString const &aFootprint)
Display the given footprint by name.
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
Define a library symbol object.
Field Name Module PCB, i.e. "16DIP300".
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:297
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
LIB_FIELD * GetField(int aId) const
Return pointer to the requested field.
bool IsInitialized() const
Return whether the widget initialized properly.
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76

References _, FOOTPRINT_FIELD, Format(), LIB_PART::GetField(), 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 356 of file dialog_shim.cpp.

357 {
358  // This is an exception safe way to zero a pointer before returning.
359  // Yes, even though DismissModal() clears this first normally, this is
360  // here in case there's an exception before the dialog is dismissed.
361  struct NULLER
362  {
363  void*& m_what;
364  NULLER( void*& aPtr ) : m_what( aPtr ) {}
365  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
366  } clear_this( (void*&) m_qmodal_loop );
367 
368  // release the mouse if it's currently captured as the window having it
369  // will be disabled when this dialog is shown -- but will still keep the
370  // capture making it impossible to do anything in the modal dialog itself
371  wxWindow* win = wxWindow::GetCapture();
372  if( win )
373  win->ReleaseMouse();
374 
375  // Get the optimal parent
376  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
377 
378  wxASSERT_MSG( !m_qmodal_parent_disabler,
379  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
380 
381  // quasi-modal: disable only my "optimal" parent
383 
384  // Apple in its infinite wisdom will raise a disabled window before even passing
385  // us the event, so we have no way to stop it. Instead, we must set an order on
386  // the windows so that the quasi-modal will be pushed in front of the disabled
387  // window when it is raised.
389 
390  Show( true );
391 
392  m_qmodal_showing = true;
393 
394  WX_EVENT_LOOP event_loop;
395 
396  m_qmodal_loop = &event_loop;
397 
398  event_loop.Run();
399 
400  m_qmodal_showing = false;
401 
402  return GetReturnCode();
403 }
bool m_qmodal_showing
Definition: dialog_shim.h:201
#define WX_EVENT_LOOP
Definition: kiway_player.h:43
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:199
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:202
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:43
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:50

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 S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), SCH_DRAWING_TOOLS::createNewText(), LIB_EDIT_TOOL::editFieldProperties(), SCH_EDITOR_CONTROL::EditSymbolFields(), LIB_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeDialogCreateBOM(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

◆ 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 172 of file dialog_shim.cpp.

173 {
174  wxSize sz( 0, y );
175  return ConvertDialogToPixels( sz ).y;
176 }

Referenced by DIALOG_CHOOSE_COMPONENT().

Member Data Documentation

◆ DblClickDelay

constexpr int DIALOG_CHOOSE_COMPONENT::DblClickDelay = 100
staticprotected

Definition at line 167 of file dialog_choose_component.h.

Referenced by OnCloseTimer(), and OnComponentSelected().

◆ g_Mutex

std::mutex DIALOG_CHOOSE_COMPONENT::g_Mutex
static

◆ m_allow_field_edits

bool DIALOG_CHOOSE_COMPONENT::m_allow_field_edits
protected

Definition at line 219 of file dialog_choose_component.h.

Referenced by ConstructRightPanel().

◆ m_browser_button

wxButton* DIALOG_CHOOSE_COMPONENT::m_browser_button
protected

Definition at line 206 of file dialog_choose_component.h.

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

◆ m_dbl_click_timer

wxTimer* DIALOG_CHOOSE_COMPONENT::m_dbl_click_timer
protected

◆ m_deMorganConvert

int DIALOG_CHOOSE_COMPONENT::m_deMorganConvert
protected

Definition at line 218 of file dialog_choose_component.h.

◆ m_details

wxHtmlWindow* DIALOG_CHOOSE_COMPONENT::m_details
protected

◆ m_external_browser_requested

bool DIALOG_CHOOSE_COMPONENT::m_external_browser_requested
protected

Definition at line 221 of file dialog_choose_component.h.

Referenced by IsExternalBrowserSelected(), and OnUseBrowser().

◆ m_field_edits

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

Definition at line 224 of file dialog_choose_component.h.

Referenced by GetFields(), and OnFootprintSelected().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 196 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_fp_override

wxString DIALOG_CHOOSE_COMPONENT::m_fp_override
protected

Definition at line 222 of file dialog_choose_component.h.

Referenced by OnFootprintSelected().

◆ m_fp_preview

FOOTPRINT_PREVIEW_WIDGET* DIALOG_CHOOSE_COMPONENT::m_fp_preview
protected

◆ m_fp_sel_ctrl

FOOTPRINT_SELECT_WIDGET* DIALOG_CHOOSE_COMPONENT::m_fp_sel_ctrl
protected

◆ m_hash_key

◆ m_hsplitter

wxSplitterWindow* DIALOG_CHOOSE_COMPONENT::m_hsplitter
protected

Definition at line 207 of file dialog_choose_component.h.

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

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 197 of file dialog_shim.h.

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

◆ m_keepSymbol

wxCheckBox* DIALOG_CHOOSE_COMPONENT::m_keepSymbol
protected

◆ m_parent

SCH_BASE_FRAME* DIALOG_CHOOSE_COMPONENT::m_parent
protected

Definition at line 217 of file dialog_choose_component.h.

Referenced by ConstructRightPanel().

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 204 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 199 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

◆ m_qmodal_showing

bool DIALOG_SHIM::m_qmodal_showing
protectedinherited

Definition at line 201 of file dialog_shim.h.

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

◆ m_show_footprints

bool DIALOG_CHOOSE_COMPONENT::m_show_footprints
protected

Definition at line 220 of file dialog_choose_component.h.

Referenced by ConstructRightPanel(), and DIALOG_CHOOSE_COMPONENT().

◆ m_symbol_preview

SYMBOL_PREVIEW_WIDGET* DIALOG_CHOOSE_COMPONENT::m_symbol_preview
protected

Definition at line 205 of file dialog_choose_component.h.

Referenced by ConstructRightPanel(), and OnComponentPreselected().

◆ m_tabOrder

◆ m_tree

LIB_TREE* DIALOG_CHOOSE_COMPONENT::m_tree
protected

◆ m_units

◆ m_useUnits

wxCheckBox* DIALOG_CHOOSE_COMPONENT::m_useUnits
protected

◆ m_vsplitter

wxSplitterWindow* DIALOG_CHOOSE_COMPONENT::m_vsplitter
protected

Definition at line 208 of file dialog_choose_component.h.

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


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