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, 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...
 
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 ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS 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...
 
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,
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 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  auto sizer = new wxBoxSizer( wxVERTICAL );
73 
74  // Use a slightly different layout, with a details pane spanning the entire window,
75  // if we're not showing footprints.
76  if( aShowFootprints )
77  {
78  m_hsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
79  wxSP_LIVE_UPDATE );
80 
81  //Avoid the splitter window being assigned as the Parent to additional windows
82  m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
83 
84  sizer->Add( m_hsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
85  }
86  else
87  {
88  m_vsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
89  wxSP_LIVE_UPDATE );
90 
91  m_hsplitter = new wxSplitterWindow( m_vsplitter, wxID_ANY, wxDefaultPosition, wxDefaultSize,
92  wxSP_LIVE_UPDATE );
93 
94  //Avoid the splitter window being assigned as the Parent to additional windows
95  m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
96 
97  auto detailsPanel = new wxPanel( m_vsplitter );
98  auto detailsSizer = new wxBoxSizer( wxVERTICAL );
99  detailsPanel->SetSizer( detailsSizer );
100 
101  m_details = new wxHtmlWindow( detailsPanel, wxID_ANY, wxDefaultPosition, wxDefaultSize,
102  wxHW_SCROLLBAR_AUTO );
103  detailsSizer->Add( m_details, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
104  detailsPanel->Layout();
105  detailsSizer->Fit( detailsPanel );
106 
107  m_vsplitter->SetSashGravity( 0.5 );
108  m_vsplitter->SetMinimumPaneSize( 20 );
109  m_vsplitter->SplitHorizontally( m_hsplitter, detailsPanel );
110 
111  sizer->Add( m_vsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
112  }
113 
114  m_tree = new LIB_TREE( m_hsplitter, Prj().SchSymbolLibTable(), aAdapter,
116 
117  m_hsplitter->SetSashGravity( 0.8 );
118  m_hsplitter->SetMinimumPaneSize( 20 );
119  m_hsplitter->SplitVertically( m_tree, ConstructRightPanel( m_hsplitter ) );
120 
121  m_dbl_click_timer = new wxTimer( this );
122 
123  auto buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
124 
125  if( aAllowBrowser )
126  {
127  m_browser_button = new wxButton( this, wxID_ANY, _( "Select with Browser" ) );
128  buttonsSizer->Add( m_browser_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
129  }
130 
131  auto sdbSizer = new wxStdDialogButtonSizer();
132  auto okButton = new wxButton( this, wxID_OK );
133  auto cancelButton = new wxButton( this, wxID_CANCEL );
134  sdbSizer->AddButton( okButton );
135  sdbSizer->AddButton( cancelButton );
136  sdbSizer->Realize();
137 
138  buttonsSizer->Add( sdbSizer, 1, wxALL, 5 );
139 
140  sizer->Add( buttonsSizer, 0, wxEXPAND | wxLEFT, 5 );
141  SetSizer( sizer );
142 
143  Layout();
144 
145  EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
146 
147  if( cfg )
148  {
150 
151  // We specify the width of the right window (m_symbol_view_panel), because specify
152  // the width of the left window does not work as expected when SetSashGravity() is called
153  m_hsplitter->SetSashPosition( panelCfg.sash_pos_h > 0 ? panelCfg.sash_pos_h :
154  HorizPixelsFromDU( 220 ) );
155 
156  if( m_vsplitter )
157  m_vsplitter->SetSashPosition( panelCfg.sash_pos_v > 0 ? panelCfg.sash_pos_v :
158  VertPixelsFromDU( 230 ) );
159 
160  wxSize dlgSize( panelCfg.width > 0 ? panelCfg.width : HorizPixelsFromDU( 390 ),
161  panelCfg.height > 0 ? panelCfg.height : VertPixelsFromDU( 300 ) );
162  SetSize( dlgSize );
163  }
164 
166  okButton->SetDefault();
167 
168  Bind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_COMPONENT::OnInitDialog, this );
169  Bind( wxEVT_TIMER, &DIALOG_CHOOSE_COMPONENT::OnCloseTimer, this, m_dbl_click_timer->GetId() );
170  Bind( COMPONENT_PRESELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentPreselected, this );
171  Bind( COMPONENT_SELECTED, &DIALOG_CHOOSE_COMPONENT::OnComponentSelected, this );
172 
173  if( m_browser_button )
174  m_browser_button->Bind( wxEVT_COMMAND_BUTTON_CLICKED,
176 
177  if( m_fp_sel_ctrl )
178  m_fp_sel_ctrl->Bind( EVT_FOOTPRINT_SELECTED,
180 
181  if( m_details )
182  m_details->Connect( wxEVT_CHAR_HOOK,
183  wxKeyEventHandler( DIALOG_CHOOSE_COMPONENT::OnCharHook ),
184  NULL, this );
185 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
void OnFootprintSelected(wxCommandEvent &aEvent)
SYMBOL_PREVIEW_WIDGET * m_symbol_preview
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:115
void OnComponentPreselected(wxCommandEvent &aEvent)
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)
#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)
Definition: hash_eda.h:46
void OnUseBrowser(wxCommandEvent &aEvent)
int VertPixelsFromDU(int y)
Convert an integer number of dialog units to pixels, vertically.
#define _(s)
Definition: 3d_actions.cpp:33
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(), 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, 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 188 of file dialog_choose_component.cpp.

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

230 {
231  wxPanel* panel = new wxPanel( aParent );
232  wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
234 
235  m_symbol_preview = new SYMBOL_PREVIEW_WIDGET( panel, Kiway(), backend );
236  m_symbol_preview->SetLayoutDirection( wxLayout_LeftToRight );
237 
238  if( m_show_footprints )
239  {
241 
242  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxTOP | wxBOTTOM | wxRIGHT, 5 );
243 
244  if ( fp_list )
245  {
246  if( m_allow_field_edits )
247  m_fp_sel_ctrl = new FOOTPRINT_SELECT_WIDGET( panel, fp_list, true );
248 
249  m_fp_preview = new FOOTPRINT_PREVIEW_WIDGET( panel, Kiway() );
250  }
251 
252  if( m_fp_sel_ctrl )
253  sizer->Add( m_fp_sel_ctrl, 0, wxEXPAND | wxBOTTOM | wxTOP | wxRIGHT, 5 );
254 
255  if( m_fp_preview )
256  sizer->Add( m_fp_preview, 1, wxEXPAND | wxBOTTOM | wxRIGHT, 5 );
257  }
258  else
259  {
260  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxTOP | wxRIGHT, 5 );
261  }
262 
263  auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
264 
265  m_keepSymbol = new wxCheckBox( panel, 1000, _("Multi-Symbol Placement"), wxDefaultPosition,
266  wxDefaultSize, wxALIGN_RIGHT );
267  m_keepSymbol->SetValue( cfg ? cfg->m_SymChooserPanel.keep_symbol : true );
268  m_keepSymbol->SetToolTip( _( "Place multiple copies of the symbol." ) );
269 
270  m_useUnits = new wxCheckBox( panel, 1000, _("Place all units"), wxDefaultPosition,
271  wxDefaultSize, wxALIGN_RIGHT );
272  m_useUnits->SetValue( cfg ? cfg->m_SymChooserPanel.place_all_units : true );
273  m_useUnits->SetToolTip( _( "Sequentially place all units of the symbol." ) );
274 
275  auto fgSizer = new wxFlexGridSizer( 0, 2, 0, 1 );
276  fgSizer->AddGrowableCol( 0 );
277  fgSizer->SetFlexibleDirection( wxBOTH );
278  fgSizer->SetNonFlexibleGrowMode( wxFLEX_GROWMODE_SPECIFIED );
279 
280  fgSizer->Add( 0, 0, 1, wxEXPAND );
281  fgSizer->Add( m_keepSymbol, 0, wxALIGN_CENTER_VERTICAL|wxALIGN_RIGHT|wxBOTTOM|wxRIGHT|wxLEFT, 5 );
282  fgSizer->Add( 0, 0, 1, wxEXPAND );
283  fgSizer->Add( m_useUnits, 0, wxALIGN_CENTER_VERTICAL|wxALIGN_RIGHT|wxBOTTOM|wxRIGHT|wxLEFT, 5 );
284 
285  sizer->Add( fgSizer, 0, wxALL | wxEXPAND, 5 );
286  panel->SetSizer( sizer );
287  panel->Layout();
288  sizer->Fit( panel );
289 
290  return panel;
291 }
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 264 of file dialog_shim.cpp.

265 {
266  // so we can do logging of this state change:
267 
268 #if 0 && defined(DEBUG)
269  const char* type_id = typeid( *this ).name();
270  printf( "DIALOG_SHIM %s: %s\n", type_id, enable ? "enabled" : "disabled" );
271  fflush(0); //Needed on msys2 to immediately print the message
272 #endif
273 
274  return wxDialog::Enable( enable );
275 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 421 of file dialog_shim.cpp.

422 {
423  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
424  // handle validation in the same way as other dialogs.
425  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
426  return;
427 
428  SetReturnCode( retCode );
429 
430  if( !IsQuasiModal() )
431  {
432  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
433  "wasn't called" );
434  return;
435  }
436 
437  if( m_qmodal_loop )
438  {
439  if( m_qmodal_loop->IsRunning() )
440  m_qmodal_loop->Exit( 0 );
441  else
442  m_qmodal_loop->ScheduleExit( 0 );
443 
445  }
446 
449 
450  Show( false );
451 }
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:205
#define NULL
bool IsQuasiModal()
Definition: dialog_shim.h:124
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:208

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

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

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC::DIALOG_DRC(), 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_EDITOR_DATA::DIALOG_EDITOR_DATA(), 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_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), 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_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_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), 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_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SCH_SHEET_PROPS::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), DIALOG_COLOR_PICKER::TransferDataToWindow(), and DIALOG_BOARD_STATISTICS::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 148 of file dialog_choose_component.h.

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

