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 }
 

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 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)
 
static void FixOSXCancelButtonIssue (wxWindow *aWindow)
 

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 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
 
EDA_BASE_FRAMEm_parentFrame
 
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 

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 54 of file dialog_configure_paths.cpp.

54  :
55  DIALOG_CONFIGURE_PATHS_BASE( aParent ),
56  m_errorGrid( nullptr ), m_errorRow( -1 ), m_errorCol( -1 ),
57  m_resolver( aResolver ),
58  m_gridWidthsDirty( true )
59 {
60  m_btnAddEnvVar->SetBitmap( KiBitmap( small_plus_xpm ) );
61  m_btnDeleteEnvVar->SetBitmap( KiBitmap( trash_xpm ) );
63  m_btnDeleteSearchPath->SetBitmap( KiBitmap( trash_xpm ) );
64  m_btnMoveUp->SetBitmap( KiBitmap( small_up_xpm ) );
65  m_btnMoveDown->SetBitmap( KiBitmap( small_down_xpm ) );
66 
67  m_EnvVars->DeleteRows( 0, m_EnvVars->GetNumberRows() );
68  m_EnvVars->AppendCols( 1 ); // for the isExternal flags
69  m_EnvVars->HideCol( TV_FLAG_COL );
70  m_EnvVars->UseNativeColHeader( true );
71 
72  wxGridCellAttr* attr = new wxGridCellAttr;
73  attr->SetEditor( new GRID_CELL_PATH_EDITOR( this, &m_curdir, wxEmptyString ) );
74  m_EnvVars->SetColAttr( TV_VALUE_COL, attr );
75 
76  attr = new wxGridCellAttr;
77  attr->SetEditor( new GRID_CELL_PATH_EDITOR( this, &m_curdir, wxEmptyString ) );
78  m_SearchPaths->SetColAttr( TV_VALUE_COL, attr );
79 
80  // Give a bit more room for combobox editors
81  m_EnvVars->SetDefaultRowSize( m_EnvVars->GetDefaultRowSize() + 4 );
82  m_SearchPaths->SetDefaultRowSize( m_SearchPaths->GetDefaultRowSize() + 4 );
83 
84  m_EnvVars->PushEventHandler( new GRID_TRICKS( m_EnvVars ) );
85  m_SearchPaths->PushEventHandler( new GRID_TRICKS( m_SearchPaths ) );
86 
87  m_EnvVars->SetSelectionMode( wxGrid::wxGridSelectionModes::wxGridSelectRows );
88  m_SearchPaths->SetSelectionMode( wxGrid::wxGridSelectionModes::wxGridSelectRows );
89 
90  if( m_resolver )
91  {
92  m_SearchPaths->DeleteRows( 0, m_SearchPaths->GetNumberRows() );
93  m_SearchPaths->UseNativeColHeader( true );
94 
95  // prohibit these characters in the alias names: []{}()%~<>"='`;:.,&?/\|$
96  m_aliasValidator.SetStyle( wxFILTER_EXCLUDE_CHAR_LIST );
97  m_aliasValidator.SetCharExcludes( wxT( "{}[]()%~<>\"='`;:.,&?/\\|$" ) );
98  }
99  else
100  m_sb3DSearchPaths->Show( false );
101 
103  m_sdbSizerOK->SetDefault();
104 
105  // wxFormBuilder doesn't include this event...
106  m_EnvVars->Connect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( DIALOG_CONFIGURE_PATHS::OnGridCellChanging ), NULL, this );
107  m_SearchPaths->Connect( wxEVT_GRID_CELL_CHANGING, wxGridEventHandler( DIALOG_CONFIGURE_PATHS::OnGridCellChanging ), NULL, this );
108 
109  GetSizer()->SetSizeHints( this );
110  Centre();
111 }
const BITMAP_OPAQUE trash_xpm[1]
Definition: trash.cpp:46
GRID_TRICKS is used to add mouse and command handling (such as cut, copy, and paste) to a WX_GRID ins...
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:114
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:80
#define NULL
FILENAME_RESOLVER * m_resolver
const BITMAP_OPAQUE small_down_xpm[1]
Definition: small_down.cpp:25
const BITMAP_OPAQUE small_up_xpm[1]
Definition: small_up.cpp:26
const BITMAP_OPAQUE small_plus_xpm[1]
Definition: small_plus.cpp:20
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 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, NULL, OnGridCellChanging(), DIALOG_SHIM::SetInitialFocus(), small_down_xpm, small_plus_xpm, small_up_xpm, trash_xpm, TV_FLAG_COL, and TV_VALUE_COL.

