KiCad PCB EDA Suite
DIALOG_BOARD_SETUP Class Reference

#include <dialog_board_setup.h>

Inheritance diagram for DIALOG_BOARD_SETUP:
PAGED_DIALOG DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL, SCREEN }
 

Public Member Functions

 DIALOG_BOARD_SETUP (PCB_EDIT_FRAME *aFrame)
 
 ~DIALOG_BOARD_SETUP ()
 
wxTreebook * GetTreebook ()
 
void SetInitialPage (const wxString &aPage, const wxString &aParentPage=wxEmptyString)
 
void SetError (const wxString &aMessage, wxWindow *aPage, wxObject *aCtrl, int aRow=-1, int aCol=-1)
 
void SetInitialFocus (wxWindow *aWindow)
 Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown. More...
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
void OnPaint (wxPaintEvent &event)
 
EDA_UNITS_T GetUserUnits () const
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

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

Protected Member Functions

void OnAuxiliaryAction (wxCommandEvent &event) override
 
void OnPageChange (wxBookCtrlEvent &event)
 
void finishInitialization ()
 
bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
void OnUpdateUI (wxUpdateUIEvent &event)
 
void FinishDialogSettings ()
 In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...
 
void SetSizeInDU (int x, int y)
 Set the dialog to the given dimensions in "dialog units". More...
 
int HorizPixelsFromDU (int x)
 Convert an integer number of dialog units to pixels, horizontally. More...
 
int VertPixelsFromDU (int y)
 Convert an integer number of dialog units to pixels, vertically. More...
 
void ResetSize ()
 Clear the existing dialog size and position. More...
 

Protected Attributes

PCB_EDIT_FRAMEm_frame
 
PANEL_SETUP_FEATURE_CONSTRAINTSm_constraints
 
PANEL_SETUP_LAYERSm_layers
 
PANEL_SETUP_TEXT_AND_GRAPHICSm_textAndGraphics
 
PANEL_SETUP_NETCLASSESm_netclasses
 
PANEL_SETUP_TRACKS_AND_VIASm_tracksAndVias
 
PANEL_SETUP_MASK_AND_PASTEm_maskAndPaste
 
PANEL_SETUP_BOARD_STACKUPm_physicalStackup
 
wxTreebook * m_treebook
 
wxButton * m_auxiliaryButton
 
EDA_UNITS_T m_units
 
std::string m_hash_key
 
bool m_firstPaintEvent
 
wxWindow * m_initialFocusTarget
 
WX_EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 
std::vector< wxWindow * > m_tabOrder
 

Private Attributes

int m_physicalStackupPage
 

Detailed Description

Definition at line 36 of file dialog_board_setup.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 
SCREEN 

Definition at line 42 of file kiway_holder.h.

Constructor & Destructor Documentation

◆ DIALOG_BOARD_SETUP()

DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP ( PCB_EDIT_FRAME aFrame)

Definition at line 32 of file dialog_board_setup.cpp.