References m_field_edits.

Referenced by SCH_BASE_FRAME::SelectCompFromLibTree().

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

142 { 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 327 of file dialog_choose_component.cpp.

328 {
329  return m_tree->GetSelectedLibId( aUnit );
330 }
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:148

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().

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

132 { return m_useUnits->GetValue(); }

References m_useUnits.

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

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

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

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

159  {
161  }

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

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

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(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), 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_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), 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(), SAVE_AS_TRAVERSER::OnFile(), 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(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), 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(), SCH_EDIT_FRAME::SetCrossProbeConnection(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnCharHook()

void DIALOG_CHOOSE_COMPONENT::OnCharHook ( wxKeyEvent &  aEvt)
protected

Definition at line 307 of file dialog_choose_component.cpp.

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

References m_details.

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

◆ OnCloseTimer()

void DIALOG_CHOOSE_COMPONENT::OnCloseTimer ( wxTimerEvent &  aEvent)
protected

Definition at line 340 of file dialog_choose_component.cpp.

341 {
342  // Hack handler because of eaten MouseUp event. See
343  // DIALOG_CHOOSE_COMPONENT::OnComponentSelected for the beginning
344  // of this spaghetti noodle.
345 
346  auto state = wxGetMouseState();
347 
348  if( state.LeftIsDown() )
349  {
350  // Mouse hasn't been raised yet, so fire the timer again. Otherwise the
351  // purpose of this timer is defeated.
353  }
354  else
355  {
356  EndQuasiModal( wxID_OK );
357  }
358 }
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 481 of file dialog_choose_component.cpp.

482 {
483  int unit = 0;
484 
485  LIB_ID id = m_tree->GetSelectedLibId( &unit );
486 
487  if( id.IsValid() )
488  {
489  m_symbol_preview->DisplaySymbol( id, unit );
490 
491  ShowFootprintFor( id );
493  }
494  else
495  {
496  m_symbol_preview->SetStatusText( _( "No symbol selected" ) );
497 
499  m_fp_preview->SetStatusText( wxEmptyString );
500 
502  }
503 }
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:148
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 506 of file dialog_choose_component.cpp.

507 {
508  if( m_tree->GetSelectedLibId().IsValid() )
509  {
510  // Got a selection. We can't just end the modal dialog here, because
511  // wx leaks some events back to the parent window (in particular, the
512  // MouseUp following a double click).
513  //
514  // NOW, here's where it gets really fun. wxTreeListCtrl eats MouseUp.
515  // This isn't really feasible to bypass without a fully custom
516  // wxDataViewCtrl implementation, and even then might not be fully
517  // possible (docs are vague). To get around this, we use a one-shot
518  // timer to schedule the dialog close.
519  //
520  // See DIALOG_CHOOSE_COMPONENT::OnCloseTimer for the other end of this
521  // spaghetti noodle.
523  }
524 }
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:148
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 464 of file dialog_choose_component.cpp.

465 {
466  m_fp_override = aEvent.GetString();
467 
468  m_field_edits.erase( std::remove_if( m_field_edits.begin(), m_field_edits.end(),
469  []( std::pair<int, wxString> const& i )
470  {
471  return i.first == FOOTPRINT;
472  } ),
473  m_field_edits.end() );
474 
475  m_field_edits.emplace_back( std::make_pair( FOOTPRINT, m_fp_override ) );
476 
478 }
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, 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 294 of file dialog_choose_component.cpp.

295 {
297  {
298  // This hides the GAL panel and shows the status label
299  m_fp_preview->SetStatusText( wxEmptyString );
300  }
301 
302  if( m_fp_sel_ctrl )
303  m_fp_sel_ctrl->Load( Kiway(), Prj() );
304 }
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 322 of file dialog_shim.cpp.

323 {
324  if( m_firstPaintEvent )
325  {
326 #ifdef __WXMAC__
327  fixOSXCancelButtonIssue( this );
328 #endif
329 
330  selectAllInTextCtrls( GetChildren() );
331 
333  m_initialFocusTarget->SetFocus();
334  else
335  SetFocus(); // Focus the dialog itself
336 
337  m_firstPaintEvent = false;
338  }
339 
340  event.Skip();
341 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:203
bool m_firstPaintEvent
Definition: dialog_shim.h:202
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 333 of file dialog_choose_component.cpp.

334 {
336  EndQuasiModal( wxID_OK );
337 }
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 417 of file dialog_choose_component.cpp.

418 {
419  if( !m_fp_sel_ctrl )
420  return;
421 
423 
424  LIB_PART* symbol = nullptr;
425 
426  if( aLibId.IsValid() )
427  {
428  try
429  {
430  symbol = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
431  }
432  catch( const IO_ERROR& ioe )
433  {
434  wxLogError( wxString::Format( _( "Error occurred loading symbol %s from library %s."
435  "\n\n%s" ),
436  aLibId.GetLibItemName().wx_str(),
437  aLibId.GetLibNickname().wx_str(),
438  ioe.What() ) );
439  }
440  }
441 
442  if( symbol != nullptr )
443  {
444  LIB_PINS temp_pins;
445  LIB_FIELD* fp_field = symbol->GetField( FOOTPRINT );
446  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
447 
448  symbol->GetPins( temp_pins );
449 
450  m_fp_sel_ctrl->FilterByPinCount( temp_pins.size() );
455  }
456  else
457  {
459  m_fp_sel_ctrl->Disable();
460  }
461 }
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: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.
Define a library symbol object.
virtual bool Enable(bool aEnable=true) override
Enable or disable the control for input.
wxArrayString GetFootprints() const
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
#define _(s)
Definition: 3d_actions.cpp:33
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:298
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, 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:171

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), 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_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), 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_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), 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(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), DIALOG_EXPORT_SVG::ExportSVGFile(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), 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(), 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(), DRC::LoadRules(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), 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_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(), 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(), DIALOG_EDIT_COMPONENTS_LIBID::revertChanges(), 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(), GERBVIEW_FRAME::SetPageSettings(), KICAD_MANAGER_FRAME::SetProjectFileName(), EE_INSPECTION_TOOL::ShowDatasheet(), ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), 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(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), 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().

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

240 {
241  const char* hash_key;
242 
243  if( m_hash_key.size() )
244  {
245  // a special case like EDA_LIST_DIALOG, which has multiple uses.
246  hash_key = m_hash_key.c_str();
247  }
248  else
249  {
250  hash_key = typeid(*this).name();
251  }
252 
253  RECT_MAP::iterator it = class_map.find( hash_key );
254 
255  if( it == class_map.end() )
256  return;
257 
258  EDA_RECT rect = it->second;
259  rect.SetSize( 0, 0 );
260  class_map[ hash_key ] = rect;
261 }
std::string m_hash_key
Definition: dialog_shim.h:197
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_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY().

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

116  {
117  m_initialFocusTarget = aWindow;
118  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:203

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_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), 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_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_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_KEEPOUT_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:60

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

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

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

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

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), 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 390 of file dialog_choose_component.cpp.

391 {
393  return;
394 
395  if( aName == wxEmptyString )
396  {
397  m_fp_preview->SetStatusText( _( "No footprint specified" ) );
398  }
399  else
400  {
401  LIB_ID lib_id;
402 
403  if( lib_id.Parse( aName, LIB_ID::ID_PCB ) == -1 && lib_id.IsValid() )
404  {
406  m_fp_preview->CacheFootprint( lib_id );
407  m_fp_preview->DisplayFootprint( lib_id );
408  }
409  else
410  {
411  m_fp_preview->SetStatusText( _( "Invalid footprint specified" ) );
412  }
413  }
414 }
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 361 of file dialog_choose_component.cpp.

362 {
364  return;
365 
366  LIB_PART* symbol = nullptr;
367 
368  try
369  {
370  symbol = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
371  }
372  catch( const IO_ERROR& ioe )
373  {
374  wxLogError( wxString::Format( _( "Error loading symbol %s from library %s.\n\n%s" ),
375  aLibId.GetLibItemName().wx_str(),
376  aLibId.GetLibNickname().wx_str(),
377  ioe.What() ) );
378  }
379 
380  if( !symbol )
381  return;
382 
383  LIB_FIELD* fp_field = symbol->GetField( FOOTPRINT );
384  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
385 
386  ShowFootprint( fp_name );
387 }
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.
Define a library symbol object.
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
#define _(s)
Definition: 3d_actions.cpp:33
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:298
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, 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 367 of file dialog_shim.cpp.

368 {
369  // This is an exception safe way to zero a pointer before returning.
370  // Yes, even though DismissModal() clears this first normally, this is
371  // here in case there's an exception before the dialog is dismissed.
372  struct NULLER
373  {
374  void*& m_what;
375  NULLER( void*& aPtr ) : m_what( aPtr ) {}
376  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
377  } clear_this( (void*&) m_qmodal_loop );
378 
379  // release the mouse if it's currently captured as the window having it
380  // will be disabled when this dialog is shown -- but will still keep the
381  // capture making it impossible to do anything in the modal dialog itself
382  wxWindow* win = wxWindow::GetCapture();
383  if( win )
384  win->ReleaseMouse();
385 
386  // Get the optimal parent
387  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
388 
389  // Show the optimal parent
390  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
391 
392  wxASSERT_MSG( !m_qmodal_parent_disabler,
393  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
394 
395  // quasi-modal: disable only my "optimal" parent
397 
398 #ifdef __WXMAC__
399  // Apple in its infinite wisdom will raise a disabled window before even passing
400  // us the event, so we have no way to stop it. Instead, we must set an order on
401  // the windows so that the quasi-modal will be pushed in front of the disabled
402  // window when it is raised.
403  ReparentQuasiModal();
404 #endif
405  Show( true );
406 
407  m_qmodal_showing = true;
408 
409  WX_EVENT_LOOP event_loop;
410 
411  m_qmodal_loop = &event_loop;
412 
413  event_loop.Run();
414 
415  m_qmodal_showing = false;
416 
417  return GetReturnCode();
418 }
bool m_qmodal_showing
Definition: dialog_shim.h:207
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:205
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:208
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(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

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

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

Referenced by DIALOG_CHOOSE_COMPONENT().

Member Data Documentation

◆ DblClickDelay

constexpr int DIALOG_CHOOSE_COMPONENT::DblClickDelay = 100
staticprotected

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

Referenced by ConstructRightPanel().

◆ m_browser_button

wxButton* DIALOG_CHOOSE_COMPONENT::m_browser_button
protected

Definition at line 205 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 217 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 220 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 223 of file dialog_choose_component.h.

Referenced by GetFields(), and OnFootprintSelected().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 202 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_fp_override

wxString DIALOG_CHOOSE_COMPONENT::m_fp_override
protected

Definition at line 221 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 206 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 203 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 216 of file dialog_choose_component.h.

Referenced by ConstructRightPanel().

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 210 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook(), and DIALOG_DRC::OnDRCItemRClick().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 205 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 207 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 219 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 204 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 207 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: