KiCad PCB EDA Suite
DIALOG_NETLIST Class Reference

#include <dialog_netlist.h>

Inheritance diagram for DIALOG_NETLIST:
DIALOG_NETLIST_BASE DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

 DIALOG_NETLIST (PCB_EDIT_FRAME *aParent, const wxString &aNetlistFullFilename)
 
 ~DIALOG_NETLIST ()
 
void SetInitialFocus (wxWindow *aWindow)
 Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS_T GetUserUnits () const override
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
VTBL_ENTRY TOOL_MANAGERGetToolManager () const
 Function GetToolManager Return the tool manager instance, if any. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Protected Types

enum  { ID_TEST_NETLIST = 1000 }
 

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)
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int VertPixelsFromDU (int y)
 Convert an integer number of dialog units to pixels, vertically. More...
 

Protected Attributes

wxTextCtrl * m_NetlistFilenameCtrl
 
wxBitmapButton * m_browseButton
 
wxRadioBox * m_matchByTimestamp
 
wxCheckBox * m_cbUpdateFootprints
 
wxCheckBox * m_cbDeleteShortingTracks
 
wxCheckBox * m_cbDeleteExtraFootprints
 
wxCheckBox * m_cbDeleteSinglePadNets
 
WX_HTML_REPORT_PANELm_MessageWindow
 
wxBoxSizer * m_buttonsSizer
 
wxButton * m_buttonFPTest
 
wxStdDialogButtonSizer * m_sdbSizer1
 
wxButton * m_sdbSizer1OK
 
wxButton * m_sdbSizer1Apply
 
wxButton * m_sdbSizer1Cancel
 
EDA_UNITS_T m_units
 
std::string m_hash_key
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 

Private Member Functions

void onFilenameChanged ()
 
void loadNetlist (bool aDryRun)
 
void OnOpenNetlistClick (wxCommandEvent &event) override
 
void OnUpdatePCB (wxCommandEvent &event) override
 
void OnFilenameKillFocus (wxFocusEvent &event) override
 
void OnMatchChanged (wxCommandEvent &event) override
 
void OnOptionChanged (wxCommandEvent &event) override
 
void OnTestFootprintsClick (wxCommandEvent &event) override
 
void OnCompileRatsnestClick (wxCommandEvent &event) override
 
void OnUpdateUIValidNetlistFile (wxUpdateUIEvent &aEvent) override
 

Private Attributes

PCB_EDIT_FRAMEm_parent
 
wxConfigBase * m_config
 
bool m_initialized
 
bool m_runDragCommand
 

Detailed Description

Definition at line 38 of file dialog_netlist.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
ID_TEST_NETLIST 

Definition at line 46 of file pcbnew/dialogs/dialog_netlist_base.h.

Constructor & Destructor Documentation

◆ DIALOG_NETLIST()

DIALOG_NETLIST::DIALOG_NETLIST ( PCB_EDIT_FRAME aParent,
const wxString &  aNetlistFullFilename 
)

Definition at line 82 of file pcbnew/dialogs/dialog_netlist.cpp.

83  : DIALOG_NETLIST_BASE( aParent ),
84  m_parent( aParent ),
85  m_initialized( false ),
86  m_runDragCommand( false )
87 {
89 
90  m_NetlistFilenameCtrl->SetValue( aNetlistFullFilename );
91  m_browseButton->SetBitmap( KiBitmap( folder_xpm ) );
92 
97 
98  m_MessageWindow->SetLabel( _("Changes To Be Applied") );
100 
101  // We use a sdbSizer to get platform-dependent ordering of the action buttons, but
102  // that requires us to correct the button labels here.
103  m_sdbSizer1OK->SetLabel( _( "Update PCB" ) );
104  m_sdbSizer1Apply->SetLabel( _( "Rebuild Ratsnest" ) );
105  m_sdbSizer1Cancel->SetLabel( _( "Close" ) );
106  m_buttonsSizer->Layout();
107 
108  m_sdbSizer1OK->SetDefault();
110 
111  m_initialized = true;
112  loadNetlist( true );
113 }
void SetVisibleSeverities(int aSeverities)
Set the visible severity filter.
DIALOG_NETLIST_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Import Netlist"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
PCB_EDIT_FRAME * m_parent
wxConfigBase * m_config
wxConfigBase * KifaceSettings() const
Definition: kiface_i.h:103
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
#define NETLIST_DELETEEXTRAFOOTPRINTS_KEY
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:52
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:79
#define NETLIST_DELETESINGLEPADNETS_KEY
#define NETLIST_FILTER_MESSAGES_KEY
#define NETLIST_DELETESHORTINGTRACKS_KEY
WX_HTML_REPORT_PANEL * m_MessageWindow
#define NETLIST_UPDATEFOOTPRINTS_KEY
void SetLabel(const wxString &aLabel) override
sets the frame label

References DIALOG_SHIM::FinishDialogSettings(), KiBitmap(), Kiface(), KIFACE_I::KifaceSettings(), loadNetlist(), DIALOG_NETLIST_BASE::m_browseButton, DIALOG_NETLIST_BASE::m_buttonsSizer, DIALOG_NETLIST_BASE::m_cbDeleteExtraFootprints, DIALOG_NETLIST_BASE::m_cbDeleteShortingTracks, DIALOG_NETLIST_BASE::m_cbDeleteSinglePadNets, DIALOG_NETLIST_BASE::m_cbUpdateFootprints, m_config, m_initialized, DIALOG_NETLIST_BASE::m_MessageWindow, DIALOG_NETLIST_BASE::m_NetlistFilenameCtrl, DIALOG_NETLIST_BASE::m_sdbSizer1Apply, DIALOG_NETLIST_BASE::m_sdbSizer1Cancel, DIALOG_NETLIST_BASE::m_sdbSizer1OK, NETLIST_DELETEEXTRAFOOTPRINTS_KEY, NETLIST_DELETESHORTINGTRACKS_KEY, NETLIST_DELETESINGLEPADNETS_KEY, NETLIST_FILTER_MESSAGES_KEY, NETLIST_UPDATEFOOTPRINTS_KEY, WX_HTML_REPORT_PANEL::SetLabel(), and WX_HTML_REPORT_PANEL::SetVisibleSeverities().

◆ ~DIALOG_NETLIST()

DIALOG_NETLIST::~DIALOG_NETLIST ( )

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

116 {
122 
123  if( m_runDragCommand )
124  m_parent->GetToolManager()->InvokeTool( "pcbnew.InteractiveEdit" );
125 }
PCB_EDIT_FRAME * m_parent
wxConfigBase * m_config
bool InvokeTool(TOOL_ID aToolId)
Function InvokeTool() Calls a tool by sending a tool activation event to tool of given ID.
#define NETLIST_DELETEEXTRAFOOTPRINTS_KEY
#define NETLIST_DELETESINGLEPADNETS_KEY
#define NETLIST_FILTER_MESSAGES_KEY
#define NETLIST_DELETESHORTINGTRACKS_KEY
TOOL_MANAGER * GetToolManager() const override
Return the tool manager instance, if any.
Definition: draw_frame.h:937
WX_HTML_REPORT_PANEL * m_MessageWindow
#define NETLIST_UPDATEFOOTPRINTS_KEY