32  :
33  PAGED_DIALOG( aFrame, _( "Board Setup" ), _( "Import Settings from Another Project..." ) ),
34  m_frame( aFrame )
35 {
36  m_layers = new PANEL_SETUP_LAYERS( this, aFrame );
38  m_constraints = new PANEL_SETUP_FEATURE_CONSTRAINTS( this, aFrame );
39  m_netclasses = new PANEL_SETUP_NETCLASSES( this, aFrame, m_constraints );
41  m_maskAndPaste = new PANEL_SETUP_MASK_AND_PASTE( this, aFrame );
43 
44  /*
45  * WARNING: If you change page names you MUST update calls to DoShowBoardSetupDialog().
46  */
47 
48  m_treebook->AddPage( new wxPanel( this ), _( "Board Stackup" ) );
49  m_treebook->AddSubPage( m_layers, _( "Board Editor Layers" ) );
50  m_treebook->AddSubPage( m_physicalStackup, _( "Physical Stackup" ) );
51  // Change this value if m_physicalStackup is not the page 2 of m_treebook
52  m_physicalStackupPage = 2; // The page number (from 0) to select the m_physicalStackup panel
53 
54  m_treebook->AddPage( new wxPanel( this ), _( "Defaults" ) );
55  m_treebook->AddSubPage( m_textAndGraphics, _( "Text & Graphics" ) );
56  m_treebook->AddSubPage( m_tracksAndVias, _( "Tracks & Vias" ) );
57  m_treebook->AddSubPage( m_maskAndPaste, _( "Solder Mask/Paste" ) );
58 
59  m_treebook->AddPage( new wxPanel( this ), _( "Design Rules" ) );
60  m_treebook->AddSubPage( m_constraints, _( "Constraints" ) );
61  m_treebook->AddSubPage( m_netclasses, _( "Net Classes" ) );
62 
63  // Connect Events
64  m_treebook->Connect( wxEVT_TREEBOOK_PAGE_CHANGED,
65  wxBookCtrlEventHandler( DIALOG_BOARD_SETUP::OnPageChange ), NULL, this );
66 }
PANEL_SETUP_NETCLASSES * m_netclasses
PCB_EDIT_FRAME * m_frame
PANEL_SETUP_BOARD_STACKUP * m_physicalStackup
PAGED_DIALOG(wxWindow *aParent, const wxString &aTitle, const wxString &aAuxiliaryAction=wxEmptyString)
wxTreebook * m_treebook
Definition: paged_dialog.h:59
#define _(s)
PANEL_SETUP_TRACKS_AND_VIAS * m_tracksAndVias
PANEL_SETUP_TEXT_AND_GRAPHICS * m_textAndGraphics
PANEL_SETUP_MASK_AND_PASTE * m_maskAndPaste
PANEL_SETUP_LAYERS * m_layers
void OnPageChange(wxBookCtrlEvent &event)
PANEL_SETUP_FEATURE_CONSTRAINTS * m_constraints

References _, m_constraints, m_layers, m_maskAndPaste, m_netclasses, m_physicalStackup, m_physicalStackupPage, m_textAndGraphics, m_tracksAndVias, PAGED_DIALOG::m_treebook, and OnPageChange().

◆ ~DIALOG_BOARD_SETUP()

DIALOG_BOARD_SETUP::~DIALOG_BOARD_SETUP ( )

Definition at line 69 of file dialog_board_setup.cpp.

70 {
71  m_treebook->Disconnect( wxEVT_TREEBOOK_PAGE_CHANGED,
72  wxBookCtrlEventHandler( DIALOG_BOARD_SETUP::OnPageChange ), NULL, this );
73 }
wxTreebook * m_treebook
Definition: paged_dialog.h:59
void OnPageChange(wxBookCtrlEvent &event)

References PAGED_DIALOG::m_treebook, and OnPageChange().

Member Function Documentation

