KiCad PCB EDA Suite
DIALOG_CONFIGURE_PATHS Class Reference

#include <dialog_configure_paths.h>

Inheritance diagram for DIALOG_CONFIGURE_PATHS:
DIALOG_CONFIGURE_PATHS_BASE DIALOG_SHIM KIWAY_HOLDER

Public Types

enum  HOLDER_TYPE { DIALOG, FRAME, PANEL, SCREEN }
 

Public Member Functions

 DIALOG_CONFIGURE_PATHS (wxWindow *aParent, FILENAME_RESOLVER *aResolver)
 
 ~DIALOG_CONFIGURE_PATHS () override
 
bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
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 OnGridCellRightClick (wxGridEvent &event) override
 
void OnGridCellChange (wxGridEvent &event) override
 
void OnGridSize (wxSizeEvent &event) override
 
void OnUpdateUI (wxUpdateUIEvent &event) override
 
void OnGridCellChanging (wxGridEvent &event)
 
void OnAddEnvVar (wxCommandEvent &event) override
 
void OnRemoveEnvVar (wxCommandEvent &event) override
 
void OnAddSearchPath (wxCommandEvent &event) override
 
void OnDeleteSearchPath (wxCommandEvent &event) override
 
void OnSearchPathMoveUp (wxCommandEvent &event) override
 
void OnSearchPathMoveDown (wxCommandEvent &event) override
 
void OnHelp (wxCommandEvent &event) override
 
void AppendEnvVar (const wxString &aName, const wxString &aPath, bool isExternal)
 
void AppendSearchPath (const wxString &aName, const wxString &aPath, const wxString &aDesc)
 
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

WX_GRIDm_EnvVars
 
wxBitmapButton * m_btnAddEnvVar
 
wxBitmapButton * m_btnDeleteEnvVar
 
wxStaticBoxSizer * m_sb3DSearchPaths
 
WX_GRIDm_SearchPaths
 
wxBitmapButton * m_btnAddSearchPath
 
wxBitmapButton * m_btnMoveUp
 
wxBitmapButton * m_btnMoveDown
 
wxBitmapButton * m_btnDeleteSearchPath
 
wxStdDialogButtonSizer * m_sdbSizer
 
wxButton * m_sdbSizerOK
 
wxButton * m_sdbSizerCancel
 
wxButton * m_sdbSizerHelp
 
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

wxString m_errorMsg
 
wxGrid * m_errorGrid
 
int m_errorRow
 
int m_errorCol
 
FILENAME_RESOLVERm_resolver
 
wxString m_curdir
 
wxTextValidator m_aliasValidator
 
bool m_gridWidthsDirty
 

Detailed Description

Definition at line 38 of file dialog_configure_paths.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_CONFIGURE_PATHS()

DIALOG_CONFIGURE_PATHS::DIALOG_CONFIGURE_PATHS ( wxWindow *  aParent,
FILENAME_RESOLVER aResolver 
)

Definition at line 52 of file dialog_configure_paths.cpp.