◆ ~DIALOG_CONFIGURE_PATHS()

DIALOG_CONFIGURE_PATHS::~DIALOG_CONFIGURE_PATHS ( )
override

Definition at line 114 of file dialog_configure_paths.cpp.

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

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

Member Function Documentation

◆ AppendEnvVar()

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

Definition at line 165 of file dialog_configure_paths.cpp.

167 {
168  int i = m_EnvVars->GetNumberRows();
169 
170  m_EnvVars->AppendRows( 1 );
171 
172  m_EnvVars->SetCellValue( i, TV_NAME_COL, aName );
173 
174  wxGridCellAttr* nameCellAttr = m_EnvVars->GetOrCreateCellAttr( i, TV_NAME_COL );
175  wxGridCellTextEditor* nameTextEditor = new GRID_CELL_TEXT_EDITOR();
176  nameTextEditor->SetValidator( ENV_VAR_NAME_VALIDATOR() );
177  nameCellAttr->SetEditor( nameTextEditor );
178  nameCellAttr->SetReadOnly( IsEnvVarImmutable( aName ) );
179  nameCellAttr->DecRef();
180 
181  m_EnvVars->SetCellValue( i, TV_VALUE_COL, aPath );
182 
183  wxGridCellAttr* pathCellAttr = m_EnvVars->GetOrCreateCellAttr( i, TV_VALUE_COL );
184  wxSystemColour c = isExternal ? wxSYS_COLOUR_MENU : wxSYS_COLOUR_LISTBOX;
185  pathCellAttr->SetBackgroundColour( wxSystemSettings::GetColour( c ) );
186  pathCellAttr->DecRef();
187 
188  m_EnvVars->SetCellValue( i, TV_FLAG_COL, isExternal ? wxT( "external" ) : wxEmptyString );
189 }
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

References IsEnvVarImmutable(), DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, TV_FLAG_COL, TV_NAME_COL, and TV_VALUE_COL.

Referenced by OnAddEnvVar(), and TransferDataToWindow().

◆ AppendSearchPath()

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

Definition at line 192 of file dialog_configure_paths.cpp.

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

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

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

◆ EndQuasiModal()

void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 399 of file dialog_shim.cpp.

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

References DIALOG_SHIM::IsQuasiModal(), DIALOG_SHIM::m_qmodal_loop, DIALOG_SHIM::m_qmodal_parent_disabler, NULL, 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 144 of file dialog_shim.cpp.

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

References PCAD2KICAD::Center.