◆ Enable()

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 263 of file dialog_shim.cpp.

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

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 423 of file dialog_shim.cpp.

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

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(), HTML_MESSAGE_BOX::OnOKButtonClick(), 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 138 of file dialog_shim.cpp.

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

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::DIALOG_EDIT_COMPONENT_IN_SCHEMATIC(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_FOOTPRINTS_DISPLAY_OPTIONS::DIALOG_FOOTPRINTS_DISPLAY_OPTIONS(), DIALOG_FP_BROWSER_DISPLAY_OPTIONS::DIALOG_FP_BROWSER_DISPLAY_OPTIONS(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_KEEPOUT_AREA_PROPERTIES::DIALOG_KEEPOUT_AREA_PROPERTIES(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_LIB_NEW_COMPONENT::DIALOG_LIB_NEW_COMPONENT(), DIALOG_LIST_HOTKEYS::DIALOG_LIST_HOTKEYS(), DIALOG_MOVE_EXACT::DIALOG_MOVE_EXACT(), DIALOG_NETLIST::DIALOG_NETLIST(), DIALOG_NON_COPPER_ZONES_EDITOR::DIALOG_NON_COPPER_ZONES_EDITOR(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PASTE_SPECIAL::DIALOG_PASTE_SPECIAL(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_UPDATE_FIELDS::TransferDataToWindow(), DIALOG_COLOR_PICKER::TransferDataToWindow(), and DIALOG_BOARD_STATISTICS::TransferDataToWindow().

◆ finishInitialization()

void PAGED_DIALOG::finishInitialization ( )
protectedinherited

Definition at line 86 of file paged_dialog.cpp.

87 {
88  // For some reason adding page labels to the treeCtrl doesn't invalidate its bestSize
89  // cache so we have to do it by hand
90  m_treebook->GetTreeCtrl()->InvalidateBestSize();
91 
92  for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
93  {
94  m_treebook->ExpandNode( i );
95  m_treebook->GetPage( i )->Layout();
96  }
97 
98  m_treebook->Fit();
99  m_treebook->Layout();
100 
102 }
void FinishDialogSettings()
In all dialogs, we must call the same functions to fix minimal dlg size, the default position and per...
wxTreebook * m_treebook
Definition: paged_dialog.h:59
size_t i
Definition: json11.cpp:649

References DIALOG_SHIM::FinishDialogSettings(), i, and PAGED_DIALOG::m_treebook.

Referenced by PAGED_DIALOG::TransferDataToWindow().

◆ GetTreebook()

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( )
inlineinherited

Definition at line 49 of file kiway_holder.h.

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

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), PL_EDITOR_FRAME::SaveSettings(), and GERBVIEW_FRAME::SaveSettings().

◆ GetUserUnits()

◆ HorizPixelsFromDU()

int DIALOG_SHIM::HorizPixelsFromDU ( int  x)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 159 of file dialog_shim.cpp.

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

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

◆ IsCtrl()

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

Definition at line 134 of file dialog_shim.h.

135  {
136  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
137  !e.ShiftDown() && !e.MetaDown();
138  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook(), and DIALOG_LABEL_EDITOR::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 140 of file dialog_shim.h.

141  {
142  return e.GetKeyCode() == aChar && e.ControlDown() && !e.AltDown() &&
143  e.ShiftDown() && !e.MetaDown();
144  }

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook(), and DIALOG_LABEL_EDITOR::OnCharHook().

◆ Kiway()

KIWAY& KIWAY_HOLDER::Kiway ( ) const
inlineinherited

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

A KIWAY_HOLDER is not necessarily a KIWAY_PLAYER.

Definition at line 56 of file kiway_holder.h.

57  {
58  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
59  return *m_kiway;
60  }
KIWAY * m_kiway
Definition: kiway_holder.h:81

References KIWAY_HOLDER::m_kiway.

Referenced by TREEPROJECT_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_CONTROL::AddSymbolToSchematic(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), COMMON_CONTROL::ConfigurePaths(), DIALOG_CHOOSE_FOOTPRINT::ConstructRightPanel(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), SCH_EDIT_FRAME::CreateScreens(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SHIM::DIALOG_SHIM(), CVPCB_MAINFRAME::DisplayStatus(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), EDIT_TOOL::EditFpInFpEditor(), SCH_EDIT_FRAME::EditSheet(), SCH_EDITOR_CONTROL::EditWithLibEdit(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::InitSheet(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), SCH_EDIT_FRAME::LoadSheetFromFile(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), TEXT_BUTTON_FP_CHOOSER::OnButtonClick(), KICAD_MANAGER_FRAME::OnCloseWindow(), SCH_EDIT_FRAME::OnCloseWindow(), PL_EDITOR_FRAME::OnExit(), SCH_EDIT_FRAME::OnExit(), FOOTPRINT_EDIT_FRAME::OnExitKiCad(), FOOTPRINT_VIEWER_FRAME::OnExitKiCad(), LIB_EDIT_FRAME::OnExitKiCad(), SAVE_AS_TRAVERSER::OnFile(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnOpenCvpcb(), SCH_EDIT_FRAME::OnOpenPcbnew(), EDA_BASE_FRAME::OnPreferences(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeClearHighlight(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlistToCvpcb(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::UpdatePart(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnAuxiliaryAction()

void DIALOG_BOARD_SETUP::OnAuxiliaryAction ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from PAGED_DIALOG.

Definition at line 84 of file dialog_board_setup.cpp.

85 {
86  DIALOG_IMPORT_SETTINGS importDlg( this, m_frame );
87 
88  if( importDlg.ShowModal() == wxID_CANCEL )
89  return;
90 
91  wxConfigBase* cfg = new wxFileConfig( wxEmptyString, wxEmptyString, importDlg.GetFilePath() );
92 
93  // We do not want expansion of env var values when reading our project config file
94  cfg->SetExpandEnvVars( false );
95  cfg->SetPath( wxCONFIG_PATH_SEPARATOR );
96 
97  BOARD* dummyBoard = new BOARD();
98  PARAM_CFG_ARRAY designSettingsConfig;
99 
100  dummyBoard->GetDesignSettings().AppendConfigs( dummyBoard, &designSettingsConfig );
101  wxConfigLoadParams( cfg, designSettingsConfig, GROUP_PCB );
102 
103  if( importDlg.m_LayersOpt->GetValue() )
104  m_layers->ImportSettingsFrom( dummyBoard );
105  if( importDlg.m_TextAndGraphicsOpt->GetValue() )
106  m_textAndGraphics->ImportSettingsFrom( dummyBoard );
107  if( importDlg.m_ConstraintsOpt->GetValue() )
108  m_constraints->ImportSettingsFrom( dummyBoard );
109  if( importDlg.m_NetclassesOpt->GetValue() )
110  m_netclasses->ImportSettingsFrom( dummyBoard );
111  if( importDlg.m_TracksAndViasOpt->GetValue() )
112  m_tracksAndVias->ImportSettingsFrom( dummyBoard );
113  if( importDlg.m_MaskAndPasteOpt->GetValue() )
114  m_maskAndPaste->ImportSettingsFrom( dummyBoard );
115 
116  // If layers options are imported, import also the stackup
117  // layers options and stackup are linked, so they cannot be imported
118  // separately, and stackup can be imported only after layers options
119  //
120  // Note also currently only the list of enabled layers can be imported, because
121  // we import settings from a .pro project file, not the settings inside
122  // a board, and info only living in the board is not imported.
123  if( importDlg.m_LayersOpt->GetValue() )
124  m_physicalStackup->ImportSettingsFrom( dummyBoard );
125 
126  delete dummyBoard;
127  delete cfg;
128 }
A list of parameters type.
PANEL_SETUP_NETCLASSES * m_netclasses
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:531
PCB_EDIT_FRAME * m_frame
void wxConfigLoadParams(wxConfigBase *aCfg, const PARAM_CFG_ARRAY &aList, const wxString &aGroup)
Function wxConfigLoadParams uses aList of PARAM_CFG_ARRAY elements to load configuration values from ...
PANEL_SETUP_BOARD_STACKUP * m_physicalStackup
void ImportSettingsFrom(BOARD *aBoard)
void ImportSettingsFrom(BOARD *aBoard)
void AppendConfigs(BOARD *aBoard, PARAM_CFG_ARRAY *aResult)
Function AppendConfigs appends to aResult the configuration setting accessors which will later allow ...
void ImportSettingsFrom(BOARD *aBoard)
PANEL_SETUP_TRACKS_AND_VIAS * m_tracksAndVias
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:161
PANEL_SETUP_TEXT_AND_GRAPHICS * m_textAndGraphics
PANEL_SETUP_MASK_AND_PASTE * m_maskAndPaste
PANEL_SETUP_LAYERS * m_layers
#define GROUP_PCB
Names of sub sections where to store project info in *.pro project config files.
Definition: config_params.h:43
PANEL_SETUP_FEATURE_CONSTRAINTS * m_constraints

References BOARD_DESIGN_SETTINGS::AppendConfigs(), BOARD::GetDesignSettings(), DIALOG_IMPORT_SETTINGS::GetFilePath(), GROUP_PCB, PANEL_SETUP_MASK_AND_PASTE::ImportSettingsFrom(), PANEL_SETUP_TEXT_AND_GRAPHICS::ImportSettingsFrom(), PANEL_SETUP_FEATURE_CONSTRAINTS::ImportSettingsFrom(), PANEL_SETUP_LAYERS::ImportSettingsFrom(), PANEL_SETUP_TRACKS_AND_VIAS::ImportSettingsFrom(), PANEL_SETUP_BOARD_STACKUP::ImportSettingsFrom(), PANEL_SETUP_NETCLASSES::ImportSettingsFrom(), m_constraints, DIALOG_IMPORT_SETTINGS_BASE::m_ConstraintsOpt, m_frame, m_layers, DIALOG_IMPORT_SETTINGS_BASE::m_LayersOpt, m_maskAndPaste, DIALOG_IMPORT_SETTINGS_BASE::m_MaskAndPasteOpt, m_netclasses, DIALOG_IMPORT_SETTINGS_BASE::m_NetclassesOpt, m_physicalStackup, m_textAndGraphics, DIALOG_IMPORT_SETTINGS_BASE::m_TextAndGraphicsOpt, m_tracksAndVias, DIALOG_IMPORT_SETTINGS_BASE::m_TracksAndViasOpt, and wxConfigLoadParams().

◆ OnPageChange()

void DIALOG_BOARD_SETUP::OnPageChange ( wxBookCtrlEvent &  event)
protected

Definition at line 76 of file dialog_board_setup.cpp.

77 {
78  if( event.GetSelection() == m_physicalStackupPage )
80 }
PANEL_SETUP_BOARD_STACKUP * m_physicalStackup
void OnLayersOptionsChanged(LSET aNewLayerSet)
Must be called if the copper layers count has changed or solder mask, solder paste or silkscreen laye...
PANEL_SETUP_LAYERS * m_layers

References PANEL_SETUP_LAYERS::GetUILayerMask(), m_layers, m_physicalStackup, m_physicalStackupPage, and PANEL_SETUP_BOARD_STACKUP::OnLayersOptionsChanged().

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

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 324 of file dialog_shim.cpp.

325 {
326  if( m_firstPaintEvent )
327  {
328 #ifdef __WXMAC__
329  fixOSXCancelButtonIssue( this );
330 #endif
331 
332  selectAllInTextCtrls( GetChildren() );
333 
335  m_initialFocusTarget->SetFocus();
336  else
337  SetFocus(); // Focus the dialog itself
338 
339  m_firstPaintEvent = false;
340  }
341 
342  event.Skip();
343 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:200
bool m_firstPaintEvent
Definition: dialog_shim.h:199
static void selectAllInTextCtrls(wxWindowList &children)

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

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ OnUpdateUI()

void PAGED_DIALOG::OnUpdateUI ( wxUpdateUIEvent &  event)
protectedinherited

Definition at line 235 of file paged_dialog.cpp.

236 {
237  // Handle an error. This is delayed to OnUpdateUI so that we can change the focus
238  // even when the original validation was triggered from a killFocus event, and so
239  // that the corresponding notebook page can be shown in the background when triggered
240  // from an OK.
241  if( m_errorCtrl )
242  {
243  // We will re-enter this routine when the error dialog is displayed, so make
244  // sure we don't keep putting up more dialogs.
245  wxObject* ctrl = m_errorCtrl;
246  m_errorCtrl = nullptr;
247 
249 
250  auto textCtrl = dynamic_cast<wxTextCtrl*>( ctrl );
251  if( textCtrl )
252  {
253  auto textEntry = dynamic_cast<wxTextEntry*>( textCtrl );
254  textEntry->SetSelection( -1, -1 );
255  textCtrl->SetFocus();
256  return;
257  }
258 
259  auto grid = dynamic_cast<wxGrid*>( ctrl );
260 
261  if( grid )
262  {
263  grid->SetFocus();
264  grid->MakeCellVisible( m_errorRow, m_errorCol );
265  grid->SetGridCursor( m_errorRow, m_errorCol );
266 
267  grid->EnableCellEditControl( true );
268  grid->ShowCellEditControl();
269  return;
270  }
271  }
272 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:249
wxString m_errorMessage
Definition: paged_dialog.h:33
wxObject * m_errorCtrl
Definition: paged_dialog.h:34

References DisplayErrorMessage(), PAGED_DIALOG::m_errorCol, PAGED_DIALOG::m_errorCtrl, PAGED_DIALOG::m_errorMessage, and PAGED_DIALOG::m_errorRow.

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

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 34 of file kiway_holder.cpp.

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

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

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

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

239 {
240  const char* hash_key;
241 
242  if( m_hash_key.size() )
243  {
244  // a special case like EDA_LIST_DIALOG, which has multiple uses.
245  hash_key = m_hash_key.c_str();
246  }
247  else
248  {
249  hash_key = typeid(*this).name();
250  }
251 
252  RECT_MAP::iterator it = class_map.find( hash_key );
253 
254  if( it == class_map.end() )
255  return;
256 
257  EDA_RECT rect = it->second;
258  rect.SetSize( 0, 0 );
259  class_map[ hash_key ] = rect;
260 }
std::string m_hash_key
Definition: dialog_shim.h:194
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:144
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44

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

Referenced by DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY().

◆ SetError()

void PAGED_DIALOG::SetError ( const wxString &  aMessage,
wxWindow *  aPage,
wxObject *  aCtrl,
int  aRow = -1,
int  aCol = -1 
)
inherited

Definition at line 214 of file paged_dialog.cpp.

216 {
217  for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
218  {
219  if( m_treebook->GetPage( i ) == aPage )
220  {
221  m_treebook->SetSelection( i );
222  break;
223  }
224  }
225 
226  // Once the page has been changed we want to wait for it to update before displaying
227  // the error dialog. So store the rest of the error info and wait for OnUpdateUI.
228  m_errorMessage = aMessage;
229  m_errorCtrl = aCtrl;
230  m_errorRow = aRow;
231  m_errorCol = aCol;
232 }
wxTreebook * m_treebook
Definition: paged_dialog.h:59
wxString m_errorMessage
Definition: paged_dialog.h:33
wxObject * m_errorCtrl
Definition: paged_dialog.h:34
size_t i
Definition: json11.cpp:649

References i, PAGED_DIALOG::m_errorCol, PAGED_DIALOG::m_errorCtrl, PAGED_DIALOG::m_errorMessage, PAGED_DIALOG::m_errorRow, and PAGED_DIALOG::m_treebook.

Referenced by PANEL_SETUP_LAYERS::testLayerNames(), PANEL_MODEDIT_DEFAULTS::validateData(), PANEL_SETUP_TEXT_AND_GRAPHICS::validateData(), PANEL_SETUP_TRACKS_AND_VIAS::validateData(), PANEL_SETUP_NETCLASSES::validateData(), and PANEL_SETUP_NETCLASSES::validateNetclassName().

◆ SetInitialFocus()

void DIALOG_SHIM::SetInitialFocus ( wxWindow *  aWindow)
inlineinherited

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

Definition at line 115 of file dialog_shim.h.

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

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_FIND::DIALOG_FIND(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_PIN::DIALOG_LIB_EDIT_PIN(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SET_GRID::DIALOG_SET_GRID(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetInitialPage()

void PAGED_DIALOG::SetInitialPage ( const wxString &  aPage,
const wxString &  aParentPage = wxEmptyString 
)
inherited

Definition at line 105 of file paged_dialog.cpp.

106 {
107  g_lastPage[ m_title ] = aPage;
108  g_lastParentPage[ m_title ] = aParentPage;
109 }
std::map< wxString, wxString > g_lastPage
std::map< wxString, wxString > g_lastParentPage
wxString m_title
Definition: paged_dialog.h:31

References g_lastPage, g_lastParentPage, and PAGED_DIALOG::m_title.

Referenced by PCB_EDIT_FRAME::DoShowBoardSetupDialog().

◆ SetKiway()

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

Function SetKiway.

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

Definition at line 41 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

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

◆ SetSizeInDU()

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

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

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

Definition at line 152 of file dialog_shim.cpp.

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

Referenced by DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

◆ Show()

bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 179 of file dialog_shim.cpp.

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

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

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

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 369 of file dialog_shim.cpp.

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

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

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

◆ TransferDataFromWindow()

bool PAGED_DIALOG::TransferDataFromWindow ( )
overrideprotectedinherited

Definition at line 191 of file paged_dialog.cpp.

192 {
193  // Call TransferDataFromWindow() only once:
194  // this is enough on wxWidgets 3.1
195  if( !DIALOG_SHIM::TransferDataFromWindow() )
196  return false;
197 
198  // On wxWidgets 3.0, TransferDataFromWindow() is not called recursively
199  // so we have to call it for each page
200 #if !wxCHECK_VERSION( 3, 1, 0 )
201  for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
202  {
203  wxWindow* page = m_treebook->GetPage( i );
204 
205  if( !page->TransferDataFromWindow() )
206  return false;
207  }
208 #endif
209 
210  return true;
211 }
wxTreebook * m_treebook
Definition: paged_dialog.h:59
size_t i
Definition: json11.cpp:649

References i, and PAGED_DIALOG::m_treebook.

◆ TransferDataToWindow()

bool PAGED_DIALOG::TransferDataToWindow ( )
overrideprotectedinherited

Definition at line 140 of file paged_dialog.cpp.

141 {
143 
144  // Call TransferDataToWindow() only once:
145  // this is enough on wxWidgets 3.1
146  if( !DIALOG_SHIM::TransferDataToWindow() )
147  return false;
148 
149  // On wxWidgets 3.0, TransferDataFromWindow() is not called recursively
150  // so we have to call it for each page
151 #if !wxCHECK_VERSION( 3, 1, 0 )
152  for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
153  {
154  wxWindow* page = m_treebook->GetPage( i );
155 
156  if( !page->TransferDataToWindow() )
157  return false;
158  }
159 #endif
160 
161  // Search for a page matching the lastParentPageTitle/lastPageTitle hierarchy
162  wxString lastPage = g_lastPage[ m_title ];
163  wxString lastParentPage = g_lastParentPage[ m_title ];
164  int lastPageIndex = wxNOT_FOUND;
165 
166  for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
167  {
168  if( m_treebook->GetPageText( i ) == lastPage )
169  {
170  if( lastParentPage.IsEmpty() )
171  {
172  lastPageIndex = i;
173  break;
174  }
175 
176  if( m_treebook->GetPageParent( i ) >= 0
177  && m_treebook->GetPageText( (unsigned) m_treebook->GetPageParent( i ) ) == lastParentPage )
178  {
179  lastPageIndex = i;
180  break;
181  }
182  }
183  }
184 
185  m_treebook->SetSelection( (unsigned) std::max( 0, lastPageIndex ) );
186 
187  return true;
188 }
std::map< wxString, wxString > g_lastPage
std::map< wxString, wxString > g_lastParentPage
wxTreebook * m_treebook
Definition: paged_dialog.h:59
#define max(a, b)
Definition: auxiliary.h:86
size_t i
Definition: json11.cpp:649
void finishInitialization()
wxString m_title
Definition: paged_dialog.h:31

References PAGED_DIALOG::finishInitialization(), g_lastPage, g_lastParentPage, i, PAGED_DIALOG::m_title, PAGED_DIALOG::m_treebook, and max.

◆ VertPixelsFromDU()

int DIALOG_SHIM::VertPixelsFromDU ( int  y)
protectedinherited

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

See SetSizeInDU or wxDialog documentation for more information.

Definition at line 166 of file dialog_shim.cpp.

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

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

Member Data Documentation

◆ m_auxiliaryButton

wxButton* PAGED_DIALOG::m_auxiliaryButton
protectedinherited

Definition at line 60 of file paged_dialog.h.

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

◆ m_constraints

PANEL_SETUP_FEATURE_CONSTRAINTS* DIALOG_BOARD_SETUP::m_constraints
protected

Definition at line 47 of file dialog_board_setup.h.

Referenced by DIALOG_BOARD_SETUP(), and OnAuxiliaryAction().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 199 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_frame

PCB_EDIT_FRAME* DIALOG_BOARD_SETUP::m_frame
protected

Definition at line 45 of file dialog_board_setup.h.

Referenced by OnAuxiliaryAction().

◆ m_hash_key

◆ m_initialFocusTarget

wxWindow* DIALOG_SHIM::m_initialFocusTarget
protectedinherited

Definition at line 200 of file dialog_shim.h.

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

◆ m_layers

PANEL_SETUP_LAYERS* DIALOG_BOARD_SETUP::m_layers
protected

Definition at line 48 of file dialog_board_setup.h.

Referenced by DIALOG_BOARD_SETUP(), OnAuxiliaryAction(), and OnPageChange().

◆ m_maskAndPaste

PANEL_SETUP_MASK_AND_PASTE* DIALOG_BOARD_SETUP::m_maskAndPaste
protected

Definition at line 52 of file dialog_board_setup.h.

Referenced by DIALOG_BOARD_SETUP(), and OnAuxiliaryAction().

◆ m_netclasses

PANEL_SETUP_NETCLASSES* DIALOG_BOARD_SETUP::m_netclasses
protected

Definition at line 50 of file dialog_board_setup.h.

Referenced by DIALOG_BOARD_SETUP(), and OnAuxiliaryAction().

◆ m_physicalStackup

PANEL_SETUP_BOARD_STACKUP* DIALOG_BOARD_SETUP::m_physicalStackup
protected

Definition at line 53 of file dialog_board_setup.h.

Referenced by DIALOG_BOARD_SETUP(), OnAuxiliaryAction(), and OnPageChange().

◆ m_physicalStackupPage

int DIALOG_BOARD_SETUP::m_physicalStackupPage
private

Definition at line 59 of file dialog_board_setup.h.

Referenced by DIALOG_BOARD_SETUP(), and OnPageChange().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

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

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

◆ m_tabOrder

◆ m_textAndGraphics

PANEL_SETUP_TEXT_AND_GRAPHICS* DIALOG_BOARD_SETUP::m_textAndGraphics
protected

Definition at line 49 of file dialog_board_setup.h.

Referenced by DIALOG_BOARD_SETUP(), and OnAuxiliaryAction().

◆ m_tracksAndVias

PANEL_SETUP_TRACKS_AND_VIAS* DIALOG_BOARD_SETUP::m_tracksAndVias
protected

Definition at line 51 of file dialog_board_setup.h.

Referenced by DIALOG_BOARD_SETUP(), and OnAuxiliaryAction().

◆ m_treebook

◆ m_units


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