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, SCREEN }
 

Public Member Functions

 DIALOG_CHOOSE_COMPONENT (SCH_BASE_FRAME *aParent, const wxString &aTitle, SYMBOL_TREE_MODEL_ADAPTER::PTR &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...
 
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 ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS_T GetUserUnits () const
 
HOLDER_TYPE GetType ()
 
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)
 
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)
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int VertPixelsFromDU (int y)
 Convert an integer number of dialog units to pixels, vertically. More...
 

Protected Attributes

wxConfigBase * m_config
 
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
 
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_T 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
 
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 
SCREEN 

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,
SYMBOL_TREE_MODEL_ADAPTER::PTR 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 54 of file dialog_choose_component.cpp.

58  : DIALOG_SHIM( aParent, wxID_ANY, aTitle, wxDefaultPosition, wxDefaultSize,
59  wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ),
60  m_browser_button( nullptr ),
61  m_hsplitter( nullptr ),
62  m_vsplitter( nullptr ),
63  m_fp_sel_ctrl( nullptr ),
64  m_fp_preview( nullptr ),
65  m_tree( nullptr ),
66  m_details( nullptr ),
67  m_parent( aParent ),
68  m_deMorganConvert( aDeMorganConvert >= 0 ? aDeMorganConvert : 0 ),
69  m_allow_field_edits( aAllowFieldEdits ),
70  m_show_footprints( aShowFootprints ),
72 {
74 
75  auto sizer = new wxBoxSizer( wxVERTICAL );
76 
77  // Use a slightly different layout, with a details pane spanning the entire window,
78  // if we're not showing footprints.
79  if( aShowFootprints )
80  {
81  m_hsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
82  wxSP_LIVE_UPDATE );
83 
84  //Avoid the splitter window being assigned as the Parent to additional windows
85  m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
86 
87  sizer->Add( m_hsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
88  }
89  else
90  {
91  m_vsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
92  wxSP_LIVE_UPDATE );
93 
94  m_hsplitter = new wxSplitterWindow( m_vsplitter, wxID_ANY, wxDefaultPosition, wxDefaultSize,
95  wxSP_LIVE_UPDATE );
96 
97  //Avoid the splitter window being assigned as the Parent to additional windows
98  m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
99 
100  auto detailsPanel = new wxPanel( m_vsplitter );
101  auto detailsSizer = new wxBoxSizer( wxVERTICAL );
102  detailsPanel->SetSizer( detailsSizer );
103 
104  m_details = new wxHtmlWindow( detailsPanel, wxID_ANY, wxDefaultPosition, wxDefaultSize,
105  wxHW_SCROLLBAR_AUTO );
106  detailsSizer->Add( m_details, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
107  detailsPanel->Layout();
108  detailsSizer->Fit( detailsPanel );
109 
110  m_vsplitter->SetSashGravity( 0.5 );
111  m_vsplitter->SetMinimumPaneSize( 20 );
112  m_vsplitter->SplitHorizontally( m_hsplitter, detailsPanel );
113 
114  sizer->Add( m_vsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
115  }
116 
117  m_tree = new LIB_TREE( m_hsplitter, Prj().SchSymbolLibTable(), aAdapter,
119 
120  m_hsplitter->SetSashGravity( 0.8 );
121  m_hsplitter->SetMinimumPaneSize( 20 );
122  m_hsplitter->SplitVertically( m_tree, ConstructRightPanel( m_hsplitter ) );
123 
124  m_dbl_click_timer = new wxTimer( this );
125 
126  auto buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
127 
128  if( aAllowBrowser )
129  {
130  m_browser_button = new wxButton( this, wxID_ANY, _( "Select with Browser" ) );
131  buttonsSizer->Add( m_browser_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
132  }
133 
134  auto sdbSizer = new wxStdDialogButtonSizer();
135  auto okButton = new wxButton( this, wxID_OK );
136  auto cancelButton = new wxButton( this, wxID_CANCEL );
137  sdbSizer->AddButton( okButton );
138  sdbSizer->AddButton( cancelButton );
139  sdbSizer->Realize();
140 
141  buttonsSizer->Add( sdbSizer, 1, wxALL, 5 );
142 
143  sizer->Add( buttonsSizer, 0, wxEXPAND | wxLEFT, 5 );
144  SetSizer( sizer );
145 
146  Layout();
147 
148  // We specify the width of the right window (m_symbol_view_panel), because specify
149  // the width of the left window does not work as expected when SetSashGravity() is called
150  m_hsplitter->SetSashPosition( m_config->Read( SYM_CHOOSER_HSASH, HorizPixelsFromDU( 220 ) ) );
151 
152  if( m_vsplitter )
153  m_vsplitter->SetSashPosition( m_config->Read( SYM_CHOOSER_VSASH, VertPixelsFromDU( 230 ) ) );
154 
155  wxSize dlgSize( m_config->Read( SYM_CHOOSER_WIDTH_KEY, HorizPixelsFromDU( 390 ) ),
157  SetSize( dlgSize );
158 
160  okButton->SetDefault();
161 
162  Bind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_COMPONENT::OnInitDialog, this );
163  Bind( wxEVT_TIMER, &DIALOG_CHOOSE_COMPONENT::OnCloseTimer, this, m_dbl_click_timer->GetId() );
164  Bind( COMPONENT_PRESELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentPreselected, this );
165  Bind( COMPONENT_SELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentSelected, this );
166 
167  if( m_browser_button )
168  m_browser_button->Bind( wxEVT_COMMAND_BUTTON_CLICKED,
170 
171  if( m_fp_sel_ctrl )
172  m_fp_sel_ctrl->Bind( EVT_FOOTPRINT_SELECTED,
174 
175  if( m_details )
176  m_details->Connect( wxEVT_CHAR_HOOK,
177  wxKeyEventHandler( DIALOG_CHOOSE_COMPONENT::OnCharHook ),
178  NULL, this );
179 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
void OnFootprintSelected(wxCommandEvent &aEvent)
#define SYM_CHOOSER_VSASH
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
#define SYM_CHOOSER_HSASH
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:118
void OnComponentPreselected(wxCommandEvent &aEvent)
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:51
void OnCharHook(wxKeyEvent &aEvt)
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:68
void OnInitDialog(wxInitDialogEvent &aEvent)
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
void OnCloseTimer(wxTimerEvent &aEvent)
wxPanel * ConstructRightPanel(wxWindow *aParent)
Definition: hash_eda.h:46
void OnUseBrowser(wxCommandEvent &aEvent)
#define _(s)
#define SYM_CHOOSER_WIDTH_KEY
#define SYM_CHOOSER_HEIGHT_KEY
int VertPixelsFromDU(int y)
Convert an integer number of dialog units to pixels, vertically.
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
int HorizPixelsFromDU(int x)
Convert an integer number of dialog units to pixels, horizontally.
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 _, ALL, ConstructRightPanel(), DIALOG_SHIM::HorizPixelsFromDU(), Kiface(), KIFACE_I::KifaceSettings(), m_browser_button, m_config, m_dbl_click_timer, m_details, m_fp_sel_ctrl, m_hsplitter, m_tree, m_vsplitter, OnCharHook(), OnCloseTimer(), OnComponentPreselected(), OnComponentSelected(), OnFootprintSelected(), OnInitDialog(), OnUseBrowser(), KIWAY_HOLDER::Prj(), DIALOG_SHIM::SetInitialFocus(), SYM_CHOOSER_HEIGHT_KEY, SYM_CHOOSER_HSASH, SYM_CHOOSER_VSASH, SYM_CHOOSER_WIDTH_KEY, and DIALOG_SHIM::VertPixelsFromDU().

◆ ~DIALOG_CHOOSE_COMPONENT()

DIALOG_CHOOSE_COMPONENT::~DIALOG_CHOOSE_COMPONENT ( )

Definition at line 182 of file dialog_choose_component.cpp.

183 {
184  Unbind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_COMPONENT::OnInitDialog, this );
185  Unbind( wxEVT_TIMER, &DIALOG_CHOOSE_COMPONENT::OnCloseTimer, this );
186  Unbind( COMPONENT_PRESELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentPreselected, this );
187  Unbind( COMPONENT_SELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentSelected, this );
188 
189  if( m_browser_button )
190  m_browser_button->Unbind( wxEVT_COMMAND_BUTTON_CLICKED,
192 
193  if( m_fp_sel_ctrl )
194  m_fp_sel_ctrl->Unbind( EVT_FOOTPRINT_SELECTED,
196 
197  if( m_details )
198  m_details->Disconnect( wxEVT_CHAR_HOOK,
199  wxKeyEventHandler( DIALOG_CHOOSE_COMPONENT::OnCharHook ),
200  NULL, this );
201 
202  // I am not sure the following two lines are necessary, but they will not hurt anyone
203  m_dbl_click_timer->Stop();
204  delete m_dbl_click_timer;
205 
206  m_config->Write( SYM_CHOOSER_WIDTH_KEY, GetSize().x );
207  m_config->Write( SYM_CHOOSER_HEIGHT_KEY, GetSize().y );
208 
209  m_config->Write( SYM_CHOOSER_HSASH, m_hsplitter->GetSashPosition() );
210 
211  if( m_vsplitter )
212  m_config->Write( SYM_CHOOSER_VSASH, m_vsplitter->GetSashPosition() );
213 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
void OnFootprintSelected(wxCommandEvent &aEvent)
#define SYM_CHOOSER_VSASH
#define SYM_CHOOSER_HSASH
void OnComponentPreselected(wxCommandEvent &aEvent)
void OnCharHook(wxKeyEvent &aEvt)
void OnInitDialog(wxInitDialogEvent &aEvent)
void OnCloseTimer(wxTimerEvent &aEvent)
void OnUseBrowser(wxCommandEvent &aEvent)
#define SYM_CHOOSER_WIDTH_KEY
#define SYM_CHOOSER_HEIGHT_KEY
void OnComponentSelected(wxCommandEvent &aEvent)
Handle the selection of an item.

References m_browser_button, m_config, m_dbl_click_timer, m_details, m_fp_sel_ctrl, m_hsplitter, m_vsplitter, OnCharHook(), OnCloseTimer(), OnComponentPreselected(), OnComponentSelected(), OnFootprintSelected(), OnInitDialog(), OnUseBrowser(), SYM_CHOOSER_HEIGHT_KEY, SYM_CHOOSER_HSASH, SYM_CHOOSER_VSASH, and SYM_CHOOSER_WIDTH_KEY.

Member Function Documentation

◆ ConstructRightPanel()

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

Definition at line 216 of file dialog_choose_component.cpp.

217 {
218  auto panel = new wxPanel( aParent );
219  auto sizer = new wxBoxSizer( wxVERTICAL );
220 
222  m_parent->GetCanvas()->GetBackend() );
223  m_symbol_preview->SetLayoutDirection( wxLayout_LeftToRight );
224 
225  if( m_show_footprints )
226  {
228 
229  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxTOP | wxBOTTOM | wxRIGHT, 5 );
230 
231  if ( fp_list )
232  {
233  if( m_allow_field_edits )
234  m_fp_sel_ctrl = new FOOTPRINT_SELECT_WIDGET( panel, fp_list, true );
235 
236  m_fp_preview = new FOOTPRINT_PREVIEW_WIDGET( panel, Kiway() );
237  }
238 
239  if( m_fp_sel_ctrl )
240  sizer->Add( m_fp_sel_ctrl, 0, wxEXPAND | wxBOTTOM | wxTOP | wxRIGHT, 5 );
241 
242  if( m_fp_preview )
243  sizer->Add( m_fp_preview, 1, wxEXPAND | wxBOTTOM | wxRIGHT, 5 );
244  }
245  else
246  {
247  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxTOP | wxRIGHT, 5 );
248  }
249 
250  panel->SetSizer( sizer );
251  panel->Layout();
252  sizer->Fit( panel );
253 
254  return panel;
255 }
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.
Holds a list of FOOTPRINT_INFO objects, along with a list of IO_ERRORs or PARSE_ERRORs that were thro...
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(), KIWAY_HOLDER::Kiway(), m_allow_field_edits, m_fp_preview, m_fp_sel_ctrl, m_parent, m_show_footprints, and m_symbol_preview.

Referenced by DIALOG_CHOOSE_COMPONENT().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 238 of file dialog_shim.cpp.

239 {
240  // so we can do logging of this state change:
241 
242 #if 0 && defined(DEBUG)
243  const char* type_id = typeid( *this ).name();
244  printf( "DIALOG_SHIM %s: %s\n", type_id, enable ? "enabled" : "disabled" );
245  fflush(0); //Needed on msys2 to immediately print the message
246 #endif
247 
248  return wxDialog::Enable( enable );
249 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 398 of file dialog_shim.cpp.

399 {
400  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
401  // handle validation in the same way as other dialogs.
402  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
403  return;
404 
405  SetReturnCode( retCode );
406 
407  if( !IsQuasiModal() )
408  {
409  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
410  return;
411  }
412 
413  if( m_qmodal_loop )
414  {
415  if( m_qmodal_loop->IsRunning() )
416  m_qmodal_loop->Exit( 0 );
417  else
418  m_qmodal_loop->ScheduleExit( 0 );
419 
420  m_qmodal_loop = NULL;
421  }
422 
425 
426  Show( false );
427 }
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:194
bool IsQuasiModal()
Definition: dialog_shim.h:127
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:197

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), HTML_MESSAGE_BOX::OnOKButtonClick(), 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, when all widgets are initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at end of TransferDataToWindow, or better at end of a wxInitDialogEvent handler

In any case, the best way is to call it in a wxInitDialogEvent handler after calling TransfertDataToWindow(), which is the default wxInitDialogEvent handler wxDialog

Definition at line 138 of file dialog_shim.cpp.

139 {
140  // must be called from the constructor of derived classes,
141  // when all widgets are initialized, and therefore their size fixed
142 
143  // SetSizeHints fixes the minimal size of sizers in the dialog
144  // (SetSizeHints calls Fit(), so no need to call it)
145  GetSizer()->SetSizeHints( this );
146 
147  // the default position, when calling the first time the dlg
148  Center();
149 }

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), 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_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::DIALOG_FOOTPRINTS_DISPLAY_OPTIONS(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::DIALOG_FP_BROWSER_DISPLAY_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_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), 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_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_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), 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_UPDATE_PCB::DIALOG_UPDATE_PCB(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::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 129 of file dialog_choose_component.h.

130  {
131  return m_field_edits;
132  }
std::vector< std::pair< int, wxString > > m_field_edits

References m_field_edits.

Referenced by SCH_BASE_FRAME::SelectCompFromLibTree().

◆ 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 291 of file dialog_choose_component.cpp.

292 {
293  return m_tree->GetSelectedLibId( aUnit );
294 }
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:145

References LIB_TREE::GetSelectedLibId(), and m_tree.

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

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
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(), PL_EDITOR_FRAME::SaveSettings(), and GERBVIEW_FRAME::SaveSettings().

◆ GetUserUnits()

◆ HorizPixelsFromDU()

int DIALOG_SHIM::HorizPixelsFromDU ( int  x)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 159 of file dialog_shim.cpp.

160 {
161  wxSize sz( x, 0 );
162  return ConvertDialogToPixels( sz ).x;
163 }

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

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook(), and DIALOG_LABEL_EDITOR::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 139 of file dialog_choose_component.h.

140  {
142  }

References m_external_browser_requested.

Referenced by SCH_BASE_FRAME::SelectCompFromLibTree().

◆ 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() && e.ShiftDown() && !e.MetaDown();
145  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook(), and DIALOG_LABEL_EDITOR::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(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), SCH_EDIT_FRAME::CreateScreens(), 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(), EDIT_TOOL::EditFpInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithLibEdit(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), 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(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnCharHook()

void DIALOG_CHOOSE_COMPONENT::OnCharHook ( wxKeyEvent &  aEvt)
protected

Definition at line 271 of file dialog_choose_component.cpp.

272 {
273  if( m_details && e.GetKeyCode() == 'C' && e.ControlDown() &&
274  !e.AltDown() && !e.ShiftDown() && !e.MetaDown() )
275  {
276  wxString txt = m_details->SelectionToText();
277 
278  if( wxTheClipboard->Open() )
279  {
280  wxTheClipboard->SetData( new wxTextDataObject( txt ) );
281  wxTheClipboard->Close();
282  }
283  }
284  else
285  {
286  e.Skip();
287  }
288 }

References m_details.

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

◆ OnCloseTimer()

void DIALOG_CHOOSE_COMPONENT::OnCloseTimer ( wxTimerEvent &  aEvent)
protected

Definition at line 304 of file dialog_choose_component.cpp.

305 {
306  // Hack handler because of eaten MouseUp event. See
307  // DIALOG_CHOOSE_COMPONENT::OnComponentSelected for the beginning
308  // of this spaghetti noodle.
309 
310  auto state = wxGetMouseState();
311 
312  if( state.LeftIsDown() )
313  {
314  // Mouse hasn't been raised yet, so fire the timer again. Otherwise the
315  // purpose of this timer is defeated.
317  }
318  else
319  {
320  EndQuasiModal( wxID_OK );
321  }
322 }
void EndQuasiModal(int retCode)
static constexpr int DblClickDelay

References DblClickDelay, DIALOG_SHIM::EndQuasiModal(), 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 446 of file dialog_choose_component.cpp.

447 {
448  int unit = 0;
449 
450  LIB_ID id = m_tree->GetSelectedLibId( &unit );
451 
452  if( id.IsValid() )
453  {
454  m_symbol_preview->DisplaySymbol( id, unit );
455 
456  ShowFootprintFor( id );
458  }
459  else
460  {
461  m_symbol_preview->SetStatusText( _( "No symbol selected" ) );
462 
464  m_fp_preview->SetStatusText( wxEmptyString );
465 
467  }
468 }
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.
void DisplaySymbol(const LIB_ID &aSymbolID, int aUnit)
Set the currently displayed symbol.
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:145
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
#define _(s)
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 471 of file dialog_choose_component.cpp.

472 {
473  if( m_tree->GetSelectedLibId().IsValid() )
474  {
475  // Got a selection. We can't just end the modal dialog here, because
476  // wx leaks some events back to the parent window (in particular, the
477  // MouseUp following a double click).
478  //
479  // NOW, here's where it gets really fun. wxTreeListCtrl eats MouseUp.
480  // This isn't really feasible to bypass without a fully custom
481  // wxDataViewCtrl implementation, and even then might not be fully
482  // possible (docs are vague). To get around this, we use a one-shot
483  // timer to schedule the dialog close.
484  //
485  // See DIALOG_CHOOSE_COMPONENT::OnCloseTimer for the other end of this
486  // spaghetti noodle.
488  }
489 }
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:145
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 428 of file dialog_choose_component.cpp.

429 {
430  m_fp_override = aEvent.GetString();
431 
432  m_field_edits.erase(
433  std::remove_if( m_field_edits.begin(), m_field_edits.end(),
434  []( std::pair<int, wxString> const& i )
435  {
436  return i.first == FOOTPRINT;
437  } ),
438  m_field_edits.end() );
439 
440  m_field_edits.emplace_back( std::make_pair( FOOTPRINT, m_fp_override ) );
441 
443 }
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".
size_t i
Definition: json11.cpp:597

References FOOTPRINT, i, 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 258 of file dialog_choose_component.cpp.

259 {
261  {
262  // This hides the GAL panel and shows the status label
263  m_fp_preview->SetStatusText( wxEmptyString );
264  }
265 
266  if( m_fp_sel_ctrl )
267  m_fp_sel_ctrl->Load( Kiway(), Prj() );
268 }
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 299 of file dialog_shim.cpp.

300 {
301  if( m_firstPaintEvent )
302  {
303 #ifdef __WXMAC__
304  fixOSXCancelButtonIssue( this );
305 #endif
306 
307  selectAllInTextCtrls( GetChildren() );
308 
310  m_initialFocusTarget->SetFocus();
311  else
312  SetFocus(); // Focus the dialog itself
313 
314  m_firstPaintEvent = false;
315  }
316 
317  event.Skip();
318 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:192
bool m_firstPaintEvent
Definition: dialog_shim.h:191
static void selectAllInTextCtrls(wxWindowList &children)

References 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 297 of file dialog_choose_component.cpp.

298 {
300  EndQuasiModal( wxID_OK );
301 }
void EndQuasiModal(int retCode)

References DIALOG_SHIM::EndQuasiModal(), 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 381 of file dialog_choose_component.cpp.

382 {
383  if( !m_fp_sel_ctrl )
384  return;
385 
387 
388  LIB_ALIAS* alias = nullptr;
389 
390  if( aLibId.IsValid() )
391  {
392  try
393  {
394  alias = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
395  }
396  catch( const IO_ERROR& ioe )
397  {
398  wxLogError( wxString::Format( _( "Error occurred loading symbol %s from library %s."
399  "\n\n%s" ),
400  aLibId.GetLibItemName().wx_str(),
401  aLibId.GetLibNickname().wx_str(),
402  ioe.What() ) );
403  }
404  }
405 
406  if( alias != nullptr )
407  {
408  LIB_PINS temp_pins;
409  LIB_FIELD* fp_field = alias->GetPart()->GetField( FOOTPRINT );
410  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
411 
412  alias->GetPart()->GetPins( temp_pins );
413 
414  m_fp_sel_ctrl->FilterByPinCount( temp_pins.size() );
419  }
420  else
421  {
423  m_fp_sel_ctrl->Disable();
424  }
425 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Part library alias object definition.
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:55
Field object used in symbol libraries.
Definition: lib_field.h:59
void SetDefaultFootprint(wxString const &aFp)
Set the default footprint for a part.
Field Name Module PCB, i.e. "16DIP300".
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:33
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
virtual bool Enable(bool aEnable=true) override
Enable or disable the control for input.
LIB_PART * GetPart() const
Get the shared LIB_PART.
#define _(s)
wxArrayString & GetFootprints()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:300
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, Format(), LIB_PART::GetField(), LIB_PART::GetFootprints(), LIB_FIELD::GetFullText(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ALIAS::GetPart(), 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 34 of file kiway_holder.cpp.

35 {
36  return Kiway().Prj();
37 }
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:163

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), LIB_CONTROL::AddSymbolToSchematic(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PCB_EDIT_FRAME::doAutoSave(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadProjectFile(), CVPCB_MAINFRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), DIALOG_SCH_SHEET_PROPS::OnBrowseClicked(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), 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(), MODULE_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), SCH_DRAWING_TOOLS::PlaceComponent(), PopulateFootprintSelector(), SCH_EDIT_FRAME::Print(), SCH_EDIT_FRAME::PrintPage(), 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_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), EE_INSPECTION_TOOL::ShowDatasheet(), ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

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

119  {
120  m_initialFocusTarget = aWindow;
121  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:192

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_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), 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(), LIB_EDIT_FRAME::savePartAs(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::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 41 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

Referenced by InvokePcbLibTableEditor(), 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 152 of file dialog_shim.cpp.

153 {
154  wxSize sz( x, y );
155  SetSize( ConvertDialogToPixels( sz ) );
156 }

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

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

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickFootprints(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), DIALOG_SHIM::ShowQuasiModal(), and DIALOG_POSITION_RELATIVE::UpdateAnchor().

◆ ShowFootprint()

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

Display the given footprint by name.

Definition at line 354 of file dialog_choose_component.cpp.

355 {
357  return;
358 
359  if( aName == wxEmptyString )
360  {
361  m_fp_preview->SetStatusText( _( "No footprint specified" ) );
362  }
363  else
364  {
365  LIB_ID lib_id;
366 
367  if( lib_id.Parse( aName, LIB_ID::ID_PCB ) == -1 && lib_id.IsValid() )
368  {
370  m_fp_preview->CacheFootprint( lib_id );
371  m_fp_preview->DisplayFootprint( lib_id );
372  }
373  else
374  {
375  m_fp_preview->SetStatusText( _( "Invalid footprint specified" ) );
376  }
377  }
378 }
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.
#define _(s)
void CacheFootprint(const LIB_ID &aFPID)
Preload a footprint into the cache.
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 325 of file dialog_choose_component.cpp.

326 {
328  return;
329 
330  LIB_ALIAS* alias = nullptr;
331 
332  try
333  {
334  alias = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
335  }
336  catch( const IO_ERROR& ioe )
337  {
338  wxLogError( wxString::Format( _( "Error loading symbol %s from library %s.\n\n%s" ),
339  aLibId.GetLibItemName().wx_str(),
340  aLibId.GetLibNickname().wx_str(),
341  ioe.What() ) );
342  }
343 
344  if( !alias )
345  return;
346 
347  LIB_FIELD* fp_field = alias->GetPart()->GetField( FOOTPRINT );
348  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
349 
350  ShowFootprint( fp_name );
351 }
LIB_FIELD * GetField(int aId)
Return pointer to the requested field.
Part library alias object definition.
Field object used in symbol libraries.
Definition: lib_field.h:59
void ShowFootprint(wxString const &aFootprint)
Display the given footprint by name.
Field Name Module PCB, i.e. "16DIP300".
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
LIB_PART * GetPart() const
Get the shared LIB_PART.
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:300
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
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, Format(), LIB_PART::GetField(), LIB_FIELD::GetFullText(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ALIAS::GetPart(), 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 344 of file dialog_shim.cpp.

345 {
346  // This is an exception safe way to zero a pointer before returning.
347  // Yes, even though DismissModal() clears this first normally, this is
348  // here in case there's an exception before the dialog is dismissed.
349  struct NULLER
350  {
351  void*& m_what;
352  NULLER( void*& aPtr ) : m_what( aPtr ) {}
353  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
354  } clear_this( (void*&) m_qmodal_loop );
355 
356  // release the mouse if it's currently captured as the window having it
357  // will be disabled when this dialog is shown -- but will still keep the
358  // capture making it impossible to do anything in the modal dialog itself
359  wxWindow* win = wxWindow::GetCapture();
360  if( win )
361  win->ReleaseMouse();
362 
363  // Get the optimal parent
364  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
365 
366  // Show the optimal parent
367  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
368 
369  wxASSERT_MSG( !m_qmodal_parent_disabler,
370  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
371 
372  // quasi-modal: disable only my "optimal" parent
374 
375 #ifdef __WXMAC__
376  // Apple in its infinite wisdom will raise a disabled window before even passing
377  // us the event, so we have no way to stop it. Instead, we must set an order on
378  // the windows so that the quasi-modal will be pushed in front of the disabled
379  // window when it is raised.
380  ReparentQuasiModal();
381 #endif
382  Show( true );
383 
384  m_qmodal_showing = true;
385 
386  WX_EVENT_LOOP event_loop;
387 
388  m_qmodal_loop = &event_loop;
389 
390  event_loop.Run();
391 
392  m_qmodal_showing = false;
393 
394  return GetReturnCode();
395 }
bool m_qmodal_showing
Definition: dialog_shim.h:196
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:194
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:197
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:35
#define DBG(x)
Definition: fctsys.h:33

References DBG, DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, DIALOG_SHIM::m_qmodal_showing, DIALOG_SHIM::Show(), and WX_EVENT_LOOP.

Referenced by LIB_EDIT_TOOL::editFieldProperties(), SCH_EDITOR_CONTROL::EditSymbolFields(), LIB_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), SCH_EDITOR_CONTROL::NavigateHierarchy(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_BASE_FRAME::SelectCompFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ VertPixelsFromDU()

int DIALOG_SHIM::VertPixelsFromDU ( int  y)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 166 of file dialog_shim.cpp.

167 {
168  wxSize sz( 0, y );
169  return ConvertDialogToPixels( sz ).y;
170 }

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

Member Data Documentation

◆ DblClickDelay

constexpr int DIALOG_CHOOSE_COMPONENT::DblClickDelay = 100
staticprotected

Definition at line 147 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 199 of file dialog_choose_component.h.

Referenced by ConstructRightPanel().

◆ m_browser_button

wxButton* DIALOG_CHOOSE_COMPONENT::m_browser_button
protected

Definition at line 188 of file dialog_choose_component.h.

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

◆ m_config

wxConfigBase* DIALOG_CHOOSE_COMPONENT::m_config
protected

Definition at line 184 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 198 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 201 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 204 of file dialog_choose_component.h.

Referenced by GetFields(), and OnFootprintSelected().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 191 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_fp_override

wxString DIALOG_CHOOSE_COMPONENT::m_fp_override
protected

Definition at line 202 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 189 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 192 of file dialog_shim.h.

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

◆ m_parent

SCH_BASE_FRAME* DIALOG_CHOOSE_COMPONENT::m_parent
protected

Definition at line 197 of file dialog_choose_component.h.

Referenced by ConstructRightPanel().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 194 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 196 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 200 of file dialog_choose_component.h.

Referenced by ConstructRightPanel().

◆ m_symbol_preview

SYMBOL_PREVIEW_WIDGET* DIALOG_CHOOSE_COMPONENT::m_symbol_preview
protected

Definition at line 187 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_vsplitter

wxSplitterWindow* DIALOG_CHOOSE_COMPONENT::m_vsplitter
protected

Definition at line 190 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: