KiCad PCB EDA Suite
DIALOG_CHOOSE_SYMBOL Class Reference

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

#include <dialog_choose_symbol.h>

Inheritance diagram for DIALOG_CHOOSE_SYMBOL:
DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

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

Static Public Member Functions

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

Static Public Attributes

static std::mutex g_Mutex
 

Protected Member Functions

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

Protected Attributes

wxTimer * m_dbl_click_timer
 
SYMBOL_PREVIEW_WIDGETm_symbol_preview
 
wxButton * m_browser_button
 
wxSplitterWindow * m_hsplitter
 
wxSplitterWindow * m_vsplitter
 
FOOTPRINT_SELECT_WIDGETm_fp_sel_ctrl
 
FOOTPRINT_PREVIEW_WIDGETm_fp_preview
 
wxCheckBox * m_keepSymbol
 
wxCheckBox * m_useUnits
 
LIB_TREEm_tree
 
wxHtmlWindow * m_details
 
SCH_BASE_FRAMEm_parent
 
int m_deMorganConvert
 
bool m_allow_field_edits
 
bool m_show_footprints
 
bool m_external_browser_requested
 
wxString m_fp_override
 
std::vector< std::pair< int, wxString > > m_field_edits
 
EDA_UNITS m_units
 
std::string m_hash_key
 
bool m_useCalculatedSize
 
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 symbol 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_SYMBOL dlg( this, title, adapter, 1 );
bool selected = ( dlg.ShowModal() != wxID_CANCEL );

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

Definition at line 87 of file dialog_choose_symbol.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_SYMBOL()

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

Create dialog to choose symbol.

Parameters
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 48 of file dialog_choose_symbol.cpp.

52  : DIALOG_SHIM( aParent, wxID_ANY, aTitle, wxDefaultPosition, wxDefaultSize,
53  wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ),
54  m_symbol_preview( nullptr ),
55  m_browser_button( nullptr ),
56  m_hsplitter( nullptr ),
57  m_vsplitter( nullptr ),
58  m_fp_sel_ctrl( nullptr ),
59  m_fp_preview( nullptr ),
60  m_keepSymbol( nullptr ),
61  m_useUnits( nullptr ),
62  m_tree( nullptr ),
63  m_details( nullptr ),
64  m_parent( aParent ),
65  m_deMorganConvert( aDeMorganConvert >= 0 ? aDeMorganConvert : 0 ),
66  m_allow_field_edits( aAllowFieldEdits ),
67  m_show_footprints( aShowFootprints ),
69 {
70  // Never show footprints in power symbol mode
71  if( aAdapter->GetFilter() == SYMBOL_TREE_MODEL_ADAPTER::CMP_FILTER_POWER )
72  m_show_footprints = false;
73 
74  wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
75 
76  // Use a slightly different layout, with a details pane spanning the entire window,
77  // if we're not showing footprints.
78  if( m_show_footprints )
79  {
80  m_hsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
81  wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );
82 
83  //Avoid the splitter window being assigned as the Parent to additional windows
84  m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
85 
86  sizer->Add( m_hsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
87  }
88  else
89  {
90  m_vsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
91  wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );
92 
93  m_hsplitter = new wxSplitterWindow( m_vsplitter, wxID_ANY, wxDefaultPosition, wxDefaultSize,
94  wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );
95 
96  //Avoid the splitter window being assigned as the Parent to additional windows
97  m_vsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
98  m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
99 
100  wxPanel* detailsPanel = new wxPanel( m_vsplitter );
101  wxBoxSizer* 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  wxPanel* treePanel = new wxPanel( m_hsplitter );
118  wxBoxSizer* treeSizer = new wxBoxSizer( wxVERTICAL );
119  treePanel->SetSizer( treeSizer );
120 
121  m_tree = new LIB_TREE( treePanel, Prj().SchSymbolLibTable(), aAdapter, LIB_TREE::WIDGETS::ALL,
122  m_details );
123 
124  treeSizer->Add( m_tree, 1, wxEXPAND | wxALL, 5 );
125  treePanel->Layout();
126  treeSizer->Fit( treePanel );
127 
128  aAdapter->FinishTreeInitialization();
129 
130  m_hsplitter->SetSashGravity( 0.8 );
131  m_hsplitter->SetMinimumPaneSize( 20 );
132  m_hsplitter->SplitVertically( treePanel, ConstructRightPanel( m_hsplitter ) );
133 
134  m_dbl_click_timer = new wxTimer( this );
135 
136  wxBoxSizer* buttonsSizer = new wxBoxSizer( wxHORIZONTAL );
137 
138  if( aAllowBrowser )
139  {
140  m_browser_button = new wxButton( this, wxID_ANY, _( "Select with Browser" ) );
141  buttonsSizer->Add( m_browser_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
142  }
143 
144  m_keepSymbol = new wxCheckBox( this, wxID_ANY, _("Place repeated copies"), wxDefaultPosition,
145  wxDefaultSize, wxALIGN_RIGHT );
146  m_keepSymbol->SetToolTip( _( "Keep the symbol selected for subsequent clicks." ) );
147 
148  m_useUnits = new wxCheckBox( this, wxID_ANY, _("Place all units"), wxDefaultPosition,
149  wxDefaultSize, wxALIGN_RIGHT );
150  m_useUnits->SetToolTip( _( "Sequentially place all units of the symbol." ) );
151 
152  if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
153  {
154  m_keepSymbol->SetValue( cfg->m_SymChooserPanel.keep_symbol );
155  m_useUnits->SetValue( cfg->m_SymChooserPanel.place_all_units );
156  }
157 
158  buttonsSizer->Add( m_keepSymbol, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
159  buttonsSizer->Add( m_useUnits, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
160 
161  wxStdDialogButtonSizer* sdbSizer = new wxStdDialogButtonSizer();
162  wxButton* okButton = new wxButton( this, wxID_OK );
163  wxButton* cancelButton = new wxButton( this, wxID_CANCEL );
164 
165  sdbSizer->AddButton( okButton );
166  sdbSizer->AddButton( cancelButton );
167  sdbSizer->Realize();
168 
169  buttonsSizer->Add( sdbSizer, 1, wxALL, 5 );
170 
171  sizer->Add( buttonsSizer, 0, wxEXPAND | wxLEFT, 5 );
172  SetSizer( sizer );
173 
174  Layout();
175 
176  if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
177  {
178  EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER& panelCfg = cfg->m_SymChooserPanel;
179 
180  // We specify the width of the right window (m_symbol_view_panel), because specify
181  // the width of the left window does not work as expected when SetSashGravity() is called
182  m_hsplitter->SetSashPosition( panelCfg.sash_pos_h > 0 ? panelCfg.sash_pos_h :
183  horizPixelsFromDU( 220 ) );
184 
185  if( m_vsplitter )
186  {
187  m_vsplitter->SetSashPosition( panelCfg.sash_pos_v > 0 ? panelCfg.sash_pos_v :
188  vertPixelsFromDU( 230 ) );
189  }
190 
191  wxSize dlgSize( panelCfg.width > 0 ? panelCfg.width : horizPixelsFromDU( 390 ),
192  panelCfg.height > 0 ? panelCfg.height : vertPixelsFromDU( 300 ) );
193  SetSize( dlgSize );
194  }
195 
197  okButton->SetDefault();
198 
199  Bind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_SYMBOL::OnInitDialog, this );
200  Bind( wxEVT_TIMER, &DIALOG_CHOOSE_SYMBOL::OnCloseTimer, this, m_dbl_click_timer->GetId() );
201  Bind( COMPONENT_PRESELECTED, &DIALOG_CHOOSE_SYMBOL::OnComponentPreselected, this );
202  Bind( COMPONENT_SELECTED, &DIALOG_CHOOSE_SYMBOL::OnComponentSelected, this );
203 
204  if( m_browser_button )
205  {
206  m_browser_button->Bind( wxEVT_COMMAND_BUTTON_CLICKED, &DIALOG_CHOOSE_SYMBOL::OnUseBrowser,
207  this );
208  }
209 
210  if( m_fp_sel_ctrl )
211  {
212  m_fp_sel_ctrl->Bind( EVT_FOOTPRINT_SELECTED, &DIALOG_CHOOSE_SYMBOL::OnFootprintSelected,
213  this );
214  }
215 
216  if( m_details )
217  {
218  m_details->Connect( wxEVT_CHAR_HOOK, wxKeyEventHandler( DIALOG_CHOOSE_SYMBOL::OnCharHook ),
219  NULL, this );
220  }
221 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
void OnCharHook(wxKeyEvent &aEvt) override
SYMBOL_PREVIEW_WIDGET * m_symbol_preview
wxWindow * GetFocusTarget()
Definition: lib_tree.cpp:226
void OnFootprintSelected(wxCommandEvent &aEvent)
int horizPixelsFromDU(int x) const
Convert an integer number of dialog units to pixels, horizontally.
void OnComponentPreselected(wxCommandEvent &aEvent)
All except INITIAL_ADD.
Definition: view_item.h:58
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:98
void OnUseBrowser(wxCommandEvent &aEvent)
wxSplitterWindow * m_hsplitter
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:75
wxPanel * ConstructRightPanel(wxWindow *aParent)
wxSplitterWindow * m_vsplitter
void OnInitDialog(wxInitDialogEvent &aEvent)
#define NULL
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
void OnComponentSelected(wxCommandEvent &aEvent)
Handle the selection of an item.
void OnCloseTimer(wxTimerEvent &aEvent)
#define _(s)
Definition: 3d_actions.cpp:33
int vertPixelsFromDU(int y) const
Convert an integer number of dialog units to pixels, vertically.
Widget displaying a tree of components with optional search text control and description panel....
Definition: lib_tree.h:42

References _, KIGFX::ALL, LIB_TREE_MODEL_ADAPTER::CMP_FILTER_POWER, ConstructRightPanel(), LIB_TREE::GetFocusTarget(), EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER::height, DIALOG_SHIM::horizPixelsFromDU(), Kiface(), m_browser_button, m_dbl_click_timer, m_details, m_fp_sel_ctrl, m_hsplitter, m_keepSymbol, m_show_footprints, m_tree, m_useUnits, 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_SYMBOL()

DIALOG_CHOOSE_SYMBOL::~DIALOG_CHOOSE_SYMBOL ( )

Definition at line 224 of file dialog_choose_symbol.cpp.

225 {
226  Unbind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_SYMBOL::OnInitDialog, this );
227  Unbind( wxEVT_TIMER, &DIALOG_CHOOSE_SYMBOL::OnCloseTimer, this );
228  Unbind( COMPONENT_PRESELECTED, &DIALOG_CHOOSE_SYMBOL::OnComponentPreselected, this );
229  Unbind( COMPONENT_SELECTED, &DIALOG_CHOOSE_SYMBOL::OnComponentSelected, this );
230 
231  if( m_browser_button )
232  {
233  m_browser_button->Unbind( wxEVT_COMMAND_BUTTON_CLICKED,
235  }
236 
237  if( m_fp_sel_ctrl )
238  {
239  m_fp_sel_ctrl->Unbind( EVT_FOOTPRINT_SELECTED, &DIALOG_CHOOSE_SYMBOL::OnFootprintSelected,
240  this );
241  }
242 
243  if( m_details )
244  {
245  m_details->Disconnect( wxEVT_CHAR_HOOK,
246  wxKeyEventHandler( DIALOG_CHOOSE_SYMBOL::OnCharHook ), NULL, this );
247  }
248 
249  // I am not sure the following two lines are necessary, but they will not hurt anyone
250  m_dbl_click_timer->Stop();
251  delete m_dbl_click_timer;
252 
253  if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
254  {
255  cfg->m_SymChooserPanel.width = GetSize().x;
256  cfg->m_SymChooserPanel.height = GetSize().y;
257 
258  cfg->m_SymChooserPanel.keep_symbol = m_keepSymbol->GetValue();
259  cfg->m_SymChooserPanel.place_all_units = m_useUnits->GetValue();
260 
261  cfg->m_SymChooserPanel.sash_pos_h = m_hsplitter->GetSashPosition();
262 
263  if( m_vsplitter )
264  cfg->m_SymChooserPanel.sash_pos_v = m_vsplitter->GetSashPosition();
265  }
266 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
void OnCharHook(wxKeyEvent &aEvt) override
void OnFootprintSelected(wxCommandEvent &aEvent)
void OnComponentPreselected(wxCommandEvent &aEvent)
void OnUseBrowser(wxCommandEvent &aEvent)
wxSplitterWindow * m_hsplitter
wxSplitterWindow * m_vsplitter
void OnInitDialog(wxInitDialogEvent &aEvent)
#define NULL
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
void OnComponentSelected(wxCommandEvent &aEvent)
Handle the selection of an item.
void OnCloseTimer(wxTimerEvent &aEvent)

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_SYMBOL::ConstructRightPanel ( wxWindow *  aParent)
protected

Definition at line 269 of file dialog_choose_symbol.cpp.

270 {
271  wxPanel* panel = new wxPanel( aParent );
272  wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
274 
275  m_symbol_preview = new SYMBOL_PREVIEW_WIDGET( panel, Kiway(), backend );
276  m_symbol_preview->SetLayoutDirection( wxLayout_LeftToRight );
277 
278  if( m_show_footprints )
279  {
281 
282  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxALL, 5 );
283 
284  if ( fp_list )
285  {
286  if( m_allow_field_edits )
287  m_fp_sel_ctrl = new FOOTPRINT_SELECT_WIDGET( m_parent, panel, fp_list, true );
288 
289  m_fp_preview = new FOOTPRINT_PREVIEW_WIDGET( panel, Kiway() );
290  }
291 
292  if( m_fp_sel_ctrl )
293  sizer->Add( m_fp_sel_ctrl, 0, wxEXPAND | wxTOP | wxLEFT | wxRIGHT, 3 );
294 
295  if( m_fp_preview )
296  sizer->Add( m_fp_preview, 1, wxEXPAND | wxALL, 5 );
297  }
298  else
299  {
300  sizer->Add( m_symbol_preview, 1, wxEXPAND | wxALL, 5 );
301  }
302 
303  panel->SetSizer( sizer );
304  panel->Layout();
305  sizer->Fit( panel );
306 
307  return panel;
308 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
KIWAY & Kiway() const
Return 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.
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
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...
GAL_TYPE GetBackend() const
Return 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_SYMBOL().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 307 of file dialog_shim.cpp.

308 {
309  // so we can do logging of this state change:
310  return wxDialog::Enable( enable );
311 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 445 of file dialog_shim.cpp.

446 {
447  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
448  // handle validation in the same way as other dialogs.
449  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
450  return;
451 
452  SetReturnCode( retCode );
453 
454  if( !IsQuasiModal() )
455  {
456  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
457  "wasn't called" );
458  return;
459  }
460 
461  if( m_qmodal_loop )
462  {
463  if( m_qmodal_loop->IsRunning() )
464  m_qmodal_loop->Exit( 0 );
465  else
466  m_qmodal_loop->ScheduleExit( 0 );
467 
468  m_qmodal_loop = nullptr;
469  }
470 
472  m_qmodal_parent_disabler = nullptr;
473 
474  Show( false );
475 }
bool IsQuasiModal() const
Definition: dialog_shim.h:107
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:212
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:215

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_LIB_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_SYMBOL_PROPERTIES::OnEditLibrarySymbol(), DIALOG_SYMBOL_PROPERTIES::OnEditSymbol(), DIALOG_SYMBOL_PROPERTIES::OnExchangeSymbol(), HTML_MESSAGE_BOX::OnOKButtonClick(), DIALOG_SYMBOL_PROPERTIES::OnUpdateSymbol(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), OnUseBrowser(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ finishDialogSettings()

void DIALOG_SHIM::finishDialogSettings ( )
protectedinherited

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

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

Definition at line 148 of file dialog_shim.cpp.

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

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_IMPORTED_LAYERS::DIALOG_IMPORTED_LAYERS(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_LOCKED_ITEMS_QUERY::DIALOG_LOCKED_ITEMS_QUERY(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_REGULATOR_FORM::DIALOG_REGULATOR_FORM(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SHEET_PROPERTIES::OnInitDlg(), DIALOG_SYMBOL_PROPERTIES::OnInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_BOARD_STATISTICS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetFields()

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

Get a list of fields edited by the user.

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

Definition at line 150 of file dialog_choose_symbol.h.

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

References m_field_edits.

Referenced by SCH_BASE_FRAME::PickSymbolFromLibTree().

◆ GetKeepSymbol()

bool DIALOG_CHOOSE_SYMBOL::GetKeepSymbol ( ) const
inline

To be called after this dialog returns from ShowModal()

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

Returns
The value of the keep symbol preference checkbox.

Definition at line 143 of file dialog_choose_symbol.h.

143 { return m_keepSymbol->GetValue(); }

References m_keepSymbol.

◆ GetSelectedLibId()

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

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

For multi-unit symbols, if the user selects the 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 346 of file dialog_choose_symbol.cpp.

347 {
348  return m_tree->GetSelectedLibId( aUnit );
349 }
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:150

References LIB_TREE::GetSelectedLibId(), and m_tree.

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

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUseAllUnits()

bool DIALOG_CHOOSE_SYMBOL::GetUseAllUnits ( ) const
inline

To be called after this dialog returns from ShowModal()

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

Returns
The value of the dialog preference checkbox.

Definition at line 133 of file dialog_choose_symbol.h.

133 { return m_useUnits->GetValue(); }

References m_useUnits.

◆ GetUserUnits()

◆ horizPixelsFromDU()

int DIALOG_SHIM::horizPixelsFromDU ( int  x) const
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 166 of file dialog_shim.cpp.

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

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

◆ IsCtrl()

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

Definition at line 125 of file dialog_shim.h.

126  {
127  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
128  !e.ShiftDown() && !e.MetaDown();
129  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsExternalBrowserSelected()

bool DIALOG_CHOOSE_SYMBOL::IsExternalBrowserSelected ( ) const
inline
Returns
true if the user requested the symbol browser.

Definition at line 158 of file dialog_choose_symbol.h.

159  {
161  }

References m_external_browser_requested.

Referenced by SCH_BASE_FRAME::PickSymbolFromLibTree().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 131 of file dialog_shim.h.

132  {
133  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
134  e.ShiftDown() && !e.MetaDown();
135  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

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

References KIWAY_HOLDER::m_kiway.

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

◆ OnCharHook()

void DIALOG_CHOOSE_SYMBOL::OnCharHook ( wxKeyEvent &  aEvt)
overrideprotectedvirtual

Reimplemented from DIALOG_SHIM.

Definition at line 324 of file dialog_choose_symbol.cpp.

325 {
326  if( m_details && e.GetKeyCode() == 'C' && e.ControlDown() &&
327  !e.AltDown() && !e.ShiftDown() && !e.MetaDown() )
328  {
329  wxString txt = m_details->SelectionToText();
330  wxLogNull doNotLog; // disable logging of failed clipboard actions
331 
332  if( wxTheClipboard->Open() )
333  {
334  wxTheClipboard->SetData( new wxTextDataObject( txt ) );
335  wxTheClipboard->Flush(); // Allow data to be available after closing KiCad
336  wxTheClipboard->Close();
337  }
338  }
339  else
340  {
341  e.Skip();
342  }
343 }

References m_details.

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

◆ OnCloseTimer()

void DIALOG_CHOOSE_SYMBOL::OnCloseTimer ( wxTimerEvent &  aEvent)
protected

Definition at line 365 of file dialog_choose_symbol.cpp.

366 {
367  // Hack handler because of eaten MouseUp event. See
368  // DIALOG_CHOOSE_COMPONENT::OnComponentSelected for the beginning
369  // of this spaghetti noodle.
370 
371  auto state = wxGetMouseState();
372 
373  if( state.LeftIsDown() )
374  {
375  // Mouse hasn't been raised yet, so fire the timer again. Otherwise the
376  // purpose of this timer is defeated.
378  }
379  else
380  {
381  if( IsQuasiModal() )
382  EndQuasiModal( wxID_OK );
383  else if( IsModal() )
384  EndModal( wxID_OK );
385  else
386  wxFAIL_MSG( "Dialog called with neither Modal nor QuasiModal" );
387  }
388 }
bool IsQuasiModal() const
Definition: dialog_shim.h:107
static constexpr int DblClickDelay
void EndQuasiModal(int retCode)

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

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

◆ OnComponentPreselected()

void DIALOG_CHOOSE_SYMBOL::OnComponentPreselected ( wxCommandEvent &  aEvent)
protected

Definition at line 510 of file dialog_choose_symbol.cpp.

511 {
512  int unit = 0;
513 
514  LIB_ID id = m_tree->GetSelectedLibId( &unit );
515 
516  if( id.IsValid() )
517  {
518  m_symbol_preview->DisplaySymbol( id, unit );
519 
520  ShowFootprintFor( id );
522  }
523  else
524  {
525  m_symbol_preview->SetStatusText( _( "No symbol selected" ) );
526 
528  m_fp_preview->SetStatusText( wxEmptyString );
529 
531  }
532 }
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 ShowFootprintFor(LIB_ID const &aLibId)
Look up the footprint for a given symbol specified in the LIB_ID and display it.
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
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:150
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
void PopulateFootprintSelector(LIB_ID const &aLibId)
Populate the footprint selector for a given alias.
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_SYMBOL(), and ~DIALOG_CHOOSE_SYMBOL().

◆ OnComponentSelected()

void DIALOG_CHOOSE_SYMBOL::OnComponentSelected ( wxCommandEvent &  aEvent)
protected

Handle the selection of an item.

This is called when either the search box or the tree receive an Enter, or the tree receives a double click. If the item selected is a category, it is expanded or collapsed; if it is a symbol, the symbol is picked.

Definition at line 535 of file dialog_choose_symbol.cpp.

536 {
537  if( m_tree->GetSelectedLibId().IsValid() )
538  {
539  // Got a selection. We can't just end the modal dialog here, because
540  // wx leaks some events back to the parent window (in particular, the
541  // MouseUp following a double click).
542  //
543  // NOW, here's where it gets really fun. wxTreeListCtrl eats MouseUp.
544  // This isn't really feasible to bypass without a fully custom
545  // wxDataViewCtrl implementation, and even then might not be fully
546  // possible (docs are vague). To get around this, we use a one-shot
547  // timer to schedule the dialog close.
548  //
549  // See DIALOG_CHOOSE_COMPONENT::OnCloseTimer for the other end of this
550  // spaghetti noodle.
552  }
553 }
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:168
static constexpr int DblClickDelay
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:150

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

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

◆ OnFootprintSelected()

void DIALOG_CHOOSE_SYMBOL::OnFootprintSelected ( wxCommandEvent &  aEvent)
protected

Definition at line 493 of file dialog_choose_symbol.cpp.

494 {
495  m_fp_override = aEvent.GetString();
496 
497  m_field_edits.erase( std::remove_if( m_field_edits.begin(), m_field_edits.end(),
498  []( std::pair<int, wxString> const& i )
499  {
500  return i.first == FOOTPRINT_FIELD;
501  } ),
502  m_field_edits.end() );
503 
504  m_field_edits.emplace_back( std::make_pair( FOOTPRINT_FIELD, m_fp_override ) );
505 
507 }
std::vector< std::pair< int, wxString > > m_field_edits
void ShowFootprint(wxString const &aFootprint)
Display the given footprint by name.
Field Name Module PCB, i.e. "16DIP300".

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

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

◆ OnInitDialog()

void DIALOG_CHOOSE_SYMBOL::OnInitDialog ( wxInitDialogEvent &  aEvent)
protected

Definition at line 311 of file dialog_choose_symbol.cpp.

312 {
314  {
315  // This hides the GAL panel and shows the status label
316  m_fp_preview->SetStatusText( wxEmptyString );
317  }
318 
319  if( m_fp_sel_ctrl )
320  m_fp_sel_ctrl->Load( Kiway(), Prj() );
321 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
void SetStatusText(wxString const &aText)
Set the contents of the status label and display it.
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_SYMBOL(), and ~DIALOG_CHOOSE_SYMBOL().

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 352 of file dialog_shim.cpp.

353 {
354  if( m_firstPaintEvent )
355  {
357 
358  selectAllInTextCtrls( GetChildren() );
359 
362  else
363  KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
364 
365  m_firstPaintEvent = false;
366  }
367 
368  event.Skip();
369 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:210
bool m_firstPaintEvent
Definition: dialog_shim.h:209
void ForceFocus(wxWindow *aWindow)
Pass the current focus to the window.
Definition: gtk/ui.cpp:44
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:71
static void selectAllInTextCtrls(wxWindowList &children)

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

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnUseBrowser()

void DIALOG_CHOOSE_SYMBOL::OnUseBrowser ( wxCommandEvent &  aEvent)
protected

Definition at line 352 of file dialog_choose_symbol.cpp.

353 {
355 
356  if( IsQuasiModal() )
357  EndQuasiModal( wxID_OK );
358  else if( IsModal() )
359  EndModal( wxID_OK );
360  else
361  wxFAIL_MSG( "Dialog called with neither Modal nor QuasiModal" );
362 }
bool IsQuasiModal() const
Definition: dialog_shim.h:107
void EndQuasiModal(int retCode)

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

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

◆ PopulateFootprintSelector()

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

447 {
448  if( !m_fp_sel_ctrl )
449  return;
450 
452 
453  LIB_PART* symbol = nullptr;
454 
455  if( aLibId.IsValid() )
456  {
457  try
458  {
459  symbol = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
460  }
461  catch( const IO_ERROR& ioe )
462  {
463  wxLogError( wxString::Format( _( "Error occurred loading symbol %s from library %s."
464  "\n\n%s" ),
465  aLibId.GetLibItemName().wx_str(),
466  aLibId.GetLibNickname().wx_str(),
467  ioe.What() ) );
468  }
469  }
470 
471  if( symbol != nullptr )
472  {
473  LIB_PINS temp_pins;
474  LIB_FIELD* fp_field = symbol->GetFieldById( FOOTPRINT_FIELD );
475  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
476 
477  symbol->GetPins( temp_pins );
478 
479  m_fp_sel_ctrl->FilterByPinCount( temp_pins.size() );
484  }
485  else
486  {
488  m_fp_sel_ctrl->Disable();
489  }
490 }
FOOTPRINT_SELECT_WIDGET * m_fp_sel_ctrl
void FilterByFootprintFilters(wxArrayString const &aFilters, bool aZeroFilters)
Filter by footprint filter list.
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:56
Field object used in symbol libraries.
Definition: lib_field.h:59
void SetDefaultFootprint(wxString const &aFp)
Set the default footprint for a part.
wxArrayString GetFPFilters() const
Definition: lib_symbol.h:179
void ClearFilters()
Clear all filters.
bool UpdateList()
Update the contents of the list to match the filters.
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
void GetPins(LIB_PINS &aList, int aUnit=0, int aConvert=0) const
Return a list of pin object pointers from the draw item list.
Definition: lib_symbol.cpp:695
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Define a library symbol object.
Definition: lib_symbol.h:93
virtual bool Enable(bool aEnable=true) override
Enable or disable the control for input.
LIB_FIELD * GetFieldById(int aId) const
Return pointer to the requested field.
Definition: lib_symbol.cpp:941
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:296
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
void FilterByPinCount(int aPinCount)
Filter by pin count.
Field Name Module PCB, i.e. "16DIP300".

References _, FOOTPRINT_SELECT_WIDGET::ClearFilters(), FOOTPRINT_SELECT_WIDGET::Enable(), FOOTPRINT_SELECT_WIDGET::FilterByFootprintFilters(), FOOTPRINT_SELECT_WIDGET::FilterByPinCount(), FOOTPRINT_FIELD, Format(), LIB_PART::GetFieldById(), LIB_PART::GetFPFilters(), 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

Return 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
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:184

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

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

◆ resetSize()

void DIALOG_SHIM::resetSize ( )
protectedinherited

Clear the existing dialog size and position.

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

Definition at line 282 of file dialog_shim.cpp.

283 {
284  const char* hash_key;
285 
286  if( m_hash_key.size() )
287  {
288  // a special case like EDA_LIST_DIALOG, which has multiple uses.
289  hash_key = m_hash_key.c_str();
290  }
291  else
292  {
293  hash_key = typeid(*this).name();
294  }
295 
296  RECT_MAP::iterator it = class_map.find( hash_key );
297 
298  if( it == class_map.end() )
299  return;
300 
301  EDA_RECT rect = it->second;
302  rect.SetSize( 0, 0 );
303  class_map[ hash_key ] = rect;
304 }
std::string m_hash_key
Definition: dialog_shim.h:200
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:139
Handle the component boundary box.
Definition: eda_rect.h:42

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

Referenced by DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES().

◆ SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow)
inlineinherited

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

Definition at line 98 of file dialog_shim.h.

99  {
100  m_initialFocusTarget = aWindow;
101  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:210

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL(), 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_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_INSPECTION_REPORTER::DIALOG_INSPECTION_REPORTER(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDA_VIEW_SWITCHER::EDA_VIEW_SWITCHER(), HK_PROMPT_DIALOG::HK_PROMPT_DIALOG(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::savePartAs(), DIALOG_RULE_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_COPPER_ZONE::TransferDataToWindow(), and WX_TEXT_ENTRY_DIALOG::WX_TEXT_ENTRY_DIALOG().

◆ SetKiway()

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

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

"this" is a KIWAY_HOLDER mix-in.

Parameters
aDestis the recipient of aKiway pointer.
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:78
const char * name
Definition: DXF_plotter.cpp:59

References KIWAY_HOLDER::m_kiway, and name.

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

◆ SetPosition()

void DIALOG_SHIM::SetPosition ( const wxPoint &  aNewPosition)
inherited

Force the position of the dialog to a new position.

Parameters
aNewPositionis the new forced position

Definition at line 187 of file dialog_shim.cpp.

188 {
189  wxDialog::SetPosition( aNewPosition );
190 
191  // Now update the stored position:
192  const char* hash_key;
193 
194  if( m_hash_key.size() )
195  {
196  // a special case like EDA_LIST_DIALOG, which has multiple uses.
197  hash_key = m_hash_key.c_str();
198  }
199  else
200  {
201  hash_key = typeid(*this).name();
202  }
203 
204  RECT_MAP::iterator it = class_map.find( hash_key );
205 
206  if( it == class_map.end() )
207  return;
208 
209  EDA_RECT rect = it->second;
210  rect.SetOrigin( aNewPosition );
211 
212  class_map[ hash_key ] = rect;
213 }
void SetPosition(wxString aStr, const wxString &aDefaultMeasurementUnit, int *aX, int *aY, const wxString &aActualConversion)
std::string m_hash_key
Definition: dialog_shim.h:200
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:126
static RECT_MAP class_map
Handle the component boundary box.
Definition: eda_rect.h:42

References class_map, DIALOG_SHIM::m_hash_key, EDA_RECT::SetOrigin(), and PCAD2KICAD::SetPosition().

Referenced by DIALOG_SCH_FIND::DIALOG_SCH_FIND(), and PCB_BASE_FRAME::SelectOneLayer().

◆ setSizeInDU()

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

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

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

Definition at line 159 of file dialog_shim.cpp.

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

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

217 {
218  bool ret;
219  const char* hash_key;
220 
221  if( m_hash_key.size() )
222  {
223  // a special case like EDA_LIST_DIALOG, which has multiple uses.
224  hash_key = m_hash_key.c_str();
225  }
226  else
227  {
228  hash_key = typeid(*this).name();
229  }
230 
231  // Show or hide the window. If hiding, save current position and size.
232  // If showing, use previous position and size.
233  if( show )
234  {
235 #ifndef __WINDOWS__
236  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
237 #endif
238  ret = wxDialog::Show( show );
239 
240  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
241  EDA_RECT savedDialogRect = class_map[ hash_key ];
242 
243  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
244  {
245  if( m_useCalculatedSize )
246  {
247  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
248  wxDialog::GetSize().x, wxDialog::GetSize().y, 0 );
249  }
250  else
251  {
252  SetSize( savedDialogRect.GetPosition().x, savedDialogRect.GetPosition().y,
253  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
254  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
255  0 );
256  }
257  }
258 
259  // Be sure that the dialog appears in a visible area
260  // (the dialog position might have been stored at the time when it was
261  // shown on another display)
262  if( wxDisplay::GetFromWindow( this ) == wxNOT_FOUND )
263  Centre();
264  }
265  else
266  {
267  // Save the dialog's position & size before hiding, using classname as key
268  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
269 
270 #ifdef __WXMAC__
271  if ( m_eventLoop )
272  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
273 #endif
274 
275  ret = wxDialog::Show( show );
276  }
277 
278  return ret;
279 }
std::string m_hash_key
Definition: dialog_shim.h:200
static RECT_MAP class_map
const wxPoint GetPosition() const
Definition: eda_rect.h:107
Handle the component boundary box.
Definition: eda_rect.h:42
bool m_useCalculatedSize
Definition: dialog_shim.h:204
const wxSize GetSize() const
Definition: eda_rect.h:96

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

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

◆ ShowFootprint()

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

Display the given footprint by name.

Definition at line 420 of file dialog_choose_symbol.cpp.

421 {
423  return;
424 
425  if( aName == wxEmptyString )
426  {
427  m_fp_preview->SetStatusText( _( "No footprint specified" ) );
428  }
429  else
430  {
431  LIB_ID lib_id;
432 
433  if( lib_id.Parse( aName ) == -1 && lib_id.IsValid() )
434  {
436  m_fp_preview->DisplayFootprint( lib_id );
437  }
438  else
439  {
440  m_fp_preview->SetStatusText( _( "Invalid footprint specified" ) );
441  }
442  }
443 }
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:168
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
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.
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:122
#define _(s)
Definition: 3d_actions.cpp:33
void DisplayFootprint(const LIB_ID &aFPID)
Set the currently displayed footprint.
bool IsInitialized() const
Return whether the widget initialized properly.

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

Referenced by OnFootprintSelected(), and ShowFootprintFor().

◆ ShowFootprintFor()

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

392 {
394  return;
395 
396  LIB_PART* symbol = nullptr;
397 
398  try
399  {
400  symbol = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
401  }
402  catch( const IO_ERROR& ioe )
403  {
404  wxLogError( wxString::Format( _( "Error loading symbol %s from library %s.\n\n%s" ),
405  aLibId.GetLibItemName().wx_str(),
406  aLibId.GetLibNickname().wx_str(),
407  ioe.What() ) );
408  }
409 
410  if( !symbol )
411  return;
412 
413  LIB_FIELD* fp_field = symbol->GetFieldById( FOOTPRINT_FIELD );
414  wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );
415 
416  ShowFootprint( fp_name );
417 }
Field object used in symbol libraries.
Definition: lib_field.h:59
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
FOOTPRINT_PREVIEW_WIDGET * m_fp_preview
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
Define a library symbol object.
Definition: lib_symbol.h:93
LIB_FIELD * GetFieldById(int aId) const
Return pointer to the requested field.
Definition: lib_symbol.cpp:941
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
wxString GetFullText(int unit=1) const
Return the text of a field.
Definition: lib_field.cpp:296
bool IsInitialized() const
Return whether the widget initialized properly.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
void ShowFootprint(wxString const &aFootprint)
Display the given footprint by name.
Field Name Module PCB, i.e. "16DIP300".

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

Referenced by OnComponentPreselected().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 395 of file dialog_shim.cpp.

396 {
397  // This is an exception safe way to zero a pointer before returning.
398  // Yes, even though DismissModal() clears this first normally, this is
399  // here in case there's an exception before the dialog is dismissed.
400  struct NULLER
401  {
402  void*& m_what;
403  NULLER( void*& aPtr ) : m_what( aPtr ) {}
404  ~NULLER() { m_what = nullptr; } // indeed, set it to NULL on destruction
405  } clear_this( (void*&) m_qmodal_loop );
406 
407  // release the mouse if it's currently captured as the window having it
408  // will be disabled when this dialog is shown -- but will still keep the
409  // capture making it impossible to do anything in the modal dialog itself
410  wxWindow* win = wxWindow::GetCapture();
411  if( win )
412  win->ReleaseMouse();
413 
414  // Get the optimal parent
415  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
416 
417  wxASSERT_MSG( !m_qmodal_parent_disabler,
418  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
419 
420  // quasi-modal: disable only my "optimal" parent
422 
423  // Apple in its infinite wisdom will raise a disabled window before even passing
424  // us the event, so we have no way to stop it. Instead, we must set an order on
425  // the windows so that the quasi-modal will be pushed in front of the disabled
426  // window when it is raised.
428 
429  Show( true );
430 
431  m_qmodal_showing = true;
432 
433  WX_EVENT_LOOP event_loop;
434 
435  m_qmodal_loop = &event_loop;
436 
437  event_loop.Run();
438 
439  m_qmodal_showing = false;
440 
441  return GetReturnCode();
442 }
bool m_qmodal_showing
Definition: dialog_shim.h:214
#define WX_EVENT_LOOP
Definition: kiway_player.h:43
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:212
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:215
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:42
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp:65

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

Referenced by SCH_EDIT_TOOL::ChangeSymbols(), S3D::Configure3DPaths(), COMMON_CONTROL::ConfigurePaths(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SCH_EDIT_TOOL::editFieldText(), SCH_EDITOR_CONTROL::EditSymbolFields(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), GLOBAL_EDIT_TOOL::EditTracksAndVias(), GLOBAL_EDIT_TOOL::ExchangeFootprints(), InvokeCopperZonesEditor(), InvokeDialogCreateBOM(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeNonCopperZonesEditor(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), S3D::Select3DModel(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowDimensionPropertiesDialog(), PCB_EDIT_FRAME::ShowExchangeFootprintsDialog(), PCB_EDIT_FRAME::ShowFootprintPropertiesDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), PCB_BASE_FRAME::ShowPadPropertiesDialog(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), and PCB_BASE_EDIT_FRAME::ShowTextPropertiesDialog().

◆ vertPixelsFromDU()

int DIALOG_SHIM::vertPixelsFromDU ( int  y) const
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 173 of file dialog_shim.cpp.

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

Referenced by DIALOG_CHOOSE_SYMBOL().

Member Data Documentation

◆ DblClickDelay

constexpr int DIALOG_CHOOSE_SYMBOL::DblClickDelay = 100
staticprotected

Definition at line 164 of file dialog_choose_symbol.h.

Referenced by OnCloseTimer(), and OnComponentSelected().

◆ g_Mutex

std::mutex DIALOG_CHOOSE_SYMBOL::g_Mutex
static

◆ m_allow_field_edits

bool DIALOG_CHOOSE_SYMBOL::m_allow_field_edits
protected

Definition at line 220 of file dialog_choose_symbol.h.

Referenced by ConstructRightPanel().

◆ m_browser_button

wxButton* DIALOG_CHOOSE_SYMBOL::m_browser_button
protected

Definition at line 207 of file dialog_choose_symbol.h.

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

◆ m_dbl_click_timer

wxTimer* DIALOG_CHOOSE_SYMBOL::m_dbl_click_timer
protected

◆ m_deMorganConvert

int DIALOG_CHOOSE_SYMBOL::m_deMorganConvert
protected

Definition at line 219 of file dialog_choose_symbol.h.

◆ m_details

wxHtmlWindow* DIALOG_CHOOSE_SYMBOL::m_details
protected

Definition at line 216 of file dialog_choose_symbol.h.

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

◆ m_external_browser_requested

bool DIALOG_CHOOSE_SYMBOL::m_external_browser_requested
protected

Definition at line 222 of file dialog_choose_symbol.h.

Referenced by IsExternalBrowserSelected(), and OnUseBrowser().

◆ m_field_edits

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

Definition at line 225 of file dialog_choose_symbol.h.

Referenced by GetFields(), and OnFootprintSelected().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 209 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_fp_override

wxString DIALOG_CHOOSE_SYMBOL::m_fp_override
protected

Definition at line 223 of file dialog_choose_symbol.h.

Referenced by OnFootprintSelected().

◆ m_fp_preview

FOOTPRINT_PREVIEW_WIDGET* DIALOG_CHOOSE_SYMBOL::m_fp_preview
protected

◆ m_fp_sel_ctrl

FOOTPRINT_SELECT_WIDGET* DIALOG_CHOOSE_SYMBOL::m_fp_sel_ctrl
protected

◆ m_hash_key

◆ m_hsplitter

wxSplitterWindow* DIALOG_CHOOSE_SYMBOL::m_hsplitter
protected

Definition at line 208 of file dialog_choose_symbol.h.

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

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 210 of file dialog_shim.h.

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

◆ m_keepSymbol

wxCheckBox* DIALOG_CHOOSE_SYMBOL::m_keepSymbol
protected

◆ m_parent

SCH_BASE_FRAME* DIALOG_CHOOSE_SYMBOL::m_parent
protected

Definition at line 218 of file dialog_choose_symbol.h.

Referenced by ConstructRightPanel().

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 217 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 212 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 214 of file dialog_shim.h.

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

◆ m_show_footprints

bool DIALOG_CHOOSE_SYMBOL::m_show_footprints
protected

Definition at line 221 of file dialog_choose_symbol.h.

Referenced by ConstructRightPanel(), and DIALOG_CHOOSE_SYMBOL().

◆ m_symbol_preview

SYMBOL_PREVIEW_WIDGET* DIALOG_CHOOSE_SYMBOL::m_symbol_preview
protected

Definition at line 206 of file dialog_choose_symbol.h.

Referenced by ConstructRightPanel(), and OnComponentPreselected().

◆ m_tabOrder

◆ m_tree

LIB_TREE* DIALOG_CHOOSE_SYMBOL::m_tree
protected

◆ m_units

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

◆ m_useUnits

wxCheckBox* DIALOG_CHOOSE_SYMBOL::m_useUnits
protected

◆ m_vsplitter

wxSplitterWindow* DIALOG_CHOOSE_SYMBOL::m_vsplitter
protected

Definition at line 209 of file dialog_choose_symbol.h.

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


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