KiCad PCB EDA Suite
NETLIST_DIALOG Class Reference
Inheritance diagram for NETLIST_DIALOG:
NETLIST_DIALOG_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

 NETLIST_DIALOG (SCH_EDIT_FRAME *parent)
 
 ~NETLIST_DIALOG ()
 
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)
 

Public Attributes

SCH_EDIT_FRAMEm_Parent
 
wxString m_DefaultNetFmtName
 
NETLIST_PAGE_DIALOGm_PanelNetType [4+CUSTOMPANEL_COUNTMAX]
 

Protected Types

enum  { ID_CHANGE_NOTEBOOK_PAGE = 1000, ID_ADD_PLUGIN, ID_DEL_PLUGIN }
 

Protected Member Functions

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...
 
virtual void OnCharHook (wxKeyEvent &aEvt)
 

Protected Attributes

wxNotebook * m_NoteBook
 
wxBoxSizer * m_buttonSizer
 
wxButton * m_buttonAddGenerator
 
wxButton * m_buttonDelGenerator
 
wxStdDialogButtonSizer * m_sdbSizer2
 
wxButton * m_sdbSizer2OK
 
wxButton * m_sdbSizer2Cancel
 
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
 
wxSize m_initialSize
 

Private Member Functions

void InstallCustomPages ()
 
NETLIST_PAGE_DIALOGAddOneCustomPage (const wxString &aTitle, const wxString &aCommandString, NETLIST_TYPE_ID aNetTypeId)
 
void InstallPageSpice ()
 
bool TransferDataFromWindow () override
 
void NetlistUpdateOpt ()
 
void OnNetlistTypeSelection (wxNotebookEvent &event) override
 
void OnAddGenerator (wxCommandEvent &event) override
 Add a new panel for a new netlist plugin. More...
 
void OnDelGenerator (wxCommandEvent &event) override
 Remove a panel relative to a netlist plugin. More...
 
void OnRunExternSpiceCommand (wxCommandEvent &event)
 Run the external spice simulator command. More...
 