Referenced by DIALOG_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOM::DIALOG_BOM(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DRC::DIALOG_DRC(), 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_EDITOR_DATA::DIALOG_EDITOR_DATA(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_ERC::DIALOG_ERC(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::DIALOG_EXPORT_SVG(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), DIALOG_GENCAD_EXPORT_OPTIONS::DIALOG_GENCAD_EXPORT_OPTIONS(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_GLOBAL_LIB_TABLE_CONFIG::DIALOG_GLOBAL_LIB_TABLE_CONFIG(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_IMAGE_EDITOR::DIALOG_IMAGE_EDITOR(), DIALOG_INSPECTOR::DIALOG_INSPECTOR(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), 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_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_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_PRINT_GENERIC::DIALOG_PRINT_GENERIC(), DIALOG_PRINT_USING_PRINTER::DIALOG_PRINT_USING_PRINTER(), DIALOG_PUSH_PAD_PROPERTIES::DIALOG_PUSH_PAD_PROPERTIES(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SELECT_NET_FROM_LIST::DIALOG_SELECT_NET_FROM_LIST(), 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_FROM_PCB::DIALOG_UPDATE_FROM_PCB(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), DLG_SELECT_3DMODEL::DLG_SELECT_3DMODEL(), PAGED_DIALOG::finishInitialization(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EDIT_LIBRARY_TABLES::InstallPanel(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SCH_SHEET_PROPS::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().

◆ FixOSXCancelButtonIssue()

static void DIALOG_SHIM::FixOSXCancelButtonIssue ( wxWindow *  aWindow)
staticinherited

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

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

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

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

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

Referenced by DIALOG_TEXT_PROPERTIES::OnCharHook().

◆ IsQuasiModal()

◆ IsShiftCtrl()

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

Definition at line 142 of file dialog_shim.h.

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

Referenced by DIALOG_TEXT_PROPERTIES::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(), 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(), PCB_EDITOR_CONTROL::EditFpInFpEditor(), SCH_EDITOR_CONTROL::EditWithLibEdit(), BACK_ANNOTATE::FetchNetlistFromPCB(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), PCB_EDIT_FRAME::importFile(), KICAD_MANAGER_FRAME::language_change(), KIWAY_PLAYER::language_change(), LIB_TREE_MODEL_ADAPTER::LIB_TREE_MODEL_ADAPTER(), CVPCB_MAINFRAME::LoadFootprintFiles(), KICAD_MANAGER_FRAME::LoadProject(), 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(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), SCH_EDIT_FRAME::OnUpdatePCB(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), KIWAY_HOLDER::Prj(), BACK_ANNOTATE::PushNewLinksToPCB(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDITOR_CONTROL::rescueProject(), EE_INSPECTION_TOOL::RunSimulation(), CVPCB_MAINFRAME::SaveFootprintAssociation(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), LIB_TREE_MODEL_ADAPTER::SavePinnedItems(), 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(), SCH_EDIT_FRAME::SetCrossProbeConnection(), CVPCB_CONTROL::ShowFootprintViewer(), COMMON_CONTROL::ShowLibraryTable(), COMMON_CONTROL::ShowPlayer(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), PCB_EDITOR_CONTROL::UpdateSchematicFromPCB(), and DIALOG_EXCHANGE_FOOTPRINTS::ViewAndSelectFootprint().

◆ OnAddEnvVar()

void DIALOG_CONFIGURE_PATHS::OnAddEnvVar ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 358 of file dialog_configure_paths.cpp.

359 {
361  return;
362 
363  AppendEnvVar( wxEmptyString, wxEmptyString, false );
364 
365  m_EnvVars->MakeCellVisible( m_EnvVars->GetNumberRows() - 1, TV_NAME_COL );
366  m_EnvVars->SetGridCursor( m_EnvVars->GetNumberRows() - 1, TV_NAME_COL );
367 
368  m_EnvVars->EnableCellEditControl( true );
369  m_EnvVars->ShowCellEditControl();
370 }
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:174

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

◆ OnAddSearchPath()

void DIALOG_CONFIGURE_PATHS::OnAddSearchPath ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 373 of file dialog_configure_paths.cpp.

374 {
376  return;
377 
378  AppendSearchPath( wxEmptyString, wxEmptyString, wxEmptyString);
379 
380  m_SearchPaths->MakeCellVisible( m_SearchPaths->GetNumberRows() - 1, SP_ALIAS_COL );
381  m_SearchPaths->SetGridCursor( m_SearchPaths->GetNumberRows() - 1, SP_ALIAS_COL );
382 
383  m_SearchPaths->EnableCellEditControl( true );
384  m_SearchPaths->ShowCellEditControl();
385 }
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:174
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 408 of file dialog_configure_paths.cpp.

409 {
410  int curRow = m_SearchPaths->GetGridCursorRow();
411 
412  if( curRow < 0 || m_SearchPaths->GetNumberRows() <= curRow )
413  return;
414 
415  m_SearchPaths->CommitPendingChanges( true /* silent mode; we don't care if it's valid */ );
416  m_SearchPaths->DeleteRows( curRow, 1 );
417 
418  // if there are still rows in grid, make previous row visible
419  if( m_SearchPaths->GetNumberRows() )
420  {
421  m_SearchPaths->MakeCellVisible( std::max( 0, curRow-1 ), m_SearchPaths->GetGridCursorCol() );
422  m_SearchPaths->SetGridCursor( std::max( 0, curRow-1 ), m_SearchPaths->GetGridCursorCol() );
423  }
424 }
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:174

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

◆ OnGridCellChange()

void DIALOG_CONFIGURE_PATHS::OnGridCellChange ( wxGridEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 500 of file dialog_configure_paths.cpp.

501 {
502  m_gridWidthsDirty = true;
503 
504  aEvent.Skip();
505 }

References m_gridWidthsDirty.

◆ OnGridCellChanging()

void DIALOG_CONFIGURE_PATHS::OnGridCellChanging ( wxGridEvent &  event)
protected

Definition at line 296 of file dialog_configure_paths.cpp.

297 {
298  wxGrid* grid = dynamic_cast<wxGrid*>( event.GetEventObject() );
299  int row = event.GetRow();
300  int col = event.GetCol();
301  wxString text = event.GetString();
302 
303  if( text.IsEmpty() )
304  {
305  if( grid == m_EnvVars )
306  {
307  if( col == TV_NAME_COL )
308  m_errorMsg = _( "Environment variable name cannot be empty." );
309  else
310  m_errorMsg = _( "Environment variable path cannot be empty." );
311  }
312  else
313  {
314  if( col == SP_ALIAS_COL )
315  m_errorMsg = _( "3D search path alias cannot be empty." );
316  else
317  m_errorMsg = _( "3D search path cannot be empty." );
318  }
319  m_errorGrid = dynamic_cast<wxGrid*>( event.GetEventObject() );
320  m_errorRow = row;
321  m_errorCol = col;
322 
323  event.Veto();
324  }
325 
326  if( grid == m_EnvVars )
327  {
328  if( col == TV_VALUE_COL && m_EnvVars->GetCellValue( row, TV_FLAG_COL ).Length() )
329  {
330  wxString msg1 = _( "This path was defined externally to the running process and\n"
331  "will only be temporarily overwritten." );
332  wxString msg2 = _( "The next time KiCad is launched, any paths that have already\n"
333  "been defined are honored and any settings defined in the path\n"
334  "configuration dialog are ignored. If you did not intend for\n"
335  "this behavior, either rename any conflicting entries or remove\n"
336  "the external environment variable(s) from your system." );
337  KIDIALOG dlg( this, msg1, KIDIALOG::KD_WARNING );
338  dlg.ShowDetailedText( msg2 );
339  dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
340  dlg.ShowModal();
341  }
342  else if( col == TV_NAME_COL && m_EnvVars->GetCellValue( row, TV_NAME_COL ) != text )
343  {
344  if( text == PROJECT_VAR_NAME ) // This env var name is reserved and cannot be added here:
345  {
346  wxMessageBox( wxString::Format(
347  _( "The name %s is reserved, and cannot be used here" ),
348  PROJECT_VAR_NAME ) );
349  event.Veto();
350  }
351  else // Changing name; clear external flag
352  m_EnvVars->SetCellValue( row, TV_FLAG_COL, wxEmptyString );
353  }
354  }
355 }
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:38
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
#define _(s)
Definition: 3d_actions.cpp:33

References _, KIDIALOG::DoNotShowCheckbox(), Format(), KIDIALOG::KD_WARNING, DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, m_errorCol, m_errorGrid, m_errorMsg, m_errorRow, PROJECT_VAR_NAME, KIDIALOG::ShowModal(), SP_ALIAS_COL, TV_FLAG_COL, TV_NAME_COL, and TV_VALUE_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 475 of file dialog_configure_paths.cpp.

476 {
477  wxASSERT((int) TV_VALUE_COL == (int) SP_PATH_COL );
478 
479  if( aEvent.GetCol() == TV_VALUE_COL )
480  {
481  wxMenu menu;
482 
483  AddMenuItem( &menu, 1, _( "File Browser..." ), KiBitmap( folder_xpm ) );
484  if( GetPopupMenuSelectionFromUser( menu ) == 1 )
485  {
486  wxDirDialog dlg( nullptr, _( "Select Path" ), m_curdir,
487  wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST );
488 
489  if( dlg.ShowModal() == wxID_OK )
490  {
491  wxGrid* grid = dynamic_cast<wxGrid*>( aEvent.GetEventObject() );
492  grid->SetCellValue( aEvent.GetRow(), TV_VALUE_COL, dlg.GetPath() );
493  m_curdir = dlg.GetPath();
494  }
495  }
496  }
497 }
const BITMAP_OPAQUE folder_xpm[1]
Definition: folder.cpp:20
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:232
wxBitmap KiBitmap(BITMAP_DEF aBitmap)
Construct a wxBitmap from a memory record, held in a BITMAP_DEF.
Definition: bitmap.cpp:80
#define _(s)
Definition: 3d_actions.cpp:33

References _, AddMenuItem(), folder_xpm, KiBitmap(), m_curdir, SP_PATH_COL, and TV_VALUE_COL.

◆ OnGridSize()

void DIALOG_CONFIGURE_PATHS::OnGridSize ( wxSizeEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 556 of file dialog_configure_paths.cpp.

557 {
558  m_gridWidthsDirty = true;
559 
560  event.Skip();
561 }

References m_gridWidthsDirty.

◆ OnHelp()

void DIALOG_CONFIGURE_PATHS::OnHelp ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 564 of file dialog_configure_paths.cpp.

565 {
566  wxString msg = _( "Enter the name and value for each environment variable. Grey entries "
567  "are names that have been defined externally at the system or user "
568  "level. Environment variables defined at the system or user level "
569  "take precedence over the ones defined in this table. This means the "
570  "values in this table are ignored." );
571  msg << "<br><br><b>";
572  msg << _( "To ensure environment variable names are valid on all platforms, the name field "
573  "will only accept upper case letters, digits, and the underscore characters." );
574  msg << "</b>";
575 
576  for( const auto& var: GetPredefinedEnvVars() )
577  {
578  msg << "<br><br><b>" << var << "</b>";
579 
580  const auto desc = LookUpEnvVarHelp( var );
581 
582  if( desc.size() > 0 )
583  msg << ": " << desc;
584 
585  }
586 
587  HTML_MESSAGE_BOX dlg( GetParent(), _( "Environment Variable Help" ) );
588  dlg.SetDialogSizeInDU( 400, 250 );
589 
590  dlg.AddHTML_Text( msg );
591  dlg.ShowModal();
592 }
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
HTML_MESSAGE_BOX.
#define _(s)
Definition: 3d_actions.cpp:33

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

◆ OnPaint()

void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 302 of file dialog_shim.cpp.

303 {
304  if( m_firstPaintEvent )
305  {
307 
308  selectAllInTextCtrls( GetChildren() );
309 
311  m_initialFocusTarget->SetFocus();
312  else
313  SetFocus(); // Focus the dialog itself
314 
315  m_firstPaintEvent = false;
316  }
317 
318  event.Skip();
319 }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:204
bool m_firstPaintEvent
Definition: dialog_shim.h:203
void FixupCancelButtonCmdKeyCollision(wxWindow *aWindow)
Definition: gtk/ui.cpp:38
static void selectAllInTextCtrls(wxWindowList &children)

References KIPLATFORM::UI::FixupCancelButtonCmdKeyCollision(), 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 388 of file dialog_configure_paths.cpp.

389 {
390  int curRow = m_EnvVars->GetGridCursorRow();
391 
392  if( curRow < 0 || m_EnvVars->GetNumberRows() <= curRow )
393  return;
394  else if( IsEnvVarImmutable( m_EnvVars->GetCellValue( curRow, TV_NAME_COL ) ) )
395  {
396  wxBell();
397  return;
398  }
399 
400  m_EnvVars->CommitPendingChanges( true /* silent mode; we don't care if it's valid */ );
401  m_EnvVars->DeleteRows( curRow, 1 );
402 
403  m_EnvVars->MakeCellVisible( std::max( 0, curRow-1 ), m_EnvVars->GetGridCursorCol() );
404  m_EnvVars->SetGridCursor( std::max( 0, curRow-1 ), m_EnvVars->GetGridCursorCol() );
405 }
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:174

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

◆ OnSearchPathMoveDown()

void DIALOG_CONFIGURE_PATHS::OnSearchPathMoveDown ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_CONFIGURE_PATHS_BASE.

Definition at line 451 of file dialog_configure_paths.cpp.

452 {
454  return;
455 
456  int curRow = m_SearchPaths->GetGridCursorRow();
457  int nextRow = curRow + 1;
458 
459  if( curRow < m_SearchPaths->GetNumberRows() - 1 )
460  {
461  for( int i = 0; i < m_SearchPaths->GetNumberCols(); ++i )
462  {
463  wxString tmp = m_SearchPaths->GetCellValue( curRow, i );
464  m_SearchPaths->SetCellValue( curRow, i, m_SearchPaths->GetCellValue( nextRow, i ) );
465  m_SearchPaths->SetCellValue( nextRow, i, tmp );
466  }
467 
468  m_SearchPaths->SetGridCursor( nextRow, m_SearchPaths->GetGridCursorCol() );
469  }
470  else
471  wxBell();
472 }
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:174

References WX_GRID::CommitPendingChanges(), 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 427 of file dialog_configure_paths.cpp.

428 {
430  return;
431 
432  int curRow = m_SearchPaths->GetGridCursorRow();
433  int prevRow = curRow - 1;
434 
435  if( curRow > 0 )
436  {
437  for( int i = 0; i < m_SearchPaths->GetNumberCols(); ++i )
438  {
439  wxString tmp = m_SearchPaths->GetCellValue( curRow, i );
440  m_SearchPaths->SetCellValue( curRow, i, m_SearchPaths->GetCellValue( prevRow, i ) );
441  m_SearchPaths->SetCellValue( prevRow, i, tmp );
442  }
443 
444  m_SearchPaths->SetGridCursor( prevRow, m_SearchPaths->GetGridCursorCol() );
445  }
446  else
447  wxBell();
448 }
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:174

References WX_GRID::CommitPendingChanges(), 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 508 of file dialog_configure_paths.cpp.

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

References DisplayErrorMessage(), DIALOG_CONFIGURE_PATHS_BASE::m_EnvVars, m_errorCol, m_errorGrid, m_errorMsg, m_errorRow, m_gridWidthsDirty, DIALOG_CONFIGURE_PATHS_BASE::m_SearchPaths, SP_ALIAS_COL, SP_DESC_COL, SP_PATH_COL, TV_NAME_COL, and TV_VALUE_COL.

◆ Prj()

PROJECT & KIWAY_HOLDER::Prj ( ) const
inherited

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

Definition at line 35 of file kiway_holder.cpp.

36 {
37  return Kiway().Prj();
38 }
KIWAY & Kiway() const
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:172

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), CVPCB_MAINFRAME::buildEquivalenceList(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDIT_FRAME::CreateScreens(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), 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_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), CVPCB_MAINFRAME::DisplayStatus(), PL_DRAW_PANEL_GAL::DisplayWorksheet(), PCB_EDIT_FRAME::doAutoSave(), FIELDS_GRID_TRICKS::doPopupSelection(), FIELDS_EDITOR_GRID_TRICKS::doPopupSelection(), KICAD_MANAGER_CONTROL::Execute(), PCB_EDIT_FRAME::Export_IDF3(), DIALOG_EXPORT_SVG::ExportSVGFile(), LIB_CONTROL::ExportSymbolAsSVG(), LIB_CONTROL::ExportView(), PCB_EDIT_FRAME::ExportVRML_File(), BACK_ANNOTATE::FetchNetlistFromPCB(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), DIALOG_GENDRILL::GenDrillAndMapFiles(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), SCH_BASE_FRAME::GetLibPart(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DISPLAY_FOOTPRINTS_FRAME::GetModule(), KICAD_MANAGER_FRAME::GetProjectFileName(), LIB_VIEW_FRAME::GetSelectedSymbol(), FP_THREAD_IFACE::GetTable(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), SCH_EDITOR_CONTROL::ImportFPAssignments(), DIALOG_CONFIG_EQUFILES::Init(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), SCH_EDIT_FRAME::KiwayMailIn(), 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::LoadProjectSettings(), PCB_EDIT_FRAME::LoadProjectSettings(), DRC::LoadRules(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_FOOTPRINT_FP_EDITOR::On3DModelCellChanged(), DIALOG_FOOTPRINT_BOARD_EDITOR::On3DModelCellChanged(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_FOOTPRINT_FP_EDITOR::OnAdd3DModel(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAdd3DModel(), KICAD_MANAGER_FRAME::OnBrowseInFileExplorer(), TEXT_BUTTON_URL::OnButtonClick(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), SCH_EDIT_FRAME::OnCloseWindow(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OnOpenCvpcb(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), DIALOG_NETLIST::OnOpenNetlistClick(), SCH_EDIT_FRAME::OnOpenPcbnew(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), DIALOG_BOM::OnRunGenerator(), FOOTPRINT_EDIT_FRAME::OnSaveFootprintAsPng(), DIALOG_ERC::OnSaveReport(), DIALOG_DRC::OnSaveReport(), PROPERTIES_FRAME::onScintillaCharAdded(), DIALOG_LABEL_EDITOR::onScintillaCharAdded(), DIALOG_SCH_EDIT_ONE_FIELD::onScintillaCharAdded(), 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(), FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), DIALOG_PLOT::Plot(), DIALOG_PLOT_SCHEMATIC::Plot_1_Page_HPGL(), DIALOG_PLOT_SCHEMATIC::PlotOneSheetDXF(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDITOR_CONTROL::Print(), SCH_EDIT_FRAME::PrintPage(), EDA_DRAW_FRAME::PrintWorkSheet(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), SCH_EDIT_TOOL::RefreshSymbolFromLibrary(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDITOR_CONTROL::RescueLegacyProject(), SCH_EDITOR_CONTROL::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(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), 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(), GERBVIEW_FRAME::SetPageSettings(), EE_INSPECTION_TOOL::ShowDatasheet(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), COMMON_CONTROL::ShowHelp(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), LIB_MANAGER::symTable(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_EDIT_FRAME::SyncLibraryTree(), EDA_3D_VIEWER::takeScreenshot(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::TransferDataFromWindow(), NETLIST_DIALOG::TransferDataFromWindow(), DIALOG_EDIT_COMPONENTS_LIBID::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataToWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataToWindow(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::UpdateFieldsFromLibrary(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), 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 244 of file dialog_shim.cpp.

245 {
246  const char* hash_key;
247 
248  if( m_hash_key.size() )
249  {
250  // a special case like EDA_LIST_DIALOG, which has multiple uses.
251  hash_key = m_hash_key.c_str();
252  }
253  else
254  {
255  hash_key = typeid(*this).name();
256  }
257 
258  RECT_MAP::iterator it = class_map.find( hash_key );
259 
260  if( it == class_map.end() )
261  return;
262 
263  EDA_RECT rect = it->second;
264  rect.SetSize( 0, 0 );
265  class_map[ hash_key ] = rect;
266 }
std::string m_hash_key
Definition: dialog_shim.h:198
static RECT_MAP class_map
void SetSize(const wxSize &size)
Definition: eda_rect.h:144
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 114 of file dialog_shim.h.

115  {
116  m_initialFocusTarget = aWindow;
117  }
wxWindow * m_initialFocusTarget
Definition: dialog_shim.h:204

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_EDIT_SHEET_PIN::DIALOG_EDIT_SHEET_PIN(), 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_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_JUNCTION_PROPS::DIALOG_JUNCTION_PROPS(), DIALOG_LABEL_EDITOR::DIALOG_LABEL_EDITOR(), DIALOG_LIB_EDIT_DRAW_ITEM::DIALOG_LIB_EDIT_DRAW_ITEM(), DIALOG_LIB_EDIT_TEXT::DIALOG_LIB_EDIT_TEXT(), DIALOG_PAD_PRIMITIVES_PROPERTIES::DIALOG_PAD_PRIMITIVES_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), DIALOG_POSITION_RELATIVE::DIALOG_POSITION_RELATIVE(), DIALOG_SCH_FIND::DIALOG_SCH_FIND(), DIALOG_TARGET_PROPERTIES::DIALOG_TARGET_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_EDIT_ONE_FIELD::init(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchAllClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchIDClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchRefClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchSelectedClicked(), DIALOG_EXCHANGE_FOOTPRINTS::OnMatchValueClicked(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), PANEL_SYM_LIB_TABLE::PANEL_SYM_LIB_TABLE(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), DIALOG_KEEPOUT_AREA_PROPERTIES::TransferDataToWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataToWindow(), and DIALOG_COPPER_ZONE::TransferDataToWindow().

◆ SetKiway()

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

Function SetKiway.

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

Definition at line 42 of file kiway_holder.cpp.

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

References KIWAY_HOLDER::m_kiway, and name.

Referenced by BM2CMP_FRAME::BM2CMP_FRAME(), PCB::IFACE::CreateWindow(), InvokePcbLibTableEditor(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), 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 158 of file dialog_shim.cpp.

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

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

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

Referenced by DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), SCH_EDIT_FRAME::OnAnnotate(), DIALOG_DRC::OnDRCItemDClick(), DIALOG_ERC::OnERCItemDClick(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnLeftDClickItem(), DIALOG_CLEANUP_GRAPHICS::OnLeftDClickItem(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), DIALOG_SHIM::ShowQuasiModal(), DIALOG_POSITION_RELATIVE::UpdateAnchor(), and SCH_EDIT_FRAME::UpdateHierarchyNavigator().

◆ ShowQuasiModal()

int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 345 of file dialog_shim.cpp.

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

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

Referenced by 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(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), SCH_EDITOR_CONTROL::RemapSymbols(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

◆ TransferDataFromWindow()

bool DIALOG_CONFIGURE_PATHS::TransferDataFromWindow ( )
override

Definition at line 212 of file dialog_configure_paths.cpp.

213 {
215  return false;
216 
217  if( !wxDialog::TransferDataFromWindow() )
218  return false;
219 
220  // Environment variables
221 
222  ENV_VAR_MAP envVarMap;
223 
224  for( int row = 0; row < m_EnvVars->GetNumberRows(); ++row )
225  {
226  wxString name = m_EnvVars->GetCellValue( row, TV_NAME_COL );
227  wxString path = m_EnvVars->GetCellValue( row, TV_VALUE_COL );
228  wxString external = m_EnvVars->GetCellValue( row, TV_FLAG_COL );
229 
230  if( external.Length() )
231  continue;
232 
233  if( name.IsEmpty() )
234  {
236  m_errorRow = row;
238  m_errorMsg = _( "Environment variable name cannot be empty." );
239  return false;
240  }
241  else if( path.IsEmpty() )
242  {
244  m_errorRow = row;
246  m_errorMsg = _( "Environment variable path cannot be empty." );
247  return false;
248  }
249 
250  envVarMap[ name ] = ENV_VAR_ITEM( path );
251  }
252 
253  Pgm().SetLocalEnvVariables( envVarMap );
254 
255  // 3D search paths
256 
257  if( m_resolver )
258  {
259  std::vector<SEARCH_PATH> alist;
260  SEARCH_PATH alias;
261 
262  for( int row = 0; row < m_SearchPaths->GetNumberRows(); ++row )
263  {
264  alias.m_alias = m_SearchPaths->GetCellValue( row, SP_ALIAS_COL );
265  alias.m_pathvar = m_SearchPaths->GetCellValue( row, SP_PATH_COL );
266  alias.m_description = m_SearchPaths->GetCellValue( row, SP_DESC_COL );
267 
268  if( alias.m_alias.IsEmpty() )
269  {
271  m_errorRow = row;
273  m_errorMsg = _( "3D search path alias cannot be empty." );
274  return false;
275  }
276  else if( alias.m_pathvar.IsEmpty() )
277  {
279  m_errorRow = row;
281  m_errorMsg = _( "3D search path cannot be empty." );
282  return false;
283  }
284 
285  alist.push_back( alias );
286  }
287 
288  if( !m_resolver->UpdatePathList( alist ) )
289  return false;
290  }
291 
292  return true;
293 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
ENV_VAR_ITEM.
Definition: pgm_base.h:88
wxString m_alias
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:117
FILENAME_RESOLVER * m_resolver
wxString m_description
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
Definition: wx_grid.cpp:174
wxString m_pathvar
const char * name
Definition: DXF_plotter.cpp:60
#define _(s)
Definition: 3d_actions.cpp:33

References _, WX_GRID::CommitPendingChanges(), 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(), SP_ALIAS_COL, SP_DESC_COL, SP_PATH_COL, TV_FLAG_COL, TV_NAME_COL, TV_VALUE_COL, and FILENAME_RESOLVER::UpdatePathList().

◆ TransferDataToWindow()

bool DIALOG_CONFIGURE_PATHS::TransferDataToWindow ( )
override

Definition at line 125 of file dialog_configure_paths.cpp.

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

References AppendEnvVar(), AppendSearchPath(), 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 172 of file dialog_shim.cpp.

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

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT().

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

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

◆ m_parentFrame

EDA_BASE_FRAME* DIALOG_SHIM::m_parentFrame
protectedinherited

Definition at line 211 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnCharHook(), and DIALOG_DRC::OnDRCItemRClick().

◆ m_qmodal_loop

WX_EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

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