52  :
53  DIALOG_CONFIGURE_PATHS_BASE( aParent ),
54  m_errorGrid( nullptr ), m_errorRow( -1 ), m_errorCol( -1 ),
55  m_resolver( aResolver ),
56  m_gridWidthsDirty( true )
57 {
58  m_btnAddEnvVar->SetBitmap( KiBitmap( small_plus_xpm ) );
59  m_btnDeleteEnvVar->SetBitmap( KiBitmap( trash_xpm ) );
60  m_btnAddSearchPath->SetBitmap( KiBitmap( small_plus_xpm ) );
61  m_btnDeleteSearchPath->SetBitmap( KiBitmap( trash_xpm ) );
62  m_btnMoveUp->SetBitmap( KiBitmap( small_up_xpm ) );
63  m_btnMoveDown->SetBitmap( KiBitmap( small_down_xpm ) );
64 
65  m_EnvVars->DeleteRows( 0, m_EnvVars->GetNumberRows() );
66  m_EnvVars->AppendCols( 1 ); // for the isExternal flags
67  m_EnvVars->HideCol( EV_FLAG_COL );
68  m_EnvVars->UseNativeColHeader( true );
69 
70  wxGridCellAttr* attr = new wxGridCellAttr;
71  attr->SetEditor( new GRID_CELL_PATH_EDITOR( this, &m_curdir ) );
72  m_EnvVars->SetColAttr( EV_PATH_COL, attr );
73 
74  attr = new wxGridCellAttr;
75  attr->SetEditor( new GRID_CELL_PATH_EDITOR( this, &m_curdir ) );
76  m_SearchPaths->SetColAttr( EV_PATH_COL, attr );
77 
78  // Give a bit more room for combobox editors
79  m_EnvVars->SetDefaultRowSize( m_EnvVars->GetDefaultRowSize() + 4 );
80  m_SearchPaths->SetDefaultRowSize( m_SearchPaths->GetDefaultRowSize() + 4 );
81 
82  m_EnvVars->PushEventHandler( new GRID_TRICKS( m_EnvVars ) );
83  m_SearchPaths->PushEventHandler( new GRID_TRICKS( m_SearchPaths ) );
84 
85  m_EnvVars->SetSelectionMode( wxGrid::wxGridSelectionModes::wxGridSelectRows );
86  m_SearchPaths->SetSelectionMode( wxGrid::wxGridSelectionModes::wxGridSelectRows );
87 
88  if( m_resolver )
89  {
90  m_SearchPaths->DeleteRows( 0, m_SearchPaths->GetNumberRows() );
91  m_SearchPaths->UseNativeColHeader( true );
92 
93  // prohibit these characters in the alias names: []{}()%~<>"='`;:.,&?/\|$
94  m_aliasValidator.SetStyle( wxFILTER_EXCLUDE_CHAR_LIST );
95  m_aliasValidator.SetCharExcludes( wxT( "{}[]()%~<>\"='`;:.,&?/\\|$" ) );
96  }
97  else
98  m_sb3DSearchPaths->Show( false );
99 
101  m_sdbSizerOK->SetDefault();
102 
103  // wxFormBuilder doesn't include this event...
104  m_EnvVars->Connect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( DIALOG_CONFIGURE_PATHS::OnGridCellChanging ), NULL, this );
105  m_SearchPaths->Connect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( DIALOG_CONFIGURE_PATHS::OnGridCellChanging ), NULL, this );
106 
107  GetSizer()->SetSizeHints( this );
108  Centre();
109 }
Class GRID_TRICKS is used to add mouse and command handling (such as cut, copy, and paste) to a WX_GR...
Definition: grid_tricks.h:51
void OnGridCellChanging(wxGridEvent &event)
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
Definition: dialog_shim.h:115
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:79
FILENAME_RESOLVER * m_resolver
DIALOG_CONFIGURE_PATHS_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Configure Paths"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)

References EV_FLAG_COL, EV_PATH_COL, KiBitmap(), m_aliasValidator, DIALOG_CONFIGURE_PATHS_BASE::m_btnAddEnvVar, DIALOG_CONFIGURE_PATHS_BASE::m_btnAddSearchPath, DIALOG_CONFIGURE_PATHS_BASE::m_btnDeleteEnvVar, DIALOG_CONFIGURE_PATHS_BASE::m_btnDeleteSearchPath, DIALOG_CONFIGURE_PATHS_BASE::m_btnMoveDown, DIALOG_CONFIGURE_PATHS_BASE::m_btnMoveUp, m_curdir, DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, m_resolver, DIALOG_CONFIGURE_PATHS_BASE::m_sb3DSearchPaths, DIALOG_CONFIGURE_PATHS_BASE::m_sdbSizerOK, DIALOG_CONFIGURE_PATHS_BASE::m_SearchPaths, OnGridCellChanging(), and DIALOG_SHIM::SetInitialFocus().

◆ ~DIALOG_CONFIGURE_PATHS()

DIALOG_CONFIGURE_PATHS::~DIALOG_CONFIGURE_PATHS ( )
override

Definition at line 112 of file dialog_configure_paths.cpp.

113 {
114  // Delete the GRID_TRICKS.
115  m_SearchPaths->PopEventHandler( true );
116  m_EnvVars->PopEventHandler( true );
117 
118  m_EnvVars->Disconnect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( DIALOG_CONFIGURE_PATHS::OnGridCellChanging ), NULL, this );
119  m_SearchPaths->Disconnect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( DIALOG_CONFIGURE_PATHS::OnGridCellChanging ), NULL, this );
120 }
void OnGridCellChanging(wxGridEvent &event)

References DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, DIALOG_CONFIGURE_PATHS_BASE::m_SearchPaths, and OnGridCellChanging().

Member Function Documentation

◆ AppendEnvVar()

void DIALOG_CONFIGURE_PATHS::AppendEnvVar ( const wxString &  aName,
const wxString &  aPath,
bool  isExternal 
)
protected

Definition at line 163 of file dialog_configure_paths.cpp.