void OnRunSpiceButtUI (wxUpdateUIEvent &event)
 Enable (if the command line is not empty or disable the button to run spice command. More...
 
void WriteCurrentNetlistSetup ()
 Write the current netlist options setup in the configuration. More...
 
bool FilenamePrms (NETLIST_TYPE_ID aType, wxString *aExt, wxString *aWildCard)
 Return the filename extension and the wildcard string for this page or a void name if there is no default name. More...
 

Friends

class NETLIST_PAGE_DIALOG
 

Detailed Description

Definition at line 111 of file eeschema/dialogs/dialog_netlist.cpp.

Member Enumeration Documentation

◆ anonymous enum

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 39 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ NETLIST_DIALOG()

NETLIST_DIALOG::NETLIST_DIALOG ( SCH_EDIT_FRAME parent)

Definition at line 242 of file eeschema/dialogs/dialog_netlist.cpp.

242  :
243  NETLIST_DIALOG_BASE( parent )
244 {
245  m_Parent = parent;
246 
248 
250 
251  for( NETLIST_PAGE_DIALOG*& page : m_PanelNetType)
252  page = nullptr;
253 
254  // Add notebook pages:
256  NET_TYPE_PCBNEW );
257 
258  m_PanelNetType[PANELORCADPCB2] = new NETLIST_PAGE_DIALOG( m_NoteBook, wxT( "OrcadPCB2" ),
260 
261  m_PanelNetType[PANELCADSTAR] = new NETLIST_PAGE_DIALOG( m_NoteBook, wxT( "CadStar" ),
263 
266 
267  // We use a sdbSizer here to get the order right, which is platform-dependent
268  m_sdbSizer2OK->SetLabel( _( "Export Netlist" ) );
269  m_sdbSizer2Cancel->SetLabel( _( "Close" ) );
270  m_buttonSizer->Layout();
271 
272  m_sdbSizer2OK->SetDefault();
273 
274  // Now all widgets have the size fixed, call FinishDialogSettings
276 }
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:167
SCHEMATIC & Schematic() const
#define _(s)
void finishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
NETLIST_PAGE_DIALOG * m_PanelNetType[4+CUSTOMPANEL_COUNTMAX]
NETLIST_DIALOG_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Export Netlist"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
These settings were stored in SCH_BASE_FRAME previously.

References _, DIALOG_SHIM::finishDialogSettings(), InstallCustomPages(), InstallPageSpice(), NETLIST_DIALOG_BASE::m_buttonSizer, m_DefaultNetFmtName, SCHEMATIC_SETTINGS::m_NetFormatName, NETLIST_DIALOG_BASE::m_NoteBook, m_PanelNetType, m_Parent, NETLIST_DIALOG_BASE::m_sdbSizer2Cancel, NETLIST_DIALOG_BASE::m_sdbSizer2OK, NET_TYPE_CADSTAR, NET_TYPE_ORCADPCB2, NET_TYPE_PCBNEW, NETLIST_PAGE_DIALOG, PANELCADSTAR, PANELORCADPCB2, PANELPCBNEW, SCH_EDIT_FRAME::Schematic(), and SCHEMATIC::Settings().

◆ ~NETLIST_DIALOG()

NETLIST_DIALOG::~NETLIST_DIALOG ( )
inline

Definition at line 115 of file eeschema/dialogs/dialog_netlist.cpp.

115 { };

Member Function Documentation

◆ AddOneCustomPage()

NETLIST_PAGE_DIALOG * NETLIST_DIALOG::AddOneCustomPage ( const wxString &  aTitle,
const wxString &  aCommandString,
NETLIST_TYPE_ID  aNetTypeId 
)
private

Definition at line 379 of file eeschema/dialogs/dialog_netlist.cpp.

382 {
383  NETLIST_PAGE_DIALOG* currPage = new NETLIST_PAGE_DIALOG( m_NoteBook, aTitle, aNetTypeId );
384 
385  currPage->m_LowBoxSizer->Add( new wxStaticText( currPage, -1, _( "Title:" ) ), 0,
386  wxGROW | wxLEFT | wxRIGHT | wxTOP, 5 );
387 
388  currPage->m_TitleStringCtrl = new wxTextCtrl( currPage, -1, aTitle,
389  wxDefaultPosition, wxDefaultSize );
390 
391  currPage->m_TitleStringCtrl->SetInsertionPoint( 1 );
392  currPage->m_LowBoxSizer->Add( currPage->m_TitleStringCtrl, 0,
393  wxGROW | wxTOP | wxLEFT | wxRIGHT | wxBOTTOM, 5 );
394 
395  currPage->m_LowBoxSizer->Add( new wxStaticText( currPage, -1, _( "Netlist command:" ) ), 0,
396  wxGROW | wxLEFT | wxRIGHT | wxTOP, 5 );
397 
398  currPage->m_CommandStringCtrl = new wxTextCtrl( currPage, -1, aCommandString,
399  wxDefaultPosition, wxDefaultSize );
400 
401  currPage->m_CommandStringCtrl->SetInsertionPoint( 1 );
402  currPage->m_LowBoxSizer->Add( currPage->m_CommandStringCtrl, 0,
403  wxGROW | wxTOP | wxLEFT | wxRIGHT | wxBOTTOM, 5 );
404 
405  return currPage;
406 }
#define _(s)

References _, NETLIST_PAGE_DIALOG::m_CommandStringCtrl, NETLIST_PAGE_DIALOG::m_LowBoxSizer, NETLIST_DIALOG_BASE::m_NoteBook, NETLIST_PAGE_DIALOG::m_TitleStringCtrl, and NETLIST_PAGE_DIALOG.

Referenced by InstallCustomPages(), and OnAddGenerator().

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 311 of file dialog_shim.cpp.

312 {
313  // so we can do logging of this state change:
314  return wxDialog::Enable( enable );
315 }

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 470 of file dialog_shim.cpp.

471 {
472  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
473  // handle validation in the same way as other dialogs.
474  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
475  return;
476 
477  SetReturnCode( retCode );
478 
479  if( !IsQuasiModal() )
480  {
481  wxFAIL_MSG( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal"
482  "wasn't called" );
483  return;
484  }
485 
486  if( m_qmodal_loop )
487  {
488  if( m_qmodal_loop->IsRunning() )
489  m_qmodal_loop->Exit( 0 );
490  else
491  m_qmodal_loop->ScheduleExit( 0 );
492 
493  m_qmodal_loop = nullptr;
494  }
495 
497  m_qmodal_parent_disabler = nullptr;
498 
499  Show( false );
500 }
bool IsQuasiModal() const
Definition: dialog_shim.h:106
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:211
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:214

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

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

◆ FilenamePrms()

bool NETLIST_DIALOG::FilenamePrms ( NETLIST_TYPE_ID  aType,
wxString *  aExt,
wxString *  aWildCard 
)
private

Return the filename extension and the wildcard string for this page or a void name if there is no default name.

Parameters
aTypeis the netlist type ( NET_TYPE_PCBNEW ... ).
aExt[in] is a holder for the netlist file extension.
aWildCard[in] is a holder for netlist file dialog wildcard.
Returns
true for known netlist type, false for custom formats.

Definition at line 518 of file eeschema/dialogs/dialog_netlist.cpp.

519 {
520  wxString fileExt;
521  wxString fileWildcard;
522  bool ret = true;
523 
524  switch( aType )
525  {
526  case NET_TYPE_SPICE:
527  fileExt = wxT( "cir" );
528  fileWildcard = SpiceNetlistFileWildcard();
529  break;
530 
531  case NET_TYPE_CADSTAR:
532  fileExt = wxT( "frp" );
533  fileWildcard = CadstarNetlistFileWildcard();
534  break;
535 
536  case NET_TYPE_PCBNEW:
537  case NET_TYPE_ORCADPCB2:
538  fileExt = NetlistFileExtension;
539  fileWildcard = NetlistFileWildcard();
540  break;
541 
542  default: // custom, NET_TYPE_CUSTOM1 and greater
543  fileWildcard = AllFilesWildcard();
544  ret = false;
545  }
546 
547  if( aExt )
548  *aExt = fileExt;
549 
550  if( aWildCard )
551  *aWildCard = fileWildcard;
552 
553  return ret;
554 }
const std::string NetlistFileExtension
wxString SpiceNetlistFileWildcard()
wxString AllFilesWildcard()
wxString NetlistFileWildcard()
wxString CadstarNetlistFileWildcard()

References AllFilesWildcard(), CadstarNetlistFileWildcard(), NET_TYPE_CADSTAR, NET_TYPE_ORCADPCB2, NET_TYPE_PCBNEW, NET_TYPE_SPICE, NetlistFileExtension, NetlistFileWildcard(), and SpiceNetlistFileWildcard().

Referenced by TransferDataFromWindow().

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

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

Referenced by DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_BUS_MANAGER::DIALOG_BUS_MANAGER(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EDIT_SYMBOLS_LIBID::DIALOG_EDIT_SYMBOLS_LIBID(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_CHECKER::DIALOG_FOOTPRINT_CHECKER(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_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_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES(), DIALOG_LINE_WIRE_BUS_PROPERTIES::DIALOG_LINE_WIRE_BUS_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_SELECT_3DMODEL::DIALOG_SELECT_3DMODEL(), DIALOG_SHEET_PIN_PROPERTIES::DIALOG_SHEET_PIN_PROPERTIES(), DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UNUSED_PAD_LAYERS::DIALOG_UNUSED_PAD_LAYERS(), DIALOG_UPDATE_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), DIALOG_CONSTRAINTS_REPORTER::FinishInitialization(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), 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().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 46 of file kiway_holder.h.

46 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:76

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

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

169 {
170  wxSize sz( x, 0 );
171  return ConvertDialogToPixels( sz ).x;
172 }

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

◆ InstallCustomPages()

void NETLIST_DIALOG::InstallCustomPages ( )
private

Definition at line 349 of file eeschema/dialogs/dialog_netlist.cpp.

350 {
351  NETLIST_PAGE_DIALOG* currPage;
352 
353  auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
354  wxASSERT( cfg );
355 
356  if( cfg )
357  {
358  for( size_t i = 0;
359  i < CUSTOMPANEL_COUNTMAX && i < cfg->m_NetlistPanel.custom_command_titles.size();
360  i++ )
361  {
362  // pairs of (title, command) are stored
363  wxString title = cfg->m_NetlistPanel.custom_command_titles[i];
364 
365  if( i >= cfg->m_NetlistPanel.custom_command_paths.size() )
366  break; // No more panel to install
367 
368  wxString command = cfg->m_NetlistPanel.custom_command_paths[i];
369 
370  currPage = AddOneCustomPage( title, command,
371  static_cast<NETLIST_TYPE_ID>( NET_TYPE_CUSTOM1 + i ) );
372 
373  m_PanelNetType[PANELCUSTOMBASE + i] = currPage;
374  }
375  }
376 }
#define CUSTOMPANEL_COUNTMAX
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
NETLIST_PAGE_DIALOG * m_PanelNetType[4+CUSTOMPANEL_COUNTMAX]
NETLIST_PAGE_DIALOG * AddOneCustomPage(const wxString &aTitle, const wxString &aCommandString, NETLIST_TYPE_ID aNetTypeId)

References AddOneCustomPage(), CUSTOMPANEL_COUNTMAX, Kiface(), m_PanelNetType, NET_TYPE_CUSTOM1, and PANELCUSTOMBASE.

Referenced by NETLIST_DIALOG().

◆ InstallPageSpice()

void NETLIST_DIALOG::InstallPageSpice ( )
private

Definition at line 315 of file eeschema/dialogs/dialog_netlist.cpp.

316 {
318  new NETLIST_PAGE_DIALOG( m_NoteBook, wxT( "Spice" ), NET_TYPE_SPICE );
319 
321 
322  page->m_AdjustPassiveValues = new wxCheckBox( page, ID_USE_NETCODE_AS_NETNAME,
323  _( "Reformat passive symbol values" ) );
324  page->m_AdjustPassiveValues->SetToolTip( _( "Reformat passive symbol values e.g. 1M -> 1Meg" ) );
325  page->m_AdjustPassiveValues->SetValue( settings.m_SpiceAdjustPassiveValues );
326  page->m_LeftBoxSizer->Add( page->m_AdjustPassiveValues, 0, wxGROW | wxBOTTOM | wxRIGHT, 5 );
327 
328  wxString simulatorCommand = settings.m_SpiceCommandString;
329  wxStaticText* spice_label = new wxStaticText( page, -1, _( "External simulator command:" ) );
330  spice_label->SetToolTip( _( "Enter the command line to run spice\n"
331  "Usually <path to spice binary> %I\n"
332  "%I will be replaced by the actual spice netlist name" ) );
333  page->m_LowBoxSizer->Add( spice_label, 0, wxGROW | wxLEFT | wxRIGHT | wxBOTTOM, 5 );
334 
335  page->m_CommandStringCtrl = new wxTextCtrl( page, -1, simulatorCommand,
336  wxDefaultPosition, wxDefaultSize );
337 
338  page->m_CommandStringCtrl->SetInsertionPoint( 1 );
339  page->m_LowBoxSizer->Add( page->m_CommandStringCtrl, 0,
340  wxGROW | wxLEFT | wxRIGHT | wxBOTTOM, 5 );
341 
342  // Add button to run spice command
343  wxButton* button = new wxButton( page, ID_RUN_SIMULATOR,
344  _( "Create Netlist and Run Simulator Command" ) );
345  page->m_LowBoxSizer->Add( button, 0, wxGROW | wxBOTTOM | wxLEFT | wxRIGHT, 5 );
346 }
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:167
SCHEMATIC & Schematic() const
#define _(s)
NETLIST_PAGE_DIALOG * m_PanelNetType[4+CUSTOMPANEL_COUNTMAX]
These settings were stored in SCH_BASE_FRAME previously.

References _, ID_RUN_SIMULATOR, ID_USE_NETCODE_AS_NETNAME, NETLIST_PAGE_DIALOG::m_AdjustPassiveValues, NETLIST_PAGE_DIALOG::m_CommandStringCtrl, NETLIST_PAGE_DIALOG::m_LeftBoxSizer, NETLIST_PAGE_DIALOG::m_LowBoxSizer, NETLIST_DIALOG_BASE::m_NoteBook, m_PanelNetType, m_Parent, SCHEMATIC_SETTINGS::m_SpiceAdjustPassiveValues, SCHEMATIC_SETTINGS::m_SpiceCommandString, NET_TYPE_SPICE, NETLIST_PAGE_DIALOG, PANELSPICE, SCH_EDIT_FRAME::Schematic(), and SCHEMATIC::Settings().

Referenced by NETLIST_DIALOG().

◆ IsCtrl()

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

Definition at line 124 of file dialog_shim.h.

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

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 130 of file dialog_shim.h.

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

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 53 of file kiway_holder.h.

54  {
55  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
56  return *m_kiway;
57  }
KIWAY * m_kiway
Definition: kiway_holder.h:75

References KIWAY_HOLDER::m_kiway.

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SYMBOL_EDIT_FRAME::canCloseWindow(), SCH_EDIT_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_SYMBOL::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), SCH_EDIT_FRAME::doCloseWindow(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), BACK_ANNOTATE::FetchNetlistFromPCB(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SCRIPTING_TOOL::Init(), EDA_DRAW_FRAME::IsScriptingConsoleVisible(), 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(), 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(), DIALOG_CHOOSE_SYMBOL::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(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), 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(), EDA_DRAW_FRAME::ScriptingConsoleEnableDisable(), 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::SetCurSymbol(), 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().

◆ NetlistUpdateOpt()

void NETLIST_DIALOG::NetlistUpdateOpt ( )
private

Definition at line 422 of file eeschema/dialogs/dialog_netlist.cpp.

423 {
424  bool adjust = m_PanelNetType[ PANELSPICE ]->m_AdjustPassiveValues->IsChecked();
425  wxString spice_cmd_string = m_PanelNetType[ PANELSPICE ]->m_CommandStringCtrl->GetValue();
426 
428 
429  settings.m_SpiceAdjustPassiveValues = adjust;
430  settings.m_SpiceCommandString = spice_cmd_string;
431  settings.m_NetFormatName = wxEmptyString;
433 }
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:167
SCHEMATIC & Schematic() const
NETLIST_PAGE_DIALOG * m_PanelNetType[4+CUSTOMPANEL_COUNTMAX]
These settings were stored in SCH_BASE_FRAME previously.

References NETLIST_PAGE_DIALOG::m_AdjustPassiveValues, NETLIST_PAGE_DIALOG::m_CommandStringCtrl, m_DefaultNetFmtName, SCHEMATIC_SETTINGS::m_NetFormatName, m_PanelNetType, m_Parent, SCHEMATIC_SETTINGS::m_SpiceAdjustPassiveValues, SCHEMATIC_SETTINGS::m_SpiceCommandString, PANELSPICE, SCH_EDIT_FRAME::Schematic(), and SCHEMATIC::Settings().

Referenced by OnRunExternSpiceCommand(), TransferDataFromWindow(), and WriteCurrentNetlistSetup().

◆ OnAddGenerator()

void NETLIST_DIALOG::OnAddGenerator ( wxCommandEvent &  event)
overrideprivatevirtual

Add a new panel for a new netlist plugin.

Reimplemented from NETLIST_DIALOG_BASE.

Definition at line 609 of file eeschema/dialogs/dialog_netlist.cpp.

610 {
611  NETLIST_DIALOG_ADD_GENERATOR dlg( this );
612 
613  if( dlg.ShowModal() != wxID_OK )
614  return;
615 
616  // Creates a new custom plugin page
617  wxString title = dlg.GetGeneratorTitle();
618 
619  // Verify it does not exists
620  int netTypeId = PANELCUSTOMBASE; // the first not used type id
621  NETLIST_PAGE_DIALOG* currPage;
622 
623  for( int ii = 0; ii < CUSTOMPANEL_COUNTMAX; ii++ )
624  {
625  netTypeId = PANELCUSTOMBASE + ii;
626  currPage = m_PanelNetType[ii + PANELCUSTOMBASE];
627 
628  if( currPage == nullptr )
629  break;
630 
631  if( currPage->GetPageNetFmtName() == title )
632  {
633  wxMessageBox( _("This plugin already exists.") );
634  return;
635  }
636  }
637 
638  wxString cmd = dlg.GetGeneratorTCommandLine();
639  currPage = AddOneCustomPage( title,cmd, (NETLIST_TYPE_ID)netTypeId );
640  m_PanelNetType[netTypeId] = currPage;
642 
643  if( IsQuasiModal() )
645  else
646  EndDialog( NET_PLUGIN_CHANGE );
647 }
bool IsQuasiModal() const
Definition: dialog_shim.h:106
NETLIST_TYPE_ID
netlist types
Definition: netlist.h:35
void WriteCurrentNetlistSetup()
Write the current netlist options setup in the configuration.
#define CUSTOMPANEL_COUNTMAX
#define _(s)
NETLIST_PAGE_DIALOG * m_PanelNetType[4+CUSTOMPANEL_COUNTMAX]
void EndQuasiModal(int retCode)
NETLIST_PAGE_DIALOG * AddOneCustomPage(const wxString &aTitle, const wxString &aCommandString, NETLIST_TYPE_ID aNetTypeId)
#define NET_PLUGIN_CHANGE
Create and shows NETLIST_DIALOG and returns whatever NETLIST_DIALOG::ShowModal() returns.

References _, AddOneCustomPage(), CUSTOMPANEL_COUNTMAX, DIALOG_SHIM::EndQuasiModal(), NETLIST_DIALOG_ADD_GENERATOR::GetGeneratorTCommandLine(), NETLIST_DIALOG_ADD_GENERATOR::GetGeneratorTitle(), NETLIST_PAGE_DIALOG::GetPageNetFmtName(), DIALOG_SHIM::IsQuasiModal(), m_PanelNetType, NET_PLUGIN_CHANGE, PANELCUSTOMBASE, and WriteCurrentNetlistSetup().

◆ OnCharHook()

void DIALOG_SHIM::OnCharHook ( wxKeyEvent &  aEvt)
protectedvirtualinherited

Reimplemented in DIALOG_CHOOSE_SYMBOL, HK_PROMPT_DIALOG, and HTML_MESSAGE_BOX.

Definition at line 561 of file dialog_shim.cpp.

562 {
563  if( aEvt.GetKeyCode() == 'U' && aEvt.GetModifiers() == wxMOD_CONTROL )
564  {
565  if( m_parentFrame )
566  {
568  return;
569  }
570  }
571  // shift-return (Mac default) or Ctrl-Return (GTK) for OK
572  else if( aEvt.GetKeyCode() == WXK_RETURN && ( aEvt.ShiftDown() || aEvt.ControlDown() ) )
573  {
574  wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
575  return;
576  }
577  else if( aEvt.GetKeyCode() == WXK_TAB && !aEvt.ControlDown() )
578  {
579  wxWindow* currentWindow = wxWindow::FindFocus();
580  int currentIdx = -1;
581  int delta = aEvt.ShiftDown() ? -1 : 1;
582 
583  auto advance = [&]( int& idx )
584  {
585  // Wrap-around modulus
586  int size = m_tabOrder.size();
587  idx = ( ( idx + delta ) % size + size ) % size;
588  };
589 
590  for( size_t i = 0; i < m_tabOrder.size(); ++i )
591  {
592  if( m_tabOrder[i] == currentWindow )
593  {
594  currentIdx = (int) i;
595  break;
596  }
597  }
598 
599  if( currentIdx >= 0 )
600  {
601  advance( currentIdx );
602 
603  //todo: We don't currently have non-textentry dialog boxes but this will break if
604  // we add them.
605 #ifdef __APPLE__
606  while( dynamic_cast<wxTextEntry*>( m_tabOrder[ currentIdx ] ) == nullptr )
607  advance( currentIdx );
608 #endif
609 
610  m_tabOrder[ currentIdx ]->SetFocus();
611  return;
612  }
613  }
614 
615  aEvt.Skip();
616 }
std::vector< wxWindow * > m_tabOrder
Definition: dialog_shim.h:218
EDA_BASE_FRAME * m_parentFrame
Definition: dialog_shim.h:216
virtual void ToggleUserUnits()
constexpr int delta

References delta, DIALOG_SHIM::m_parentFrame, DIALOG_SHIM::m_tabOrder, and EDA_BASE_FRAME::ToggleUserUnits().

Referenced by DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), and DIALOG_TEXT_PROPERTIES::~DIALOG_TEXT_PROPERTIES().

◆ OnDelGenerator()

void NETLIST_DIALOG::OnDelGenerator ( wxCommandEvent &  event)
overrideprivatevirtual

Remove a panel relative to a netlist plugin.

Reimplemented from NETLIST_DIALOG_BASE.

Definition at line 592 of file eeschema/dialogs/dialog_netlist.cpp.

593 {
594  NETLIST_PAGE_DIALOG* currPage = (NETLIST_PAGE_DIALOG*) m_NoteBook->GetCurrentPage();
595 
596  currPage->m_CommandStringCtrl->SetValue( wxEmptyString );
597  currPage->m_TitleStringCtrl->SetValue( wxEmptyString );
599 
601 
602  if( IsQuasiModal() )
604  else
605  EndDialog( NET_PLUGIN_CHANGE );
606 }
bool IsQuasiModal() const
Definition: dialog_shim.h:106
void WriteCurrentNetlistSetup()
Write the current netlist options setup in the configuration.
NETLIST_PAGE_DIALOG * m_PanelNetType[4+CUSTOMPANEL_COUNTMAX]
void EndQuasiModal(int retCode)
#define NET_PLUGIN_CHANGE
Create and shows NETLIST_DIALOG and returns whatever NETLIST_DIALOG::ShowModal() returns.

References DIALOG_SHIM::EndQuasiModal(), NETLIST_PAGE_DIALOG::GetPageNetFmtName(), DIALOG_SHIM::IsQuasiModal(), NETLIST_PAGE_DIALOG::m_CommandStringCtrl, m_DefaultNetFmtName, NETLIST_DIALOG_BASE::m_NoteBook, m_PanelNetType, NETLIST_PAGE_DIALOG::m_TitleStringCtrl, NET_PLUGIN_CHANGE, PANELPCBNEW, and WriteCurrentNetlistSetup().

◆ OnNetlistTypeSelection()

void NETLIST_DIALOG::OnNetlistTypeSelection ( wxNotebookEvent &  event)
overrideprivatevirtual

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 377 of file dialog_shim.cpp.

378 {
379  if( m_firstPaintEvent )
380  {
382 
383  selectAllInTextCtrls( GetChildren() );
384 
387  else
388  KIPLATFORM::UI::ForceFocus( this ); // Focus the dialog itself
389 
390  m_firstPaintEvent = false;
391  }
392 
393  event.Skip();
394 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:209
bool m_firstPaintEvent
Definition: dialog_shim.h:208
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().

◆ OnRunExternSpiceCommand()

void NETLIST_DIALOG::OnRunExternSpiceCommand ( wxCommandEvent &  event)
private

Run the external spice simulator command.

Definition at line 279 of file eeschema/dialogs/dialog_netlist.cpp.

280 {
281  // Run the external spice simulator command
283 
285  wxString simulatorCommand = settings.m_SpiceCommandString;
286 
287  unsigned netlist_opt = 0;
288 
289  // Calculate the netlist filename and options
290  wxFileName fn = m_Parent->Schematic().GetFileName();
291  fn.SetExt( wxT( "cir" ) );
292 
293  if( settings.m_SpiceAdjustPassiveValues )
294  netlist_opt |= NET_ADJUST_PASSIVE_VALS;
295 
296  // Build the command line
297  wxString commandLine = simulatorCommand;
298  commandLine.Replace( "%I", fn.GetFullPath(), true );
299 
300  if( m_Parent->ReadyToNetlist( _( "Simulator requires a fully annotated schematic." ) ) )
301  {
302  m_Parent->WriteNetListFile( NET_TYPE_SPICE, fn.GetFullPath(), netlist_opt, nullptr );
303  wxExecute( commandLine, wxEXEC_ASYNC );
304  }
305 }
bool ReadyToNetlist(const wxString &aAnnotateMessage)
Check if we are ready to write a netlist file for the current schematic.
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:167
bool WriteNetListFile(int aFormat, const wxString &aFullFileName, unsigned aNetlistOptions, REPORTER *aReporter=nullptr)
Create a netlist file.
SCHEMATIC & Schematic() const
#define _(s)
wxString GetFileName() const override
Helper to retrieve the filename from the root sheet screen.
Definition: schematic.cpp:161
These settings were stored in SCH_BASE_FRAME previously.

References _, SCHEMATIC::GetFileName(), m_Parent, SCHEMATIC_SETTINGS::m_SpiceAdjustPassiveValues, SCHEMATIC_SETTINGS::m_SpiceCommandString, NET_ADJUST_PASSIVE_VALS, NET_TYPE_SPICE, NetlistUpdateOpt(), SCH_EDIT_FRAME::ReadyToNetlist(), SCH_EDIT_FRAME::Schematic(), SCHEMATIC::Settings(), and SCH_EDIT_FRAME::WriteNetListFile().

◆ OnRunSpiceButtUI()

void NETLIST_DIALOG::OnRunSpiceButtUI ( wxUpdateUIEvent &  event)
private

Enable (if the command line is not empty or disable the button to run spice command.

Definition at line 308 of file eeschema/dialogs/dialog_netlist.cpp.

309 {
310  bool disable = m_PanelNetType[PANELSPICE]->m_CommandStringCtrl->IsEmpty();
311  aEvent.Enable( !disable );
312 }
NETLIST_PAGE_DIALOG * m_PanelNetType[4+CUSTOMPANEL_COUNTMAX]

References NETLIST_PAGE_DIALOG::m_CommandStringCtrl, m_PanelNetType, and PANELSPICE.

◆ 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:53
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:189

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(), SIM_PLOT_FRAME::canCloseWindow(), PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath(), KICAD_MANAGER_FRAME::CloseProject(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::createNewLibrary(), PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary(), 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_CHOOSE_SYMBOL(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_GEN_FOOTPRINT_POSITION::DIALOG_GEN_FOOTPRINT_POSITION(), DIALOG_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(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), 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(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), SCH_BASE_FRAME::GetLibSymbol(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), 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(), SIM_PLOT_FRAME::menuSaveWorkbook(), SIM_PLOT_FRAME::menuSaveWorkbookAs(), PANEL_FP_PROPERTIES_3D_MODEL::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), DIALOG_EXPORT_STEP::onExportButton(), DIALOG_GENDRILL::OnGenReportFile(), KICAD_MANAGER_FRAME::OnIdle(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_SYMBOL::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::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_FP_PROPERTIES_3D_MODEL::PANEL_FP_PROPERTIES_3D_MODEL(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), SCH_EDITOR_CONTROL::Paste(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::plotOneSheetDxf(), DIALOG_PLOT_SCHEMATIC::plotOneSheetHpgl(), DIALOG_CHOOSE_SYMBOL::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(), PANEL_FP_PROPERTIES_3D_MODEL::ReloadModelsFromFootprint(), EDA_3D_VIEWER_FRAME::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(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), SIM_PLOT_FRAME::SaveSettings(), EDA_BASE_FRAME::SaveSettings(), SYMBOL_EDIT_FRAME::saveSymbolAs(), 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::SetCurSymbol(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_SYMBOL::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_FRAME::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), TransferDataFromWindow(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), SIM_PLOT_FRAME::updateTitle(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), SCH_EDIT_FRAME::UpdateTitle(), PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), PANEL_FP_PROPERTIES_3D_MODEL::~PANEL_FP_PROPERTIES_3D_MODEL(), 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 286 of file dialog_shim.cpp.

287 {
288  const char* hash_key;
289 
290  if( m_hash_key.size() )
291  {
292  // a special case like EDA_LIST_DIALOG, which has multiple uses.
293  hash_key = m_hash_key.c_str();
294  }
295  else
296  {
297  hash_key = typeid(*this).name();
298  }
299 
300  std::unordered_map<std::string, wxRect>::iterator it = class_map.find( hash_key );
301 
302  if( it == class_map.end() )
303  return;
304 
305  wxRect rect = it->second;
306  rect.SetSize( wxSize( 0, 0 ) );
307  class_map[ hash_key ] = rect;
308 }
std::string m_hash_key
Definition: dialog_shim.h:199
static std::unordered_map< std::string, wxRect > class_map

References class_map, and DIALOG_SHIM::m_hash_key.

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

98  {
99  m_initialFocusTarget = aWindow;
100  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:209

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR(), DIALOG_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_LINE_WIRE_BUS_PROPERTIES::DIALOG_LINE_WIRE_BUS_PROPERTIES(), 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_SYMBOL_FIELDS_TABLE::DIALOG_SYMBOL_FIELDS_TABLE(), 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::saveSymbolAs(), 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:75
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 189 of file dialog_shim.cpp.

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

References class_map, DIALOG_SHIM::m_hash_key, 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 161 of file dialog_shim.cpp.

162 {
163  wxSize sz( x, y );
164  SetSize( ConvertDialogToPixels( sz ) );
165 }

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

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

References class_map, DIALOG_SHIM::m_hash_key, DIALOG_SHIM::m_initialSize, 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().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 420 of file dialog_shim.cpp.

421 {
422  // This is an exception safe way to zero a pointer before returning.
423  // Yes, even though DismissModal() clears this first normally, this is
424  // here in case there's an exception before the dialog is dismissed.
425  struct NULLER
426  {
427  void*& m_what;
428  NULLER( void*& aPtr ) : m_what( aPtr ) {}
429  ~NULLER() { m_what = nullptr; } // indeed, set it to NULL on destruction
430  } clear_this( (void*&) m_qmodal_loop );
431 
432  // release the mouse if it's currently captured as the window having it
433  // will be disabled when this dialog is shown -- but will still keep the
434  // capture making it impossible to do anything in the modal dialog itself
435  wxWindow* win = wxWindow::GetCapture();
436  if( win )
437  win->ReleaseMouse();
438 
439  // Get the optimal parent
440  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
441 
442  wxASSERT_MSG( !m_qmodal_parent_disabler,
443  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
444 
445  // quasi-modal: disable only my "optimal" parent
447 
448  // Apple in its infinite wisdom will raise a disabled window before even passing
449  // us the event, so we have no way to stop it. Instead, we must set an order on
450  // the windows so that the quasi-modal will be pushed in front of the disabled
451  // window when it is raised.
453 
454  Show( true );
455 
456  m_qmodal_showing = true;
457 
458  WX_EVENT_LOOP event_loop;
459 
460  m_qmodal_loop = &event_loop;
461 
462  event_loop.Run();
463 
464  m_qmodal_showing = false;
465 
466  return GetReturnCode();
467 }
bool m_qmodal_showing
Definition: dialog_shim.h:213
#define WX_EVENT_LOOP
Definition: kiway_player.h:41
WX_EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:211
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:214
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:43
void ReparentQuasiModal(wxNonOwnedWindow *aWindow)
Move a window's parent to be the top-level window and force the window to be on top.
Definition: gtk/ui.cpp: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(), InvokeDialogEditSymbolsLibId(), 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().

◆ TransferDataFromWindow()

bool NETLIST_DIALOG::TransferDataFromWindow ( )
overrideprivate

Definition at line 436 of file eeschema/dialogs/dialog_netlist.cpp.

437 {
438  wxFileName fn;
439  wxString fileWildcard;
440  wxString fileExt;
441  wxString title = _( "Save Netlist File" );
442 
444 
445  NETLIST_PAGE_DIALOG* currPage;
446  currPage = (NETLIST_PAGE_DIALOG*) m_NoteBook->GetCurrentPage();
447 
448  unsigned netlist_opt = 0;
449 
450  // Calculate the netlist filename
451  fn = m_Parent->Schematic().GetFileName();
452  FilenamePrms( currPage->m_IdNetType, &fileExt, &fileWildcard );
453 
454  // Set some parameters
455  switch( currPage->m_IdNetType )
456  {
457  case NET_TYPE_SPICE:
458  // Set spice netlist options:
459  if( currPage->m_AdjustPassiveValues->GetValue() )
460  netlist_opt |= NET_ADJUST_PASSIVE_VALS;
461  break;
462 
463  case NET_TYPE_CADSTAR:
464  break;
465 
466  case NET_TYPE_PCBNEW:
467  break;
468 
469  case NET_TYPE_ORCADPCB2:
470  break;
471 
472  default: // custom, NET_TYPE_CUSTOM1 and greater
473  {
474  wxString command = currPage->m_CommandStringCtrl->GetValue();
475  wxRegEx extRE( wxT( ".*\\.([[:alnum:]][[:alnum:]][[:alnum:]][[:alnum:]]?)\\.xslt?\".*" ) );
476 
477  if( extRE.Matches( command ) )
478  fileExt = extRE.GetMatch( command, 1 );
479 
480  title.Printf( _( "%s Export" ), currPage->m_TitleStringCtrl->GetValue().GetData() );
481  break;
482  }
483  }
484 
485  fn.SetExt( fileExt );
486 
487  if( fn.GetPath().IsEmpty() )
488  fn.SetPath( wxPathOnly( Prj().GetProjectFullName() ) );
489 
490  wxString fullpath = fn.GetFullPath();
491  wxString fullname = fn.GetFullName();
492  wxString path = fn.GetPath();
493 
494  // full name does not and should not include the path, per wx docs.
495  wxFileDialog dlg( this, title, path, fullname, fileWildcard, wxFD_SAVE );
496 
497  if( dlg.ShowModal() == wxID_CANCEL )
498  return false;
499 
500  fullpath = dlg.GetPath(); // directory + filename
501 
503 
504  if( currPage->m_CommandStringCtrl )
505  m_Parent->SetNetListerCommand( currPage->m_CommandStringCtrl->GetValue() );
506  else
507  m_Parent->SetNetListerCommand( wxEmptyString );
508 
509  if( m_Parent->ReadyToNetlist( _( "Exporting netlist requires a fully annotated schematic." ) ) )
510  m_Parent->WriteNetListFile( currPage->m_IdNetType, fullpath, netlist_opt, nullptr );
511 
513 
514  return true;
515 }
bool ReadyToNetlist(const wxString &aAnnotateMessage)
Check if we are ready to write a netlist file for the current schematic.
bool FilenamePrms(NETLIST_TYPE_ID aType, wxString *aExt, wxString *aWildCard)
Return the filename extension and the wildcard string for this page or a void name if there is no def...
void WriteCurrentNetlistSetup()
Write the current netlist options setup in the configuration.
bool WriteNetListFile(int aFormat, const wxString &aFullFileName, unsigned aNetlistOptions, REPORTER *aReporter=nullptr)
Create a netlist file.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
SCHEMATIC & Schematic() const
#define _(s)
wxString GetFileName() const override
Helper to retrieve the filename from the root sheet screen.
Definition: schematic.cpp:161
virtual void ClearMsgPanel()
Clear all messages from the message panel.
void SetNetListerCommand(const wxString &aCommand)

References _, EDA_DRAW_FRAME::ClearMsgPanel(), FilenamePrms(), SCHEMATIC::GetFileName(), NETLIST_PAGE_DIALOG::m_AdjustPassiveValues, NETLIST_PAGE_DIALOG::m_CommandStringCtrl, NETLIST_PAGE_DIALOG::m_IdNetType, NETLIST_DIALOG_BASE::m_NoteBook, m_Parent, NETLIST_PAGE_DIALOG::m_TitleStringCtrl, NET_ADJUST_PASSIVE_VALS, NET_TYPE_CADSTAR, NET_TYPE_ORCADPCB2, NET_TYPE_PCBNEW, NET_TYPE_SPICE, NetlistUpdateOpt(), path, KIWAY_HOLDER::Prj(), SCH_EDIT_FRAME::ReadyToNetlist(), SCH_EDIT_FRAME::Schematic(), SCH_EDIT_FRAME::SetNetListerCommand(), WriteCurrentNetlistSetup(), and SCH_EDIT_FRAME::WriteNetListFile().

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

176 {
177  wxSize sz( 0, y );
178  return ConvertDialogToPixels( sz ).y;
179 }

Referenced by DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL().

◆ WriteCurrentNetlistSetup()

void NETLIST_DIALOG::WriteCurrentNetlistSetup ( )
private

Write the current netlist options setup in the configuration.

Definition at line 557 of file eeschema/dialogs/dialog_netlist.cpp.

558 {
559  wxString msg;
560 
562 
563  EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
564  wxASSERT( cfg );
565 
566  if( cfg )
567  {
570 
571  // Update existing custom pages
572  for( int ii = 0; ii < CUSTOMPANEL_COUNTMAX; ii++ )
573  {
575 
576  if( currPage == nullptr )
577  break;
578 
579  wxString title = currPage->m_TitleStringCtrl->GetValue();
580 
581  if( title.IsEmpty() )
582  continue;
583 
584  cfg->m_NetlistPanel.custom_command_titles.emplace_back( title.ToStdString() );
585  cfg->m_NetlistPanel.custom_command_paths.emplace_back(
586  currPage->m_CommandStringCtrl->GetValue().ToStdString() );
587  }
588  }
589 }
std::vector< wxString > custom_command_titles
#define CUSTOMPANEL_COUNTMAX
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
NETLIST_PAGE_DIALOG * m_PanelNetType[4+CUSTOMPANEL_COUNTMAX]
std::vector< wxString > custom_command_paths
PANEL_NETLIST m_NetlistPanel

References EESCHEMA_SETTINGS::PANEL_NETLIST::custom_command_paths, EESCHEMA_SETTINGS::PANEL_NETLIST::custom_command_titles, CUSTOMPANEL_COUNTMAX, Kiface(), NETLIST_PAGE_DIALOG::m_CommandStringCtrl, EESCHEMA_SETTINGS::m_NetlistPanel, m_PanelNetType, NETLIST_PAGE_DIALOG::m_TitleStringCtrl, NetlistUpdateOpt(), and PANELCUSTOMBASE.

Referenced by OnAddGenerator(), OnDelGenerator(), and TransferDataFromWindow().

Friends And Related Function Documentation

◆ NETLIST_PAGE_DIALOG

friend class NETLIST_PAGE_DIALOG
friend

Member Data Documentation

◆ m_buttonAddGenerator

wxButton* NETLIST_DIALOG_BASE::m_buttonAddGenerator
protectedinherited

Definition at line 55 of file eeschema/dialogs/dialog_netlist_base.h.

◆ m_buttonDelGenerator

wxButton* NETLIST_DIALOG_BASE::m_buttonDelGenerator
protectedinherited

Definition at line 56 of file eeschema/dialogs/dialog_netlist_base.h.

Referenced by OnNetlistTypeSelection().

◆ m_buttonSizer

wxBoxSizer* NETLIST_DIALOG_BASE::m_buttonSizer
protectedinherited

Definition at line 54 of file eeschema/dialogs/dialog_netlist_base.h.

Referenced by NETLIST_DIALOG().

◆ m_DefaultNetFmtName

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 208 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 209 of file dialog_shim.h.

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

◆ m_initialSize

wxSize DIALOG_SHIM::m_initialSize
protectedinherited

Definition at line 221 of file dialog_shim.h.

Referenced by DIALOG_SHIM::Show().

◆ m_NoteBook

wxNotebook* NETLIST_DIALOG_BASE::m_NoteBook
protectedinherited

◆ m_PanelNetType

◆ m_Parent

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

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

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

◆ m_sdbSizer2

wxStdDialogButtonSizer* NETLIST_DIALOG_BASE::m_sdbSizer2
protectedinherited

Definition at line 57 of file eeschema/dialogs/dialog_netlist_base.h.

◆ m_sdbSizer2Cancel

wxButton* NETLIST_DIALOG_BASE::m_sdbSizer2Cancel
protectedinherited

Definition at line 59 of file eeschema/dialogs/dialog_netlist_base.h.

Referenced by NETLIST_DIALOG().

◆ m_sdbSizer2OK

wxButton* NETLIST_DIALOG_BASE::m_sdbSizer2OK
protectedinherited

Definition at line 58 of file eeschema/dialogs/dialog_netlist_base.h.

Referenced by NETLIST_DIALOG().

◆ m_tabOrder

◆ m_units

◆ m_useCalculatedSize

bool DIALOG_SHIM::m_useCalculatedSize
protectedinherited

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