References EDA_DRAW_FRAME::GetToolManager(), WX_HTML_REPORT_PANEL::GetVisibleSeverities(), TOOL_MANAGER::InvokeTool(), DIALOG_NETLIST_BASE::m_cbDeleteExtraFootprints, DIALOG_NETLIST_BASE::m_cbDeleteShortingTracks, DIALOG_NETLIST_BASE::m_cbDeleteSinglePadNets, DIALOG_NETLIST_BASE::m_cbUpdateFootprints, m_config, DIALOG_NETLIST_BASE::m_MessageWindow, m_parent, m_runDragCommand, NETLIST_DELETEEXTRAFOOTPRINTS_KEY, NETLIST_DELETESHORTINGTRACKS_KEY, NETLIST_DELETESINGLEPADNETS_KEY, NETLIST_FILTER_MESSAGES_KEY, and NETLIST_UPDATEFOOTPRINTS_KEY.

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 237 of file dialog_shim.cpp.

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

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 397 of file dialog_shim.cpp.

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

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_COMPONENTS_LIBID::onCancel(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::OnCancelButtonClick(), DIALOG_LIB_EDIT_PIN_TABLE::OnClose(), DIALOG_PRINT_GENERIC::onCloseButton(), DIALOG_CHOOSE_FOOTPRINT::OnCloseTimer(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_CHOOSE_FOOTPRINT::OnUseBrowser(), DIALOG_CHOOSE_COMPONENT::OnUseBrowser(), and DIALOG_SHIM::~DIALOG_SHIM().

◆ FinishDialogSettings()

void DIALOG_SHIM::FinishDialogSettings ( )
protectedinherited

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

FinishDialogSettings must be called from derived classes, when all widgets are initialized, and therefore their size fixed. If TransferDataToWindow() is used to initialize widgets, at end of TransferDataToWindow, or better at end of a wxInitDialogEvent handler

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

Definition at line 136 of file dialog_shim.cpp.

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

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXIT::DIALOG_EXIT(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::DIALOG_FOOTPRINTS_DISPLAY_OPTIONS(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::DIALOG_FP_BROWSER_DISPLAY_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NETLIST(), DIALOG_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_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), and DIALOG_COLOR_PICKER::TransferDataToWindow().

◆ GetToolManager()

TOOL_MANAGER * KIWAY_HOLDER::GetToolManager ( ) const
inherited

Function GetToolManager Return the tool manager instance, if any.

Definition at line 46 of file kiway_holder.cpp.

47 {
48  return nullptr;
49 }

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUserUnits()

◆ HorizPixelsFromDU()

int DIALOG_SHIM::HorizPixelsFromDU ( int  x)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 157 of file dialog_shim.cpp.

158 {
159  wxSize sz( x, 0 );
160  return ConvertDialogToPixels( sz ).x;
161 }

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

◆ IsQuasiModal()

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in.

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 61 of file kiway_player.h.

62  {
63  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
64  return *m_kiway;
65  }
KIWAY * m_kiway
Definition: kiway_player.h:101

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), SCH_EDIT_FRAME::AppendSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), CVPCB_MAINFRAME::CreateScreenCmp(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KIWAY_PLAYER::language_change(), KICAD_MANAGER_FRAME::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), LIB_VIEW_FRAME::OnAddPartToSchematic(), LIB_EDIT_FRAME::OnAddPartToSchematic(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), KICAD_MANAGER_FRAME::OnEditFpLibTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), KICAD_MANAGER_FRAME::OnEditSymLibTable(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenLibraryEditor(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), KICAD_MANAGER_FRAME::OnRunPcbFpEditor(), KICAD_MANAGER_FRAME::OnRunSchLibEditor(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), KICAD_MANAGER_FRAME::RunEeschema(), KICAD_MANAGER_FRAME::RunPcbNew(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), EDA_BASE_FRAME::ShowPreferences(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ loadNetlist()

void DIALOG_NETLIST::loadNetlist ( bool  aDryRun)
private

Definition at line 262 of file pcbnew/dialogs/dialog_netlist.cpp.

263 {
264  wxString netlistFileName = m_NetlistFilenameCtrl->GetValue();
265  wxFileName fn = netlistFileName;
266 
267  if( !fn.IsOk() || !fn.FileExists() )
268  return;
269 
271  REPORTER& reporter = m_MessageWindow->Reporter();
272 
273  wxBusyCursor busy;
274 
275  wxString msg;
276  msg.Printf( _( "Reading netlist file \"%s\".\n" ), GetChars( netlistFileName ) );
277  reporter.ReportHead( msg, REPORTER::RPT_INFO );
278 
279  if( m_matchByTimestamp->GetSelection() == 0 )
280  msg = _( "Using references to match components and footprints.\n" );
281  else
282  msg = _( "Using tstamp fields to match components and footprints.\n" );
283 
284  reporter.ReportHead( msg, REPORTER::RPT_INFO );
285  m_MessageWindow->SetLazyUpdate( true ); // Use lazy update to speed the creation of the report
286  // (the window is not updated for each message)
287  NETLIST netlist;
288 
290  netlist.SetFindByTimeStamp( m_matchByTimestamp->GetSelection() == 1 );
291  netlist.SetReplaceFootprints( m_cbUpdateFootprints->GetValue() );
292 
293  if( !m_parent->ReadNetlistFromFile( netlistFileName, netlist, reporter ) )
294  return;
295 
297  updater.SetReporter ( &reporter );
298  updater.SetIsDryRun( aDryRun );
299  updater.SetLookupByTimestamp( m_matchByTimestamp->GetSelection() == 1 );
300  updater.SetDeleteUnusedComponents ( m_cbDeleteExtraFootprints->GetValue() );
301  updater.SetReplaceFootprints( m_cbUpdateFootprints->GetValue() );
302  updater.SetDeleteSinglePadNets( m_cbDeleteSinglePadNets->GetValue() );
303  updater.UpdateNetlist( netlist );
304 
305  // The creation of the report was made without window update: the full page must be displayed
306  m_MessageWindow->Flush( true );
307 
308  if( aDryRun )
309  return;
310 
312 }
void SetLazyUpdate(bool aLazyUpdate)
Sets the lasy update.
PCB_EDIT_FRAME * m_parent
Class BOARD_NETLIST_UPDATER updates the BOARD with a new netlist.
bool ReadNetlistFromFile(const wxString &aFilename, NETLIST &aNetlist, REPORTER &aReporter)
Reads a netlist from a file into a NETLIST object.
Definition: netlist.cpp:60
void Flush(bool aSort=false)
Forces updating the HTML page, after the report is built in lazy mode If aSort = true,...
void SetFindByTimeStamp(bool aFindByTimeStamp)
Definition: pcb_netlist.h:311
void SetReporter(REPORTER *aReporter)
Sets the reporter object
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61
void OnNetlistChanged(BOARD_NETLIST_UPDATER &aUpdater, bool *aRunDragCommand)
Called after netlist is updated.
Definition: netlist.cpp:95
virtual REPORTER & ReportHead(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)
Function ReportHead Places the report at the beginning of the list for objects that support ordering.
Definition: reporter.h:120
void SetReplaceFootprints(bool aReplaceFootprints)
Definition: pcb_netlist.h:315
Class NETLIST stores all of information read from a netlist along with the flags used to update the N...
Definition: pcb_netlist.h:214
REPORTER & Reporter()
returns the reporter object that reports to this panel
WX_HTML_REPORT_PANEL * m_MessageWindow
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:100
void Clear()
clears the report panel
void SetDeleteExtraFootprints(bool aDeleteExtraFootprints)
Definition: pcb_netlist.h:300
BOARD * GetBoard() const

References WX_HTML_REPORT_PANEL::Clear(), WX_HTML_REPORT_PANEL::Flush(), PCB_BASE_FRAME::GetBoard(), GetChars(), DIALOG_NETLIST_BASE::m_cbDeleteExtraFootprints, DIALOG_NETLIST_BASE::m_cbDeleteSinglePadNets, DIALOG_NETLIST_BASE::m_cbUpdateFootprints, DIALOG_NETLIST_BASE::m_matchByTimestamp, DIALOG_NETLIST_BASE::m_MessageWindow, DIALOG_NETLIST_BASE::m_NetlistFilenameCtrl, m_parent, m_runDragCommand, PCB_EDIT_FRAME::OnNetlistChanged(), PCB_EDIT_FRAME::ReadNetlistFromFile(), WX_HTML_REPORT_PANEL::Reporter(), REPORTER::ReportHead(), REPORTER::RPT_INFO, NETLIST::SetDeleteExtraFootprints(), NETLIST::SetFindByTimeStamp(), WX_HTML_REPORT_PANEL::SetLazyUpdate(), NETLIST::SetReplaceFootprints(), and BOARD_NETLIST_UPDATER::SetReporter().

Referenced by DIALOG_NETLIST(), onFilenameChanged(), OnMatchChanged(), OnOptionChanged(), and OnUpdatePCB().

◆ OnCompileRatsnestClick()

void DIALOG_NETLIST::OnCompileRatsnestClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_BASE.

Definition at line 248 of file pcbnew/dialogs/dialog_netlist.cpp.

249 {
250  // Rebuild the board connectivity:
251  auto board = m_parent->GetBoard();
252  board->GetConnectivity()->RecalculateRatsnest();
253 }
PCB_EDIT_FRAME * m_parent
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:292
BOARD * GetBoard() const

References PCB_BASE_FRAME::GetBoard(), BOARD::GetConnectivity(), and m_parent.

◆ onFilenameChanged()

void DIALOG_NETLIST::onFilenameChanged ( )
private

Definition at line 212 of file pcbnew/dialogs/dialog_netlist.cpp.

213 {
214  if( m_initialized )
215  {
216  wxFileName fn = m_NetlistFilenameCtrl->GetValue();
217  if( fn.IsOk() )
218  {
219  if( fn.FileExists() )
220  {
221  loadNetlist( true );
222  }
223  else
224  {
226  REPORTER& reporter = m_MessageWindow->Reporter();
227  reporter.Report( _("The netlist file does not exist."), REPORTER::RPT_ERROR );
228  }
229  }
230  }
231 }
Class REPORTER is a pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:61
REPORTER & Reporter()
returns the reporter object that reports to this panel
WX_HTML_REPORT_PANEL * m_MessageWindow
void Clear()
clears the report panel
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_UNDEFINED)=0
Function Report is a pure virtual function to override in the derived object.

References WX_HTML_REPORT_PANEL::Clear(), loadNetlist(), m_initialized, DIALOG_NETLIST_BASE::m_MessageWindow, DIALOG_NETLIST_BASE::m_NetlistFilenameCtrl, REPORTER::Report(), WX_HTML_REPORT_PANEL::Reporter(), and REPORTER::RPT_ERROR.

Referenced by OnFilenameKillFocus(), and OnOpenNetlistClick().

◆ OnFilenameKillFocus()

void DIALOG_NETLIST::OnFilenameKillFocus ( wxFocusEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_BASE.

Definition at line 206 of file pcbnew/dialogs/dialog_netlist.cpp.

207 {
209 }

References onFilenameChanged().

◆ OnMatchChanged()

void DIALOG_NETLIST::OnMatchChanged ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_BASE.

Definition at line 234 of file pcbnew/dialogs/dialog_netlist.cpp.

235 {
236  if( m_initialized )
237  loadNetlist( true );
238 }

References loadNetlist(), and m_initialized.

◆ OnOpenNetlistClick()

void DIALOG_NETLIST::OnOpenNetlistClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_BASE.

Definition at line 128 of file pcbnew/dialogs/dialog_netlist.cpp.

129 {
130  wxString dirPath = wxFileName( Prj().GetProjectFullName() ).GetPath();
131 
132  wxString filename = m_parent->GetLastNetListRead();
133 
134  if( !filename.IsEmpty() )
135  {
136  wxFileName fn = filename;
137  dirPath = fn.GetPath();
138  filename = fn.GetFullName();
139  }
140 
141  wxFileDialog FilesDialog( this, _( "Select Netlist" ), dirPath, filename,
142  NetlistFileWildcard(), wxFD_DEFAULT_STYLE | wxFD_FILE_MUST_EXIST );
143 
144  if( FilesDialog.ShowModal() != wxID_OK )
145  return;
146 
147  m_NetlistFilenameCtrl->SetValue( FilesDialog.GetPath() );
149 }
PCB_EDIT_FRAME * m_parent
wxString NetlistFileWildcard()
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
wxString GetLastNetListRead()
Get the last net list read with the net list dialog box.

References PCB_EDIT_FRAME::GetLastNetListRead(), DIALOG_NETLIST_BASE::m_NetlistFilenameCtrl, m_parent, NetlistFileWildcard(), onFilenameChanged(), and KIWAY_HOLDER::Prj().

◆ OnOptionChanged()

void DIALOG_NETLIST::OnOptionChanged ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_BASE.

Definition at line 241 of file pcbnew/dialogs/dialog_netlist.cpp.

242 {
243  if( m_initialized )
244  loadNetlist( true );
245 }

References loadNetlist(), and m_initialized.

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 298 of file dialog_shim.cpp.

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

References DIALOG_SHIM::m_firstPaintEvent, DIALOG_SHIM::m_initialFocusTarget, and selectAllInTextCtrls().

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnTestFootprintsClick()

void DIALOG_NETLIST::OnTestFootprintsClick ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_BASE.

Definition at line 179 of file pcbnew/dialogs/dialog_netlist.cpp.

180 {
181  if( m_parent->GetBoard()->m_Modules == nullptr )
182  {
183  DisplayInfoMessage( this, _( "No footprints." ) );
184  return;
185  }
186 
187  wxString netlistFilename = m_NetlistFilenameCtrl->GetValue();
188  NETLIST netlist;
189  wxBusyCursor dummy; // Shows an hourglass while calculating.
190 
191  if( !m_parent->ReadNetlistFromFile( netlistFilename, netlist, NULL_REPORTER::GetInstance() ) )
192  return;
193 
194  HTML_MESSAGE_BOX dlg( this, _( "Check footprints" ) );
195  DRC_LIST drcItems;
196 
197  DRC::TestFootprints( netlist, m_parent->GetBoard(), GetUserUnits(), drcItems );
198 
199  for( DRC_ITEM* item : drcItems )
200  dlg.AddHTML_Text( item->ShowHtml( GetUserUnits() ) );
201 
202  dlg.ShowModal();
203 }
Class DRC_ITEM is a holder for a DRC (in Pcbnew) or ERC (in Eeschema) error item.
Definition: drc_item.h:48
PCB_EDIT_FRAME * m_parent
bool ReadNetlistFromFile(const wxString &aFilename, NETLIST &aNetlist, REPORTER &aReporter)
Reads a netlist from a file into a NETLIST object.
Definition: netlist.cpp:60
static void TestFootprints(NETLIST &aNetlist, BOARD *aPCB, EDA_UNITS_T aUnits, DRC_LIST &aDRCList)
Test the board footprints against a netlist.
Definition: drc.cpp:1485
Class NETLIST stores all of information read from a netlist along with the flags used to update the N...
Definition: pcb_netlist.h:214
std::vector< DRC_ITEM * > DRC_LIST
Definition: drc.h:177
Class HTML_MESSAGE_BOX.
static LIB_PART * dummy()
Used when a LIB_PART is not found in library to draw a dummy shape This component is a 400 mils squar...
DLIST< MODULE > m_Modules
Definition: class_board.h:248
static REPORTER & GetInstance()
Definition: reporter.cpp:104
BOARD * GetBoard() const
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Function DisplayInfoMessage displays an informational message box with aMessage.
Definition: confirm.cpp:276
EDA_UNITS_T GetUserUnits() const override
Definition: dialog_shim.h:133

References HTML_MESSAGE_BOX::AddHTML_Text(), DisplayInfoMessage(), dummy(), PCB_BASE_FRAME::GetBoard(), NULL_REPORTER::GetInstance(), DIALOG_SHIM::GetUserUnits(), BOARD::m_Modules, DIALOG_NETLIST_BASE::m_NetlistFilenameCtrl, m_parent, PCB_EDIT_FRAME::ReadNetlistFromFile(), and DRC::TestFootprints().

◆ OnUpdatePCB()

void DIALOG_NETLIST::OnUpdatePCB ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_BASE.

Definition at line 151 of file pcbnew/dialogs/dialog_netlist.cpp.

152 {
153  wxFileName fn = m_NetlistFilenameCtrl->GetValue();
154 
155  if( !fn.IsOk() )
156  {
157  wxMessageBox( _("Please, choose a valid netlist file.") );
158  return;
159  }
160 
161  if( !fn.FileExists() )
162  {
163  wxMessageBox( _("The netlist file does not exist.") );
164  return;
165  }
166 
167  // Give the user a chance to bail out when making changes from a netlist.
168  if( m_parent->GetBoard()->IsEmpty()
169  || IsOK( this, _( "The changes made cannot be undone. Are you sure you want to update the PCB?" ) ) )
170  {
171  m_MessageWindow->SetLabel( _( "Changes Applied To PCB" ) );
172  loadNetlist( false );
173 
174  m_sdbSizer1Cancel->SetDefault();
175  }
176 }
PCB_EDIT_FRAME * m_parent
WX_HTML_REPORT_PANEL * m_MessageWindow
BOARD * GetBoard() const
void SetLabel(const wxString &aLabel) override
sets the frame label
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Function IsOK displays a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:294
bool IsEmpty() const
Definition: class_board.h:269

References PCB_BASE_FRAME::GetBoard(), BOARD::IsEmpty(), IsOK(), loadNetlist(), DIALOG_NETLIST_BASE::m_MessageWindow, DIALOG_NETLIST_BASE::m_NetlistFilenameCtrl, m_parent, DIALOG_NETLIST_BASE::m_sdbSizer1Cancel, and WX_HTML_REPORT_PANEL::SetLabel().

◆ OnUpdateUIValidNetlistFile()

void DIALOG_NETLIST::OnUpdateUIValidNetlistFile ( wxUpdateUIEvent &  aEvent)
overrideprivatevirtual

Reimplemented from DIALOG_NETLIST_BASE.

Definition at line 256 of file pcbnew/dialogs/dialog_netlist.cpp.

257 {
258  aEvent.Enable( !m_NetlistFilenameCtrl->GetValue().IsEmpty() );
259 }

References DIALOG_NETLIST_BASE::m_NetlistFilenameCtrl.

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 34 of file kiway_holder.cpp.

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

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkAliasName(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), KICAD_MANAGER_FRAME::CreateNewProject(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), PCB_EDIT_FRAME::doAutoSave(), SCH_DRAWING_TOOLS::doPlaceComponent(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), LIB_EDIT_FRAME::KiwayMailIn(), EDA_DRAW_FRAME::LibraryFileBrowser(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), KICAD_MANAGER_FRAME::LoadProject(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), LIB_VIEW_FRAME::OnAddPartToSchematic(), LIB_EDIT_FRAME::OnAddPartToSchematic(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowse(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnConfigurePaths(), FOOTPRINT_EDIT_FRAME::OnConfigurePaths(), KICAD_MANAGER_FRAME::OnCreateProjectFromTemplate(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLoadProject(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbModuleEditor(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), SCH_EDIT_FRAME::OnPrint(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), KICAD_MANAGER_FRAME::OnRunGerbview(), DIALOG_BOM::OnRunPlugin(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), KICAD_MANAGER_FRAME::OnSaveProject(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_PREV_3D::PANEL_PREV_3D(), SCH_EDITOR_CONTROL::Paste(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::PrintPage(), SCH_EDIT_FRAME::Process_Config(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::saveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), LIB_EDIT_FRAME::savePartAs(), SCH_EDIT_FRAME::SaveProject(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), LIB_EDIT_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), KICAD_MANAGER_FRAME::SetProjectFileName(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::UpdateTitle(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::Validate(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_EDITOR(), and PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME().

◆ SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow)
inlineinherited

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

Definition at line 116 of file dialog_shim.h.

117  {
118  m_initialFocusTarget = aWindow;
119  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:180

References DIALOG_SHIM::m_initialFocusTarget.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetKiway()

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

Function SetKiway.

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

Definition at line 53 of file kiway_holder.cpp.

54 {
55 #if defined(DEBUG)
56  // offer a trap point for debugging most any window
57  wxASSERT( aDest );
58  if( !strcmp( typeid(aDest).name(), "DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB" ) )
59  {
60  int breakhere=1;
61  (void) breakhere;
62  }
63 #endif
64 
65  (void) aDest;
66 
67  m_kiway = aKiway;
68 }
KIWAY * m_kiway
Definition: kiway_player.h:101
const char * name
Definition: DXF_plotter.cpp:61

References KIWAY_HOLDER::m_kiway, and name.

Referenced by InvokePcbLibTableEditor(), and SIM_PLOT_FRAME::SIM_PLOT_FRAME().

◆ SetSizeInDU()

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

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

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

Definition at line 150 of file dialog_shim.cpp.

151 {
152  wxSize sz( x, y );
153  SetSize( ConvertDialogToPixels( sz ) );
154 }

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CHOOSE_FOOTPRINT::DIALOG_CHOOSE_FOOTPRINT(), 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 178 of file dialog_shim.cpp.

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

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

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

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 343 of file dialog_shim.cpp.

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

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

Referenced by SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_TOOL::editFieldProperties(), LIB_EDIT_TOOL::editSymbolProperties(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), PCB_BASE_FRAME::InstallPadOptionsFrame(), InvokeDialogEditComponentsLibId(), InvokeDialogRescueEach(), InvokeDialogUpdateFields(), SCH_EDITOR_CONTROL::NavigateHierarchy(), PCB_EDIT_FRAME::OnEditTracksAndVias(), SCH_EDIT_FRAME::OnLaunchBomManager(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), EDIT_TOOL::Properties(), SCH_BASE_FRAME::SelectCompFromLibTree(), and PCB_BASE_FRAME::SelectFootprintFromLibTree().

◆ VertPixelsFromDU()

int DIALOG_SHIM::VertPixelsFromDU ( int  y)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 164 of file dialog_shim.cpp.

165 {
166  wxSize sz( 0, y );
167  return ConvertDialogToPixels( sz ).y;
168 }

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

Member Data Documentation

◆ m_browseButton

wxBitmapButton* DIALOG_NETLIST_BASE::m_browseButton
protectedinherited

◆ m_buttonFPTest

wxButton* DIALOG_NETLIST_BASE::m_buttonFPTest
protectedinherited

◆ m_buttonsSizer

wxBoxSizer* DIALOG_NETLIST_BASE::m_buttonsSizer
protectedinherited

◆ m_cbDeleteExtraFootprints

wxCheckBox* DIALOG_NETLIST_BASE::m_cbDeleteExtraFootprints
protectedinherited

◆ m_cbDeleteShortingTracks

wxCheckBox* DIALOG_NETLIST_BASE::m_cbDeleteShortingTracks
protectedinherited

◆ m_cbDeleteSinglePadNets

wxCheckBox* DIALOG_NETLIST_BASE::m_cbDeleteSinglePadNets
protectedinherited

◆ m_cbUpdateFootprints

wxCheckBox* DIALOG_NETLIST_BASE::m_cbUpdateFootprints
protectedinherited

◆ m_config

wxConfigBase* DIALOG_NETLIST::m_config
private

Definition at line 42 of file dialog_netlist.h.

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

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 179 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 180 of file dialog_shim.h.

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

◆ m_initialized

bool DIALOG_NETLIST::m_initialized
private

◆ m_matchByTimestamp

wxRadioBox* DIALOG_NETLIST_BASE::m_matchByTimestamp
protectedinherited

◆ m_MessageWindow

WX_HTML_REPORT_PANEL* DIALOG_NETLIST_BASE::m_MessageWindow
protectedinherited

◆ m_NetlistFilenameCtrl

◆ m_parent

PCB_EDIT_FRAME* DIALOG_NETLIST::m_parent
private

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

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

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

◆ m_runDragCommand

bool DIALOG_NETLIST::m_runDragCommand
private

Definition at line 44 of file dialog_netlist.h.

Referenced by loadNetlist(), and ~DIALOG_NETLIST().

◆ m_sdbSizer1

wxStdDialogButtonSizer* DIALOG_NETLIST_BASE::m_sdbSizer1
protectedinherited

◆ m_sdbSizer1Apply

wxButton* DIALOG_NETLIST_BASE::m_sdbSizer1Apply
protectedinherited

◆ m_sdbSizer1Cancel

wxButton* DIALOG_NETLIST_BASE::m_sdbSizer1Cancel
protectedinherited

◆ m_sdbSizer1OK

wxButton* DIALOG_NETLIST_BASE::m_sdbSizer1OK
protectedinherited

◆ m_units


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