165 {
166  int i = m_EnvVars->GetNumberRows();
167 
168  m_EnvVars->AppendRows( 1 );
169 
170  m_EnvVars->SetCellValue( i, EV_NAME_COL, aName );
171 
172  wxGridCellAttr* nameCellAttr = m_EnvVars->GetOrCreateCellAttr( i, EV_NAME_COL );
173  wxGridCellTextEditor* nameTextEditor = new GRID_CELL_TEXT_EDITOR();
174  nameTextEditor->SetValidator( ENV_VAR_NAME_VALIDATOR() );
175  nameCellAttr->SetEditor( nameTextEditor );
176  nameCellAttr->SetReadOnly( IsEnvVarImmutable( aName ) );
177  nameCellAttr->DecRef();
178 
179  m_EnvVars->SetCellValue( i, EV_PATH_COL, aPath );
180 
181  wxGridCellAttr* pathCellAttr = m_EnvVars->GetOrCreateCellAttr( i, EV_PATH_COL );
182  wxSystemColour c = isExternal ? wxSYS_COLOUR_MENU : wxSYS_COLOUR_LISTBOX;
183  pathCellAttr->SetBackgroundColour( wxSystemSettings::GetColour( c ) );
184  pathCellAttr->DecRef();
185 
186  m_EnvVars->SetCellValue( i, EV_FLAG_COL, isExternal ? wxT( "external" ) : wxEmptyString );
187 }
bool IsEnvVarImmutable(const wxString &aEnvVar)
Determine if an environment variable is "predefined", i.e.
Definition: env_vars.cpp:49
This class works around a bug in wxGrid where the first keystroke doesn't get sent through the valida...
Definition: validators.h:44
This class provides a custom wxValidator object for limiting the allowable characters when defining a...
Definition: validators.h:91
size_t i
Definition: json11.cpp:649

References EV_FLAG_COL, EV_NAME_COL, EV_PATH_COL, i, IsEnvVarImmutable(), and DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars.

Referenced by OnAddEnvVar(), and TransferDataToWindow().

◆ AppendSearchPath()

void DIALOG_CONFIGURE_PATHS::AppendSearchPath ( const wxString &  aName,
const wxString &  aPath,
const wxString &  aDesc 
)
protected

Definition at line 190 of file dialog_configure_paths.cpp.

192 {
193  int i = m_SearchPaths->GetNumberRows();
194 
195  m_SearchPaths->AppendRows( 1 );
196 
197  m_SearchPaths->SetCellValue( i, SP_ALIAS_COL, aName );
198 
199  wxGridCellAttr* nameCellAttr = m_SearchPaths->GetOrCreateCellAttr( i, SP_ALIAS_COL );
200  wxGridCellTextEditor* nameTextEditor = new GRID_CELL_TEXT_EDITOR();
201  nameTextEditor->SetValidator( m_aliasValidator );
202  nameCellAttr->SetEditor( nameTextEditor );
203  nameCellAttr->DecRef();
204 
205  m_SearchPaths->SetCellValue( i, SP_PATH_COL, aPath );
206  m_SearchPaths->SetCellValue( i, SP_DESC_COL, aDescription );
207 }
This class works around a bug in wxGrid where the first keystroke doesn't get sent through the valida...
Definition: validators.h:44
size_t i
Definition: json11.cpp:649

References i, m_aliasValidator, DIALOG_CONFIGURE_PATHS_BASE::m_SearchPaths, SP_ALIAS_COL, SP_DESC_COL, and SP_PATH_COL.

Referenced by OnAddSearchPath(), and TransferDataToWindow().

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

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

◆ OnAddEnvVar()

void DIALOG_CONFIGURE_PATHS::OnAddEnvVar ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 356 of file dialog_configure_paths.cpp.

357 {
359  return;
360 
361  AppendEnvVar( wxEmptyString, wxEmptyString, false );
362 
363  m_EnvVars->MakeCellVisible( m_EnvVars->GetNumberRows() - 1, EV_NAME_COL );
364  m_EnvVars->SetGridCursor( m_EnvVars->GetNumberRows() - 1, EV_NAME_COL );
365 
366  m_EnvVars->EnableCellEditControl( true );
367  m_EnvVars->ShowCellEditControl();
368 }
void AppendEnvVar(const wxString &aName, const wxString &aPath, bool isExternal)
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172

References AppendEnvVar(), WX_GRID::CommitPendingChanges(), EV_NAME_COL, and DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars.

◆ OnAddSearchPath()

void DIALOG_CONFIGURE_PATHS::OnAddSearchPath ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 371 of file dialog_configure_paths.cpp.

372 {
374  return;
375 
376  AppendSearchPath( wxEmptyString, wxEmptyString, wxEmptyString);
377 
378  m_SearchPaths->MakeCellVisible( m_SearchPaths->GetNumberRows() - 1, SP_ALIAS_COL );
379  m_SearchPaths->SetGridCursor( m_SearchPaths->GetNumberRows() - 1, SP_ALIAS_COL );
380 
381  m_SearchPaths->EnableCellEditControl( true );
382  m_SearchPaths->ShowCellEditControl();
383 }
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
void AppendSearchPath(const wxString &aName, const wxString &aPath, const wxString &aDesc)

References AppendSearchPath(), WX_GRID::CommitPendingChanges(), DIALOG_CONFIGURE_PATHS_BASE::m_SearchPaths, and SP_ALIAS_COL.

◆ OnDeleteSearchPath()

void DIALOG_CONFIGURE_PATHS::OnDeleteSearchPath ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 406 of file dialog_configure_paths.cpp.

407 {
408  int curRow = m_SearchPaths->GetGridCursorRow();
409 
410  if( curRow < 0 || m_SearchPaths->GetNumberRows() <= curRow )
411  return;
412 
413  m_SearchPaths->CommitPendingChanges( true /* silent mode; we don't care if it's valid */ );
414  m_SearchPaths->DeleteRows( curRow, 1 );
415 
416  m_SearchPaths->MakeCellVisible( std::max( 0, curRow-1 ), m_SearchPaths->GetGridCursorCol() );
417  m_SearchPaths->SetGridCursor( std::max( 0, curRow-1 ), m_SearchPaths->GetGridCursorCol() );
418 }
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
#define max(a, b)
Definition: auxiliary.h:86

References WX_GRID::CommitPendingChanges(), DIALOG_CONFIGURE_PATHS_BASE::m_SearchPaths, and max.

◆ OnGridCellChange()

void DIALOG_CONFIGURE_PATHS::OnGridCellChange ( wxGridEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 494 of file dialog_configure_paths.cpp.

495 {
496  m_gridWidthsDirty = true;
497 
498  aEvent.Skip();
499 }

References m_gridWidthsDirty.

◆ OnGridCellChanging()

void DIALOG_CONFIGURE_PATHS::OnGridCellChanging ( wxGridEvent &  event)
protected

Definition at line 294 of file dialog_configure_paths.cpp.

295 {
296  wxGrid* grid = dynamic_cast<wxGrid*>( event.GetEventObject() );
297  int row = event.GetRow();
298  int col = event.GetCol();
299  wxString text = event.GetString();
300 
301  if( text.IsEmpty() )
302  {
303  if( grid == m_EnvVars )
304  {
305  if( col == EV_NAME_COL )
306  m_errorMsg = _( "Environment variable name cannot be empty." );
307  else
308  m_errorMsg = _( "Environment variable path cannot be empty." );
309  }
310  else
311  {
312  if( col == SP_ALIAS_COL )
313  m_errorMsg = _( "3D search path alias cannot be empty." );
314  else
315  m_errorMsg = _( "3D search path cannot be empty." );
316  }
317  m_errorGrid = dynamic_cast<wxGrid*>( event.GetEventObject() );
318  m_errorRow = row;
319  m_errorCol = col;
320 
321  event.Veto();
322  }
323 
324  if( grid == m_EnvVars )
325  {
326  if( col == EV_PATH_COL && m_EnvVars->GetCellValue( row, EV_FLAG_COL ).Length() )
327  {
328  wxString msg1 = _( "This path was defined externally to the running process and\n"
329  "will only be temporarily overwritten." );
330  wxString msg2 = _( "The next time KiCad is launched, any paths that have already\n"
331  "been defined are honored and any settings defined in the path\n"
332  "configuration dialog are ignored. If you did not intend for\n"
333  "this behavior, either rename any conflicting entries or remove\n"
334  "the external environment variable(s) from your system." );
335  KIDIALOG dlg( this, msg1, KIDIALOG::KD_WARNING );
336  dlg.ShowDetailedText( msg2 );
337  dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
338  dlg.ShowModal();
339  }
340  else if( col == EV_NAME_COL && m_EnvVars->GetCellValue( row, EV_NAME_COL ) != text )
341  {
342  if( text == PROJECT_VAR_NAME ) // This env var name is reserved and cannot be added here:
343  {
344  wxMessageBox( wxString::Format(
345  _( "The name %s is reserved, and cannot be used here" ),
346  PROJECT_VAR_NAME ) );
347  event.Veto();
348  }
349  else // Changing name; clear external flag
350  m_EnvVars->SetCellValue( row, EV_FLAG_COL, wxEmptyString );
351  }
352  }
353 }
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
Definition: confirm.h:44
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
Definition: project.h:37
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References _, KIDIALOG::DoNotShowCheckbox(), EV_FLAG_COL, EV_NAME_COL, EV_PATH_COL, Format(), KIDIALOG::KD_WARNING, DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, m_errorCol, m_errorGrid, m_errorMsg, m_errorRow, PROJECT_VAR_NAME, KIDIALOG::ShowModal(), and SP_ALIAS_COL.

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

◆ OnGridCellRightClick()

void DIALOG_CONFIGURE_PATHS::OnGridCellRightClick ( wxGridEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 469 of file dialog_configure_paths.cpp.

470 {
471  wxASSERT( (int) EV_PATH_COL == (int) SP_PATH_COL );
472 
473  if( aEvent.GetCol() == EV_PATH_COL )
474  {
475  wxMenu menu;
476 
477  AddMenuItem( &menu, 1, _( "File Browser..." ), KiBitmap( folder_xpm ) );
478  if( GetPopupMenuSelectionFromUser( menu ) == 1 )
479  {
480  wxDirDialog dlg( nullptr, _( "Select Path" ), m_curdir,
481  wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
482 
483  if( dlg.ShowModal() == wxID_OK )
484  {
485  wxGrid* grid = dynamic_cast<wxGrid*>( aEvent.GetEventObject() );
486  grid->SetCellValue( aEvent.GetRow(), EV_PATH_COL, dlg.GetPath() );
487  m_curdir = dlg.GetPath();
488  }
489  }
490  }
491 }
wxMenuItem * AddMenuItem(wxMenu *aMenu, int aId, const wxString &aText, const wxBitmap &aImage, wxItemKind aType=wxITEM_NORMAL)
Function AddMenuItem is an inline helper function to create and insert a menu item with an icon into ...
Definition: bitmap.cpp:251
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:79
#define _(s)

References _, AddMenuItem(), EV_PATH_COL, KiBitmap(), m_curdir, and SP_PATH_COL.

◆ OnGridSize()

void DIALOG_CONFIGURE_PATHS::OnGridSize ( wxSizeEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 550 of file dialog_configure_paths.cpp.

551 {
552  m_gridWidthsDirty = true;
553 
554  event.Skip();
555 }

References m_gridWidthsDirty.

◆ OnHelp()

void DIALOG_CONFIGURE_PATHS::OnHelp ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 558 of file dialog_configure_paths.cpp.

559 {
560  wxString msg = _( "Enter the name and value for each environment variable. Grey entries "
561  "are names that have been defined externally at the system or user "
562  "level. Environment variables defined at the system or user level "
563  "take precedence over the ones defined in this table. This means the "
564  "values in this table are ignored." );
565  msg << "<br><br><b>";
566  msg << _( "To ensure environment variable names are valid on all platforms, the name field "
567  "will only accept upper case letters, digits, and the underscore characters." );
568  msg << "</b>";
569 
570  for( const auto& var: GetPredefinedEnvVars() )
571  {
572  msg << "<br><br><b>" << var << "</b>";
573 
574  const auto desc = LookUpEnvVarHelp( var );
575 
576  if( desc.size() > 0 )
577  msg << ": " << desc;
578 
579  }
580 
581  HTML_MESSAGE_BOX dlg( GetParent(), _( "Environment Variable Help" ) );
582  dlg.SetDialogSizeInDU( 400, 250 );
583 
584  dlg.AddHTML_Text( msg );
585  dlg.ShowModal();
586 }
const ENV_VAR_LIST & GetPredefinedEnvVars()
Get the list of pre-defined environment variables.
Definition: env_vars.cpp:61
wxString LookUpEnvVarHelp(const wxString &aEnvVar)
Look up long-form help text for a given environment variable.
Definition: env_vars.cpp:99
Class HTML_MESSAGE_BOX.
#define _(s)

References _, HTML_MESSAGE_BOX::AddHTML_Text(), GetPredefinedEnvVars(), LookUpEnvVarHelp(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

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

◆ OnRemoveEnvVar()

void DIALOG_CONFIGURE_PATHS::OnRemoveEnvVar ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 386 of file dialog_configure_paths.cpp.

387 {
388  int curRow = m_EnvVars->GetGridCursorRow();
389 
390  if( curRow < 0 || m_EnvVars->GetNumberRows() <= curRow )
391  return;
392  else if( IsEnvVarImmutable( m_EnvVars->GetCellValue( curRow, EV_NAME_COL ) ) )
393  {
394  wxBell();
395  return;
396  }
397 
398  m_EnvVars->CommitPendingChanges( true /* silent mode; we don't care if it's valid */ );
399  m_EnvVars->DeleteRows( curRow, 1 );
400 
401  m_EnvVars->MakeCellVisible( std::max( 0, curRow-1 ), m_EnvVars->GetGridCursorCol() );
402  m_EnvVars->SetGridCursor( std::max( 0, curRow-1 ), m_EnvVars->GetGridCursorCol() );
403 }
bool IsEnvVarImmutable(const wxString &aEnvVar)
Determine if an environment variable is "predefined", i.e.
Definition: env_vars.cpp:49
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
#define max(a, b)
Definition: auxiliary.h:86

References WX_GRID::CommitPendingChanges(), EV_NAME_COL, IsEnvVarImmutable(), DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, and max.

◆ OnSearchPathMoveDown()

void DIALOG_CONFIGURE_PATHS::OnSearchPathMoveDown ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 445 of file dialog_configure_paths.cpp.

446 {
448  return;
449 
450  int curRow = m_SearchPaths->GetGridCursorRow();
451  int nextRow = curRow + 1;
452 
453  if( curRow < m_SearchPaths->GetNumberRows() - 1 )
454  {
455  for( int i = 0; i < m_SearchPaths->GetNumberCols(); ++i )
456  {
457  wxString tmp = m_SearchPaths->GetCellValue( curRow, i );
458  m_SearchPaths->SetCellValue( curRow, i, m_SearchPaths->GetCellValue( nextRow, i ) );
459  m_SearchPaths->SetCellValue( nextRow, i, tmp );
460  }
461 
462  m_SearchPaths->SetGridCursor( nextRow, m_SearchPaths->GetGridCursorCol() );
463  }
464  else
465  wxBell();
466 }
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
size_t i
Definition: json11.cpp:649

References WX_GRID::CommitPendingChanges(), i, and DIALOG_CONFIGURE_PATHS_BASE::m_SearchPaths.

◆ OnSearchPathMoveUp()

void DIALOG_CONFIGURE_PATHS::OnSearchPathMoveUp ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 421 of file dialog_configure_paths.cpp.

422 {
424  return;
425 
426  int curRow = m_SearchPaths->GetGridCursorRow();
427  int prevRow = curRow - 1;
428 
429  if( curRow > 0 )
430  {
431  for( int i = 0; i < m_SearchPaths->GetNumberCols(); ++i )
432  {
433  wxString tmp = m_SearchPaths->GetCellValue( curRow, i );
434  m_SearchPaths->SetCellValue( curRow, i, m_SearchPaths->GetCellValue( prevRow, i ) );
435  m_SearchPaths->SetCellValue( prevRow, i, tmp );
436  }
437 
438  m_SearchPaths->SetGridCursor( prevRow, m_SearchPaths->GetGridCursorCol() );
439  }
440  else
441  wxBell();
442 }
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
size_t i
Definition: json11.cpp:649

References WX_GRID::CommitPendingChanges(), i, and DIALOG_CONFIGURE_PATHS_BASE::m_SearchPaths.

◆ OnUpdateUI()

void DIALOG_CONFIGURE_PATHS::OnUpdateUI ( wxUpdateUIEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 502 of file dialog_configure_paths.cpp.

503 {
504  if( m_gridWidthsDirty && ( !m_EnvVars->IsCellEditControlShown()
505  && !m_SearchPaths->IsCellEditControlShown() ) )
506  {
507  int width = m_EnvVars->GetClientRect().GetWidth();
508 
509  m_EnvVars->AutoSizeColumn( EV_NAME_COL );
510  m_EnvVars->SetColSize( EV_NAME_COL, std::max( m_EnvVars->GetColSize( EV_NAME_COL ), 120 ) );
511 
512  m_EnvVars->SetColSize( EV_PATH_COL, width - m_EnvVars->GetColSize( EV_NAME_COL ) );
513 
514  width = m_SearchPaths->GetClientRect().GetWidth();
515 
516  m_SearchPaths->AutoSizeColumn( SP_ALIAS_COL );
517  m_SearchPaths->SetColSize( SP_ALIAS_COL, std::max( m_SearchPaths->GetColSize( SP_ALIAS_COL ), 120 ) );
518 
519  m_SearchPaths->AutoSizeColumn( SP_PATH_COL );
520  m_SearchPaths->SetColSize( SP_PATH_COL, std::max( m_SearchPaths->GetColSize( SP_PATH_COL ), 300 ) );
521 
522  m_SearchPaths->SetColSize( SP_DESC_COL, width - ( m_SearchPaths->GetColSize( SP_ALIAS_COL )
523  + m_SearchPaths->GetColSize( SP_PATH_COL ) ) );
524  m_gridWidthsDirty = false;
525  }
526 
527  // Handle a grid error. This is delayed to OnUpdateUI so that we can change focus
528  // even when the original validation was triggered from a killFocus event (and for
529  // dialog with notebooks, so that the corresponding notebook page can be shown in
530  // the background when triggered from an OK).
531  if( m_errorGrid )
532  {
533  // We will re-enter this routine when the error dialog is displayed, so make
534  // sure we don't keep putting up more dialogs.
535  wxGrid* grid = m_errorGrid;
536  m_errorGrid = nullptr;
537 
539 
540  grid->SetFocus();
541  grid->MakeCellVisible( m_errorRow, m_errorCol );
542  grid->SetGridCursor( m_errorRow, m_errorCol );
543 
544  grid->EnableCellEditControl( true );
545  grid->ShowCellEditControl();
546  }
547 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:249
#define max(a, b)
Definition: auxiliary.h:86

References DisplayErrorMessage(), EV_NAME_COL, EV_PATH_COL, DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, m_errorCol, m_errorGrid, m_errorMsg, m_errorRow, m_gridWidthsDirty, DIALOG_CONFIGURE_PATHS_BASE::m_SearchPaths, max, SP_ALIAS_COL, SP_DESC_COL, and SP_PATH_COL.

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

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

◆ 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 DIALOG_CONFIGURE_PATHS::TransferDataFromWindow ( )
override

Definition at line 210 of file dialog_configure_paths.cpp.

211 {
213  return false;
214 
215  if( !wxDialog::TransferDataFromWindow() )
216  return false;
217 
218  // Environment variables
219 
220  ENV_VAR_MAP envVarMap;
221 
222  for( int row = 0; row < m_EnvVars->GetNumberRows(); ++row )
223  {
224  wxString name = m_EnvVars->GetCellValue( row, EV_NAME_COL );
225  wxString path = m_EnvVars->GetCellValue( row, EV_PATH_COL );
226  wxString external = m_EnvVars->GetCellValue( row, EV_FLAG_COL );
227 
228  if( external.Length() )
229  continue;
230 
231  if( name.IsEmpty() )
232  {
234  m_errorRow = row;
236  m_errorMsg = _( "Environment variable name cannot be empty." );
237  return false;
238  }
239  else if( path.IsEmpty() )
240  {
242  m_errorRow = row;
244  m_errorMsg = _( "Environment variable path cannot be empty." );
245  return false;
246  }
247 
248  envVarMap[ name ] = ENV_VAR_ITEM( path );
249  }
250 
251  Pgm().SetLocalEnvVariables( envVarMap );
252 
253  // 3D search paths
254 
255  if( m_resolver )
256  {
257  std::vector<SEARCH_PATH> alist;
258  SEARCH_PATH alias;
259 
260  for( int row = 0; row < m_SearchPaths->GetNumberRows(); ++row )
261  {
262  alias.m_alias = m_SearchPaths->GetCellValue( row, SP_ALIAS_COL );
263  alias.m_pathvar = m_SearchPaths->GetCellValue( row, SP_PATH_COL );
264  alias.m_description = m_SearchPaths->GetCellValue( row, SP_DESC_COL );
265 
266  if( alias.m_alias.IsEmpty() )
267  {
269  m_errorRow = row;
271  m_errorMsg = _( "3D search path alias cannot be empty." );
272  return false;
273  }
274  else if( alias.m_pathvar.IsEmpty() )
275  {
277  m_errorRow = row;
279  m_errorMsg = _( "3D search path cannot be empty." );
280  return false;
281  }
282 
283  alist.push_back( alias );
284  }
285 
286  if( !m_resolver->UpdatePathList( alist ) )
287  return false;
288  }
289 
290  return true;
291 }
Class ENV_VAR_ITEM.
Definition: pgm_base.h:107
wxString m_alias
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:66
bool UpdatePathList(std::vector< SEARCH_PATH > &aPathList)
Function UpdatePathList clears the current path list and substitutes the given path list,...
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
Definition: pgm_base.h:136
FILENAME_RESOLVER * m_resolver
wxString m_description
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:172
#define _(s)
VTBL_ENTRY void SetLocalEnvVariables(const ENV_VAR_MAP &aEnvVarMap)
Function SetLocalEnvVariables.
Definition: pgm_base.cpp:795
wxString m_pathvar
const char * name
Definition: DXF_plotter.cpp:61

References _, WX_GRID::CommitPendingChanges(), EV_FLAG_COL, EV_NAME_COL, EV_PATH_COL, SEARCH_PATH::m_alias, SEARCH_PATH::m_description, DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, m_errorCol, m_errorGrid, m_errorMsg, m_errorRow, SEARCH_PATH::m_pathvar, m_resolver, DIALOG_CONFIGURE_PATHS_BASE::m_SearchPaths, name, Pgm(), PGM_BASE::SetLocalEnvVariables(), SP_ALIAS_COL, SP_DESC_COL, SP_PATH_COL, and FILENAME_RESOLVER::UpdatePathList().

◆ TransferDataToWindow()

bool DIALOG_CONFIGURE_PATHS::TransferDataToWindow ( )
override

Definition at line 123 of file dialog_configure_paths.cpp.

124 {
125  if( !wxDialog::TransferDataToWindow() )
126  return false;
127 
128  // Do 3D search paths first so they get first crack at setting m_curdir
129 
130  if( m_resolver )
131  {
132  const std::list<SEARCH_PATH>* paths = m_resolver->GetPaths();
133 
134  for( auto it = paths->begin(); it != paths->end(); ++it )
135  {
136  if ( !( *it ).m_alias.StartsWith( "${" ) && !( *it ).m_alias.StartsWith( "$(" ) )
137  {
138  AppendSearchPath( it->m_alias, it->m_pathvar, it->m_description );
139 
140  if( m_curdir.IsEmpty() )
141  m_curdir = it->m_pathexp;
142  }
143  }
144  }
145 
146  // Environment variables
147 
148  const ENV_VAR_MAP& envVars = Pgm().GetLocalEnvVariables();
149 
150  for( auto it = envVars.begin(); it != envVars.end(); ++it )
151  {
152  const wxString& path = it->second.GetValue();
153  AppendEnvVar( it->first, path, it->second.GetDefinedExternally() );
154 
155  if( m_curdir.IsEmpty() && !path.StartsWith( "${" ) && !path.StartsWith( "$(" ) )
156  m_curdir = path;
157  }
158 
159  return true;
160 }
const std::list< SEARCH_PATH > * GetPaths(void)
Function GetPaths returns a pointer to the internal path list; the items in:load.
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:66
void AppendEnvVar(const wxString &aName, const wxString &aPath, bool isExternal)
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
Definition: pgm_base.h:136
FILENAME_RESOLVER * m_resolver
VTBL_ENTRY const ENV_VAR_MAP & GetLocalEnvVariables() const
Definition: pgm_base.h:315
void AppendSearchPath(const wxString &aName, const wxString &aPath, const wxString &aDesc)

References AppendEnvVar(), AppendSearchPath(), PGM_BASE::GetLocalEnvVariables(), FILENAME_RESOLVER::GetPaths(), m_curdir, m_resolver, and Pgm().

◆ 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_aliasValidator

wxTextValidator DIALOG_CONFIGURE_PATHS::m_aliasValidator
private

Definition at line 73 of file dialog_configure_paths.h.

Referenced by AppendSearchPath(), and DIALOG_CONFIGURE_PATHS().

◆ m_btnAddEnvVar

wxBitmapButton* DIALOG_CONFIGURE_PATHS_BASE::m_btnAddEnvVar
protectedinherited

◆ m_btnAddSearchPath

wxBitmapButton* DIALOG_CONFIGURE_PATHS_BASE::m_btnAddSearchPath
protectedinherited

◆ m_btnDeleteEnvVar

wxBitmapButton* DIALOG_CONFIGURE_PATHS_BASE::m_btnDeleteEnvVar
protectedinherited

◆ m_btnDeleteSearchPath

wxBitmapButton* DIALOG_CONFIGURE_PATHS_BASE::m_btnDeleteSearchPath
protectedinherited

◆ m_btnMoveDown

wxBitmapButton* DIALOG_CONFIGURE_PATHS_BASE::m_btnMoveDown
protectedinherited

◆ m_btnMoveUp

wxBitmapButton* DIALOG_CONFIGURE_PATHS_BASE::m_btnMoveUp
protectedinherited

◆ m_curdir

wxString DIALOG_CONFIGURE_PATHS::m_curdir
private

◆ m_EnvVars

◆ m_errorCol

int DIALOG_CONFIGURE_PATHS::m_errorCol
private

Definition at line 69 of file dialog_configure_paths.h.

Referenced by OnGridCellChanging(), OnUpdateUI(), and TransferDataFromWindow().

◆ m_errorGrid

wxGrid* DIALOG_CONFIGURE_PATHS::m_errorGrid
private

Definition at line 67 of file dialog_configure_paths.h.

Referenced by OnGridCellChanging(), OnUpdateUI(), and TransferDataFromWindow().

◆ m_errorMsg

wxString DIALOG_CONFIGURE_PATHS::m_errorMsg
private

Definition at line 66 of file dialog_configure_paths.h.

Referenced by OnGridCellChanging(), OnUpdateUI(), and TransferDataFromWindow().

◆ m_errorRow

int DIALOG_CONFIGURE_PATHS::m_errorRow
private

Definition at line 68 of file dialog_configure_paths.h.

Referenced by OnGridCellChanging(), OnUpdateUI(), and TransferDataFromWindow().

◆ m_firstPaintEvent

bool DIALOG_SHIM::m_firstPaintEvent
protectedinherited

Definition at line 199 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

◆ m_gridWidthsDirty

bool DIALOG_CONFIGURE_PATHS::m_gridWidthsDirty
private

Definition at line 75 of file dialog_configure_paths.h.

Referenced by OnGridCellChange(), OnGridSize(), and OnUpdateUI().

◆ 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_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_resolver

FILENAME_RESOLVER* DIALOG_CONFIGURE_PATHS::m_resolver
private

◆ m_sb3DSearchPaths

wxStaticBoxSizer* DIALOG_CONFIGURE_PATHS_BASE::m_sb3DSearchPaths
protectedinherited

◆ m_sdbSizer

wxStdDialogButtonSizer* DIALOG_CONFIGURE_PATHS_BASE::m_sdbSizer
protectedinherited

◆ m_sdbSizerCancel

wxButton* DIALOG_CONFIGURE_PATHS_BASE::m_sdbSizerCancel
protectedinherited

◆ m_sdbSizerHelp

wxButton* DIALOG_CONFIGURE_PATHS_BASE::m_sdbSizerHelp
protectedinherited

◆ m_sdbSizerOK

wxButton* DIALOG_CONFIGURE_PATHS_BASE::m_sdbSizerOK
protectedinherited

◆ m_SearchPaths

◆ m_tabOrder

◆ m_units


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