KiCad PCB EDA Suite
DLG_3D_PATH_CONFIG Class Reference

#include <dlg_3d_pathconfig.h>

Inheritance diagram for DLG_3D_PATH_CONFIG:
DLG_3D_PATH_CONFIG_BASE DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

 DLG_3D_PATH_CONFIG (wxWindow *aParent, S3D_FILENAME_RESOLVER *aResolver)
 
bool TransferDataFromWindow () override
 
int ShowQuasiModal ()
 
void EndQuasiModal (int retCode)
 
bool IsQuasiModal ()
 
bool Show (bool show) override
 
bool Enable (bool enable) override
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Protected Member Functions

void FinishDialogSettings ()
 In all dialogs, we must call the same functions to fix minimal dlg size, the default position and perhaps some others to fix a few issues depending on Windows Managers this helper function does these calls. More...
 
void FixOSXCancelButtonIssue ()
 A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms. More...
 

Protected Attributes

wxGrid * m_EnvVars
 
wxButton * m_btnEnvCfg
 
wxStaticLine * m_staticline2
 
wxGrid * m_Aliases
 
wxButton * m_btnAddAlias
 
wxButton * m_btnDelAlias
 
wxButton * m_btnMoveUp
 
wxButton * m_btnMoveDown
 
wxStaticLine * m_staticline1
 
wxStdDialogButtonSizer * m_sdbSizer2
 
wxButton * m_sdbSizer2OK
 
wxButton * m_sdbSizer2Cancel
 
wxButton * m_sdbSizer2Help
 
std::string m_hash_key
 
EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 

Private Member Functions

void initDialog ()
 
void OnAddAlias (wxCommandEvent &event) override
 
void OnDelAlias (wxCommandEvent &event) override
 
void OnAliasMoveUp (wxCommandEvent &event) override
 
void OnAliasMoveDown (wxCommandEvent &event) override
 
void OnConfigEnvVar (wxCommandEvent &event) override
 
void OnHelp (wxCommandEvent &event) override
 
void updateEnvVars (void)
 

Private Attributes

S3D_FILENAME_RESOLVERm_resolver
 
wxString m_curdir
 
wxTextValidator m_aliasValidator
 

Detailed Description

Definition at line 33 of file dlg_3d_pathconfig.h.

Constructor & Destructor Documentation

DLG_3D_PATH_CONFIG::DLG_3D_PATH_CONFIG ( wxWindow *  aParent,
S3D_FILENAME_RESOLVER aResolver 
)

Definition at line 31 of file dlg_3d_pathconfig.cpp.

References initDialog().

31  :
32  DLG_3D_PATH_CONFIG_BASE( aParent ), m_resolver( aResolver )
33 {
34  initDialog();
35 
36  GetSizer()->SetSizeHints( this );
37  Centre();
38 
39  return;
40 }
DLG_3D_PATH_CONFIG_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("3D Search Path Configuration"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(619, 319), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
S3D_FILENAME_RESOLVER * m_resolver

Member Function Documentation

bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 182 of file dialog_shim.cpp.

Referenced by DIALOG_PRINT_USING_PRINTER::InitValues().

183 {
184  // so we can do logging of this state change:
185 
186 #if defined(DEBUG)
187  const char* type_id = typeid( *this ).name();
188  printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
189 #endif
190 
191  return wxDialog::Enable( enable );
192 }
void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 540 of file dialog_shim.cpp.

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

Referenced by HK_PROMPT_DIALOG::EndFlexible(), DIALOG_SHIM::OnButton(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCancelButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCancelButtonClick(), DIALOG_EDIT_ONE_FIELD::OnCancelClick(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnCloseDialog(), DIALOG_EDIT_ONE_FIELD::OnCloseDialog(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnCloseDialog(), DIALOG_CHOOSE_COMPONENT::OnCloseTimer(), DIALOG_SHIM::OnCloseWindow(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnOKButtonClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), DIALOG_EDIT_ONE_FIELD::OnOkClick(), DIALOG_EXCHANGE_MODULE::OnQuit(), DIALOG_CHOOSE_COMPONENT::OnSchViewDClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), and DIALOG_SHIM::~DIALOG_SHIM().

541 {
542  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
543  // handle validation in the same way as other dialogs.
544  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
545  return;
546 
547  SetReturnCode( retCode );
548 
549  if( !IsQuasiModal() )
550  {
551  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
552  return;
553  }
554 
555  m_qmodal_showing = false;
556 
557  if( m_qmodal_loop )
558  {
559  if( m_qmodal_loop->IsRunning() )
560  m_qmodal_loop->Exit( 0 );
561  else
562  m_qmodal_loop->ScheduleExit( 0 );
563 
564  m_qmodal_loop = NULL;
565  }
566 
569 
570  Show( false );
571 }
bool m_qmodal_showing
Definition: dialog_shim.h:132
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:131
bool IsQuasiModal()
Definition: dialog_shim.h:93
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:133
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 104 of file dialog_shim.cpp.

References PCAD2KICAD::Center.

Referenced by DIALOG_BOM::DIALOG_BOM(), DIALOG_COPPER_ZONE::DIALOG_COPPER_ZONE(), DIALOG_DESIGN_RULES::DIALOG_DESIGN_RULES(), DIALOG_DIMENSION_EDITOR::DIALOG_DIMENSION_EDITOR(), DIALOG_DISPLAY_OPTIONS::DIALOG_DISPLAY_OPTIONS(), DIALOG_DRC_CONTROL::DIALOG_DRC_CONTROL(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::DIALOG_EDIT_COMPONENT_IN_LIBRARY(), DIALOG_EESCHEMA_OPTIONS::DIALOG_EESCHEMA_OPTIONS(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FOOTPRINT_WIZARD_LIST::DIALOG_FOOTPRINT_WIZARD_LIST(), 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_LIBEDIT_OPTIONS::DIALOG_LIBEDIT_OPTIONS(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC(), DIALOG_SCH_EDIT_SHEET_PIN::DIALOG_SCH_EDIT_SHEET_PIN(), DIALOG_SCH_SHEET_PROPS::DIALOG_SCH_SHEET_PROPS(), DIALOG_SELECT_PRETTY_LIB::DIALOG_SELECT_PRETTY_LIB(), DIALOG_TRACK_VIA_SIZE::DIALOG_TRACK_VIA_SIZE(), DIALOG_EDIT_ONE_FIELD::init(), NETLIST_DIALOG::NETLIST_DIALOG(), DIALOG_LIB_EDIT_PIN::OnInitDialog(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::OnInitDialog(), DIALOG_TRACK_VIA_PROPERTIES::OnInitDlg(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnInitDlg(), DialogEditModuleText::OnInitDlg(), DIALOG_SET_GRID::OnInitDlg(), DIALOG_PCB_TEXT_PROPERTIES::OnInitDlg(), DIALOG_PRINT_FOR_MODEDIT::OnInitDlg(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_MODULE_MODULE_EDITOR::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_MODULE_BOARD_EDITOR::OnInitDlg(), DIALOG_PRINT_USING_PRINTER::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), TARGET_PROPERTIES_DIALOG_EDITOR::TARGET_PROPERTIES_DIALOG_EDITOR(), and DIALOG_SIGNAL_LIST::TransferDataToWindow().

105 {
106  // must be called from the constructor of derived classes,
107  // when all widgets are initialized, and therefore their size fixed
108 
109  // SetSizeHints fixes the minimal size of sizers in the dialog
110  // (SetSizeHints calls Fit(), so no need to call it)
111  GetSizer()->SetSizeHints( this );
112 
113  // the default position, when calling the first time the dlg
114  Center();
115 }
void DIALOG_SHIM::FixOSXCancelButtonIssue ( )
protectedinherited

A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms.

Definition at line 117 of file dialog_shim.cpp.

Referenced by DIALOG_SHIM::Show().

118 {
119 #ifdef __WXMAC__
120  // A ugly hack to fix an issue on OSX: ctrl+c closes the dialog instead of
121  // copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer
122  // created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority
123  // to copy text standard accelerator, and the dlg is closed when trying to copy text
124  wxButton* button = dynamic_cast< wxButton* > ( wxWindow::FindWindowById( wxID_CANCEL, this ) );
125 
126  if( button )
127  button->SetLabel( _( "Cancel" ) );
128 #endif
129 }
void DLG_3D_PATH_CONFIG::initDialog ( )
private

Definition at line 43 of file dlg_3d_pathconfig.cpp.

References S3D_FILENAME_RESOLVER::GetPaths(), DLG_3D_PATH_CONFIG_BASE::m_Aliases, m_aliasValidator, m_curdir, DLG_3D_PATH_CONFIG_BASE::m_EnvVars, m_resolver, and updateEnvVars().

Referenced by DLG_3D_PATH_CONFIG().

44 {
45  m_Aliases->EnableEditing( true );
46 
47  // Gives a min width to each column, when the user drags a column
48  m_Aliases->SetColMinimalWidth( 0, 80 );
49  m_Aliases->SetColMinimalWidth( 1, 300 );
50  m_Aliases->SetColMinimalWidth( 2, 120 );
51  m_Aliases->SetColMinimalAcceptableWidth( 80 );
52 
53  // Set column sizes to this min value
54  m_Aliases->SetColSize( 0, 80 );
55  m_Aliases->SetColSize( 1, 300 );
56  m_Aliases->SetColSize( 2, 120 );
57 
58  m_EnvVars->SetColMinimalWidth( 0, 80 );
59  m_EnvVars->SetColMinimalWidth( 1, 300 );
60  m_EnvVars->SetColMinimalAcceptableWidth( 80 );
61  m_EnvVars->SetColSize( 0, 80 );
62  m_EnvVars->SetColSize( 1, 300 );
63 
64  if( m_resolver )
65  {
66  updateEnvVars();
67 
68  // prohibit these characters in the alias names: []{}()%~<>"='`;:.,&?/\|$
69  m_aliasValidator.SetStyle( wxFILTER_EXCLUDE_CHAR_LIST );
70  m_aliasValidator.SetCharExcludes( wxT( "{}[]()%~<>\"='`;:.,&?/\\|$" ) );
71 
72  const std::list< S3D_ALIAS >* rpaths = m_resolver->GetPaths();
73  std::list< S3D_ALIAS >::const_iterator rI = rpaths->begin();
74  std::list< S3D_ALIAS >::const_iterator rE = rpaths->end();
75  size_t listsize = rpaths->size();
76  size_t listidx = 0;
77 
78  while( rI != rE && ( (*rI).m_alias.StartsWith( "${" )
79  || (*rI).m_alias.StartsWith( "$(" ) ) )
80  {
81  ++listidx;
82  ++rI;
83  }
84 
85  if( listidx < listsize )
86  m_curdir = (*rI).m_pathexp;
87  else
88  return;
89 
90  listsize = listsize - listidx - m_Aliases->GetNumberRows();
91 
92  // note: if the list allocation fails we have bigger problems
93  // and there is no point in trying to notify the user here
94  if( listsize > 0 && !m_Aliases->InsertRows( 0, listsize ) )
95  return;
96 
97  int nitems = 0;
98  wxGridCellTextEditor* pEdAlias;
99 
100  while( rI != rE )
101  {
102  m_Aliases->SetCellValue( nitems, 0, rI->m_alias );
103 
104  if( 0 == nitems )
105  {
106  m_Aliases->SetCellEditor( nitems, 0, new wxGridCellTextEditor );
107  pEdAlias = (wxGridCellTextEditor*) m_Aliases->GetCellEditor( nitems, 0 );
108  pEdAlias->SetValidator( m_aliasValidator );
109  pEdAlias->DecRef();
110  }
111  else
112  {
113  pEdAlias->IncRef();
114  m_Aliases->SetCellEditor( nitems, 0, pEdAlias );
115  }
116 
117  m_Aliases->SetCellValue( nitems, 1, rI->m_pathvar );
118  m_Aliases->SetCellValue( nitems++, 2, rI->m_description );
119 
120  // TODO: implement a wxGridCellEditor which invokes a wxDirDialog
121 
122  ++rI;
123  }
124 
125  m_Aliases->AutoSize();
126  }
127 }
wxTextValidator m_aliasValidator
const std::list< S3D_ALIAS > * GetPaths(void)
Function GetPaths returns a pointer to the internal path list; the items in:load. ...
S3D_FILENAME_RESOLVER * m_resolver
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 60 of file kiway_player.h.

References KIWAY_HOLDER::m_kiway.

Referenced by SCH_EDIT_FRAME::AppendOneEEProject(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_CHOOSE_COMPONENT::ConstructRightPanel(), CVPCB_MAINFRAME::CreateScreenCmp(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_SHIM::DIALOG_SHIM(), EDIT_TOOL::editFootprintInFpEditor(), SCH_EDIT_FRAME::EditSheet(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), LIB_EDIT_FRAME::InstallConfigFrame(), PCB_EDIT_FRAME::InstallModuleOptionsFrame(), KIWAY_PLAYER::language_change(), SCH_SHEET::Load(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), SCH_EDIT_FRAME::OnLeftClick(), SCH_BASE_FRAME::OnOpenLibraryViewer(), SCH_EDIT_FRAME::OnSimulate(), DIALOG_EDIT_ONE_FIELD::OnTextValueSelectButtonClick(), FOOTPRINT_EDIT_FRAME::OnUpdateInsertModuleInBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadModuleFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateReplaceModuleInBoard(), SCH_EDIT_FRAME::OpenProjectFiles(), KIWAY_HOLDER::Prj(), PCB_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), PCB_EDIT_FRAME::SendMessageToEESCHEMA(), SCH_EDIT_FRAME::SendMessageToPCBNEW(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_EDIT_FRAME::SetPlotSettings(), DISPLAY_FOOTPRINTS_FRAME::Show3D_Frame(), FOOTPRINT_VIEWER_FRAME::Show3D_Frame(), FOOTPRINT_EDIT_FRAME::Show3D_Frame(), FOOTPRINT_WIZARD_FRAME::Show3D_Frame(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::showButtonHandler(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::showButtonHandler(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), and DIALOG_EXCHANGE_MODULE::ViewAndSelectFootprint().

61  {
62  wxASSERT( m_kiway ); // smoke out bugs in Debug build, then Release runs fine.
63  return *m_kiway;
64  }
KIWAY * m_kiway
Definition: kiway_player.h:85
void DLG_3D_PATH_CONFIG::OnAddAlias ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DLG_3D_PATH_CONFIG_BASE.

Definition at line 168 of file dlg_3d_pathconfig.cpp.

References DLG_3D_PATH_CONFIG_BASE::m_Aliases.

169 {
170  int ni = m_Aliases->GetNumberRows();
171 
172  if( m_Aliases->InsertRows( ni, 1 ) )
173  {
174  wxGridCellTextEditor* pEdAlias;
175  pEdAlias = (wxGridCellTextEditor*) m_Aliases->GetCellEditor( 0, 0 );
176  m_Aliases->SetCellEditor( ni, 0, pEdAlias );
177  m_Aliases->SelectRow( ni, false );
178  m_Aliases->AutoSize();
179  Fit();
180 
181  // TODO: set the editors on any newly created rows
182  }
183 
184  event.Skip();
185 }
void DLG_3D_PATH_CONFIG::OnAliasMoveDown ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DLG_3D_PATH_CONFIG_BASE.

Definition at line 269 of file dlg_3d_pathconfig.cpp.

References S3D_ALIAS::m_alias, DLG_3D_PATH_CONFIG_BASE::m_Aliases, S3D_ALIAS::m_description, and S3D_ALIAS::m_pathvar.

270 {
271  wxArrayInt sel = m_Aliases->GetSelectedRows();
272 
273  if( sel.empty() )
274  {
275  wxMessageBox( _( "No entry selected" ), _( "Move alias down" ) );
276  return;
277  }
278 
279  if( sel.size() > 1 )
280  {
281  wxMessageBox( _( "Multiple entries selected; please\nselect only one entry" ),
282  _( "Move alias down" ) );
283  return;
284  }
285 
286  int ni = m_Aliases->GetNumberRows() - 1;
287  int ci = sel.front();
288 
289  if( ci < ni )
290  {
291  S3D_ALIAS al0;
292  al0.m_alias = m_Aliases->GetCellValue( ci, 0 );
293  al0.m_pathvar = m_Aliases->GetCellValue( ci, 1 );
294  al0.m_description = m_Aliases->GetCellValue( ci, 2 );
295 
296  ni = ci + 1;
297  m_Aliases->SetCellValue( ci, 0, m_Aliases->GetCellValue( ni, 0 ) );
298  m_Aliases->SetCellValue( ci, 1, m_Aliases->GetCellValue( ni, 1 ) );
299  m_Aliases->SetCellValue( ci, 2, m_Aliases->GetCellValue( ni, 2 ) );
300 
301  m_Aliases->SetCellValue( ni, 0, al0.m_alias );
302  m_Aliases->SetCellValue( ni, 1, al0.m_pathvar );
303  m_Aliases->SetCellValue( ni, 2, al0.m_description );
304  m_Aliases->SelectRow( ni, false );
305  }
306 
307  event.Skip();
308 }
wxString m_pathvar
wxString m_description
void DLG_3D_PATH_CONFIG::OnAliasMoveUp ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DLG_3D_PATH_CONFIG_BASE.

Definition at line 228 of file dlg_3d_pathconfig.cpp.

References S3D_ALIAS::m_alias, DLG_3D_PATH_CONFIG_BASE::m_Aliases, S3D_ALIAS::m_description, and S3D_ALIAS::m_pathvar.

229 {
230  wxArrayInt sel = m_Aliases->GetSelectedRows();
231 
232  if( sel.empty() )
233  {
234  wxMessageBox( _( "No entry selected" ), _( "Move alias up" ) );
235  return;
236  }
237 
238  if( sel.size() > 1 )
239  {
240  wxMessageBox( _( "Multiple entries selected; please\nselect only one entry" ),
241  _( "Move alias up" ) );
242  return;
243  }
244 
245  int ci = sel.front();
246 
247  if( ci > 0 )
248  {
249  S3D_ALIAS al0;
250  al0.m_alias = m_Aliases->GetCellValue( ci, 0 );
251  al0.m_pathvar = m_Aliases->GetCellValue( ci, 1 );
252  al0.m_description = m_Aliases->GetCellValue( ci, 2 );
253 
254  int ni = ci - 1;
255  m_Aliases->SetCellValue( ci, 0, m_Aliases->GetCellValue( ni, 0 ) );
256  m_Aliases->SetCellValue( ci, 1, m_Aliases->GetCellValue( ni, 1 ) );
257  m_Aliases->SetCellValue( ci, 2, m_Aliases->GetCellValue( ni, 2 ) );
258 
259  m_Aliases->SetCellValue( ni, 0, al0.m_alias );
260  m_Aliases->SetCellValue( ni, 1, al0.m_pathvar );
261  m_Aliases->SetCellValue( ni, 2, al0.m_description );
262  m_Aliases->SelectRow( ni, false );
263  }
264 
265  event.Skip();
266 }
wxString m_pathvar
wxString m_description
void DLG_3D_PATH_CONFIG::OnConfigEnvVar ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DLG_3D_PATH_CONFIG_BASE.

Definition at line 311 of file dlg_3d_pathconfig.cpp.

References PGM_BASE::ConfigurePaths(), Pgm(), and updateEnvVars().

312 {
313  Pgm().ConfigurePaths( this );
314  updateEnvVars();
315  event.Skip();
316 }
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
VTBL_ENTRY void ConfigurePaths(wxWindow *aParent=NULL)
Function ConfigurePaths.
Definition: pgm_base.cpp:897
void DLG_3D_PATH_CONFIG::OnDelAlias ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DLG_3D_PATH_CONFIG_BASE.

Definition at line 188 of file dlg_3d_pathconfig.cpp.

References DLG_3D_PATH_CONFIG_BASE::m_Aliases.

189 {
190  wxArrayInt sel = m_Aliases->GetSelectedRows();
191 
192  if( sel.empty() )
193  {
194  wxMessageBox( _( "No entry selected" ), _( "Delete alias entry" ) );
195  return;
196  }
197 
198  if( sel.size() > 1 )
199  {
200  wxMessageBox( _( "Multiple entries selected; please\nselect only one entry" ),
201  _( "Delete alias entry" ) );
202  return;
203  }
204 
205  if( m_Aliases->GetNumberRows() > 1 )
206  {
207  int ni = sel.front();
208  m_Aliases->DeleteRows( ni, 1 );
209 
210  if( ni >= m_Aliases->GetNumberRows() )
211  ni = m_Aliases->GetNumberRows() - 1;
212 
213  m_Aliases->SelectRow( ni, false );
214  m_Aliases->AutoSize();
215  Fit();
216  }
217  else
218  {
219  m_Aliases->SetCellValue( 0, 0, wxEmptyString );
220  m_Aliases->SetCellValue( 0, 1, wxEmptyString );
221  m_Aliases->SetCellValue( 0, 2, wxEmptyString );
222  }
223 
224  event.Skip();
225 }
void DLG_3D_PATH_CONFIG::OnHelp ( wxCommandEvent &  event)
overrideprivatevirtual

Reimplemented from DLG_3D_PATH_CONFIG_BASE.

Definition at line 369 of file dlg_3d_pathconfig.cpp.

References HTML_MESSAGE_BOX::AddHTML_Text().

370 {
371  wxString msg = _( "Enter the name and path for each 3D alias variable.<br>KiCad "
372  "environment variables and their values are shown for "
373  "reference only and cannot be edited." );
374  msg << "<br><br><b>";
375  msg << _( "Alias names may not contain any of the characters " );
376  msg << "{}[]()%~<>\"='`;:.,&?/\\|$";
377  msg << "</b>";
378 
379  HTML_MESSAGE_BOX dlg( GetParent(), _( "Environment Variable Help" ) );
380  dlg.AddHTML_Text( msg );
381  dlg.ShowModal();
382 
383  event.Skip();
384 }
Class HTML_MESSAGE_BOX.
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.

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

Referenced by SCH_EDIT_FRAME::AnnotateComponents(), SCH_EDIT_FRAME::AppendOneEEProject(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), SCH_EDIT_FRAME::backAnnotateFootprints(), LIB_VIEW_FRAME::BestZoom(), DIALOG_MODULE_MODULE_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_MODULE_BOARD_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::BrowseAndSelectDocFile(), DIALOG_EXCHANGE_MODULE::BrowseAndSelectFootprint(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_MODULE_MODULE_EDITOR::Cfg3DPath(), DIALOG_MODULE_BOARD_EDITOR::Cfg3DPath(), SCH_EDIT_FRAME::CheckAnnotate(), SCH_SCREEN::CheckComponentsToPartsLinks(), SCH_EDIT_FRAME::ConvertPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), SCH_EDIT_FRAME::CreateArchiveLibrary(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), LIB_EDIT_FRAME::DeleteOnePart(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), DIALOG_EESCHEMA_CONFIG::DIALOG_EESCHEMA_CONFIG(), DIALOG_FP_LIB_TABLE::DIALOG_FP_LIB_TABLE(), DIALOG_MODULE_BOARD_EDITOR::DIALOG_MODULE_BOARD_EDITOR(), DIALOG_MODULE_MODULE_EDITOR::DIALOG_MODULE_MODULE_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SCH_EDIT_ONE_FIELD::DIALOG_SCH_EDIT_ONE_FIELD(), LIB_VIEW_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_MODULE_MODULE_EDITOR::Edit3DShapeFileName(), DIALOG_MODULE_BOARD_EDITOR::Edit3DShapeFileName(), SCH_EDIT_FRAME::EditComponentFieldText(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportToGenCAD(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), LIB_EDIT_FRAME::GetCurPart(), FOOTPRINT_EDIT_FRAME::GetCurrentLib(), FOOTPRINT_EDIT_FRAME::getLibPath(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DIALOG_BOM::getPluginFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::InitBuffers(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), LIB_EDIT_FRAME::InstallConfigFrame(), SCH_EDIT_FRAME::InstallConfigFrame(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), DIALOG_BOM_EDITOR::LoadComponents(), CVPCB_MAINFRAME::LoadFootprintFiles(), SCH_EDIT_FRAME::LoadOneEEFile(), LIB_EDIT_FRAME::LoadOneLibraryPart(), LIB_EDIT_FRAME::LoadOneSymbol(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_EESCHEMA_CONFIG::OnAddOrInsertLibClick(), DIALOG_EESCHEMA_CONFIG::OnAddOrInsertPath(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), LIB_EDIT_FRAME::OnCloseWindow(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), DIALOG_GENDRILL::OnGenReportFile(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), PCB_EDIT_FRAME::OnLeftClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnOKButtonClick(), DIALOG_NETLIST::OnOpenNetlistClick(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_SVG_PRINT::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_MODULE_POSITION::OnOutputDirectoryBrowseClicked(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRightClick(), DIALOG_BOM::OnRunPlugin(), DIALOG_NETLIST::OnSaveMessagesToFile(), SCH_EDIT_FRAME::OnSaveProject(), DIALOG_SPICE_MODEL::onSelectIcLib(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OnSelectUnit(), DIALOG_SPICE_MODEL::onSemiSelectLib(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnTestChipName(), FOOTPRINT_EDIT_FRAME::OnUpdateSelectCurrentLib(), LIB_EDIT_FRAME::OnViewEntryDoc(), LIB_VIEW_FRAME::onViewSymbolDocument(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::PasteListOfItems(), PCB_EDITOR_CONTROL::PlaceModule(), SCH_EDIT_FRAME::prepareForNetlist(), SCH_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), SCH_EDIT_FRAME::Process_Special_Functions(), SCH_EDIT_FRAME::ProcessCmpToFootprintLinkFile(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), FOOTPRINT_VIEWER_FRAME::ReCreateFootprintList(), LIB_VIEW_FRAME::ReCreateHToolbar(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), LIB_VIEW_FRAME::ReCreateListCmp(), LIB_VIEW_FRAME::ReCreateListLib(), LIB_VIEW_FRAME::RedrawActiveWindow(), EDA_3D_VIEWER::ReloadRequest(), DIALOG_SYMBOL_REMAP::remapSymbolToLibTable(), SCH_EDIT_FRAME::RescueProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_SCREEN::Save(), LIB_EDIT_FRAME::SaveActiveLibrary(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibrary(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), EDA_3D_VIEWER::takeScreenshot(), DIALOG_ERC::TestErc(), DIALOG_SPICE_MODEL::updateFromFile(), SIM_PLOT_FRAME::updateNetlistExporter(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), CVPCB_MAINFRAME::UpdateTitle(), FOOTPRINT_EDIT_FRAME::updateTitle(), SCH_EDIT_FRAME::WriteNetListFile(), DIALOG_MODULE_BOARD_EDITOR::~DIALOG_MODULE_BOARD_EDITOR(), and DIALOG_MODULE_MODULE_EDITOR::~DIALOG_MODULE_MODULE_EDITOR().

35 {
36  return Kiway().Prj();
37 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_player.h:60
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:144
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.

References KIWAY_HOLDER::m_kiway, and name.

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

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_player.h:85
const char * name
bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 139 of file dialog_shim.cpp.

References class_map, DIALOG_SHIM::FixOSXCancelButtonIssue(), EDA_RECT::GetPosition(), EDA_RECT::GetSize(), DIALOG_SHIM::m_hash_key, wxPoint::x, and wxPoint::y.

Referenced by DisplayHotkeyList(), DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), DIALOG_ANNOTATE::OnApplyClick(), DIALOG_SCH_FIND::OnCancel(), DIALOG_ANNOTATE::OnCancelClick(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnPopupMenu(), DIALOG_EXCHANGE_MODULE::OnQuit(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), DRC::ShowDRCDialog(), and DIALOG_SHIM::ShowQuasiModal().

140 {
141  bool ret;
142  const char* hash_key;
143 
144  if( m_hash_key.size() )
145  {
146  // a special case like EDA_LIST_DIALOG, which has multiple uses.
147  hash_key = m_hash_key.c_str();
148  }
149  else
150  {
151  hash_key = typeid(*this).name();
152  }
153 
154  // Show or hide the window. If hiding, save current position and size.
155  // If showing, use previous position and size.
156  if( show )
157  {
158  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
159  ret = wxDialog::Show( show );
160 
161  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
162  EDA_RECT r = class_map[ hash_key ];
163 
164  if( r.GetSize().x != 0 && r.GetSize().y != 0 )
165  SetSize( r.GetPosition().x, r.GetPosition().y, r.GetSize().x, r.GetSize().y, 0 );
166  }
167  else
168  {
169  // Save the dialog's position & size before hiding, using classname as key
170  EDA_RECT r( wxDialog::GetPosition(), wxDialog::GetSize() );
171  class_map[ hash_key ] = r;
172 
173  ret = wxDialog::Show( show );
174  }
175 
177 
178  return ret;
179 }
std::string m_hash_key
Definition: dialog_shim.h:128
void FixOSXCancelButtonIssue()
A ugly hack to fix an issue on OSX: when typing ctrl+c in a wxTextCtrl inside a dialog, it is closed instead of copying a text if a button with wxID_CANCEL is used in a wxStdDialogButtonSizer, when the dlg is created by wxFormBuilder: the label is &Cancel, and this accelerator key has priority to copy text standard accelerator, and the dlg is closed when trying to copy text this function do nothing on other platforms.
static RECT_MAP class_map
const wxPoint & GetPosition() const
Class EDA_RECT handles the component boundary box.
const wxSize & GetSize() const
int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 495 of file dialog_shim.cpp.

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

Referenced by LIB_EDIT_FRAME::DeleteOnePart(), SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), LIB_EDIT_FRAME::InstallFieldsEditorDialog(), InvokeDialogCreateBOMEditor(), LIB_VIEW_FRAME::OnSelectSymbol(), and SCH_BASE_FRAME::SelectComponentFromLibrary().

496 {
497  // This is an exception safe way to zero a pointer before returning.
498  // Yes, even though DismissModal() clears this first normally, this is
499  // here in case there's an exception before the dialog is dismissed.
500  struct NULLER
501  {
502  void*& m_what;
503  NULLER( void*& aPtr ) : m_what( aPtr ) {}
504  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
505  } clear_this( (void*&) m_qmodal_loop );
506 
507  // release the mouse if it's currently captured as the window having it
508  // will be disabled when this dialog is shown -- but will still keep the
509  // capture making it impossible to do anything in the modal dialog itself
510  wxWindow* win = wxWindow::GetCapture();
511  if( win )
512  win->ReleaseMouse();
513 
514  // Get the optimal parent
515  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
516 
517  // Show the optimal parent
518  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
519 
520  wxASSERT_MSG( !m_qmodal_parent_disabler,
521  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
522 
523  // quasi-modal: disable only my "optimal" parent
525 
526  Show( true );
527 
528  m_qmodal_showing = true;
529 
530  EVENT_LOOP event_loop;
531 
532  m_qmodal_loop = &event_loop;
533 
534  event_loop.Run();
535 
536  return GetReturnCode();
537 }
bool m_qmodal_showing
Definition: dialog_shim.h:132
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:131
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:133
Toggle a window's "enable" status to disabled, then enabled on destruction.
Definition: dialog_shim.cpp:33
#define DBG(x)
Definition: fctsys.h:33
bool DLG_3D_PATH_CONFIG::TransferDataFromWindow ( )
override

Definition at line 130 of file dlg_3d_pathconfig.cpp.

References S3D_ALIAS::m_alias, DLG_3D_PATH_CONFIG_BASE::m_Aliases, S3D_ALIAS::m_description, S3D_ALIAS::m_pathvar, m_resolver, and S3D_FILENAME_RESOLVER::UpdatePathList().

131 {
132  if( NULL == m_resolver )
133  {
134  wxMessageBox( _( "[BUG] No valid resolver; data will not be updated" ),
135  _( "Update 3D search path list" ) );
136 
137  return false;
138  }
139 
140  std::vector<S3D_ALIAS> alist;
141  S3D_ALIAS alias;
142 
143  int ni = m_Aliases->GetNumberRows();
144 
145  if( ni <= 0 )
146  {
147  // note: UI usability: we should ask a user if they're sure they
148  // want to clear the entire path list
149  m_resolver->UpdatePathList( alist );
150  return true;
151  }
152 
153  for( int i = 0; i < ni; ++i )
154  {
155  alias.m_alias = m_Aliases->GetCellValue( i, 0 );
156  alias.m_pathvar = m_Aliases->GetCellValue( i, 1 );
157  alias.m_description = m_Aliases->GetCellValue( i, 2 );
158 
159  if( !alias.m_alias.empty() && !alias.m_pathvar.empty() )
160  alist.push_back( alias );
161 
162  }
163 
164  return m_resolver->UpdatePathList( alist );
165 }
wxString m_pathvar
wxString m_description
bool UpdatePathList(std::vector< S3D_ALIAS > &aPathList)
Function UpdatePathList clears the current path list and substitutes the given path list...
S3D_FILENAME_RESOLVER * m_resolver
void DLG_3D_PATH_CONFIG::updateEnvVars ( void  )
private

Definition at line 319 of file dlg_3d_pathconfig.cpp.

References ExpandEnvVarSubstitutions(), S3D_FILENAME_RESOLVER::GetKicadPaths(), DLG_3D_PATH_CONFIG_BASE::m_EnvVars, and m_resolver.

Referenced by initDialog(), and OnConfigEnvVar().

320 {
321  if( !m_resolver )
322  return;
323 
324  std::list< wxString > epaths;
325 
326  m_resolver->GetKicadPaths( epaths );
327  size_t nitems = epaths.size();
328  size_t nrows = m_EnvVars->GetNumberRows();
329  bool resize = nrows != nitems; // true after adding/removing env vars
330 
331  if( nrows > nitems )
332  {
333  size_t ni = nrows - nitems;
334  m_EnvVars->DeleteRows( 0, ni );
335  }
336  else if( nrows < nitems )
337  {
338  size_t ni = nitems - nrows;
339  m_EnvVars->InsertRows( 0, ni );
340  }
341 
342  int j = 0;
343 
344  for( auto i : epaths )
345  {
346  wxString val = ExpandEnvVarSubstitutions( i );
347  m_EnvVars->SetCellValue( j, 0, i );
348  m_EnvVars->SetCellValue( j, 1, val );
349  m_EnvVars->SetReadOnly( j, 0, true );
350  m_EnvVars->SetReadOnly( j, 1, true );
351  wxGridCellAttr* ap = m_EnvVars->GetOrCreateCellAttr( j, 0 );
352  ap->SetReadOnly( true );
353  ap->SetBackgroundColour( *wxLIGHT_GREY );
354  m_EnvVars->SetRowAttr( j, ap );
355  ++j;
356  }
357 
358  m_EnvVars->AutoSize();
359 
360  // Resizing the full dialog is sometimes needed for a clean display
361  // i.e. when adding/removing Kicad environment variables
362  if( resize )
363  GetSizer()->SetSizeHints( this );
364 
365  return;
366 }
const wxString ExpandEnvVarSubstitutions(const wxString &aString)
Function ExpandEnvVarSubstitutions replaces any environment variable references with their values...
Definition: common.cpp:254
S3D_FILENAME_RESOLVER * m_resolver
bool GetKicadPaths(std::list< wxString > &paths)
Function GetKicadPaths returns a list of path environment variables local to Kicad; this list always ...

Member Data Documentation

wxGrid* DLG_3D_PATH_CONFIG_BASE::m_Aliases
protectedinherited
wxTextValidator DLG_3D_PATH_CONFIG::m_aliasValidator
private

Definition at line 38 of file dlg_3d_pathconfig.h.

Referenced by initDialog().

wxButton* DLG_3D_PATH_CONFIG_BASE::m_btnAddAlias
protectedinherited
wxButton* DLG_3D_PATH_CONFIG_BASE::m_btnDelAlias
protectedinherited
wxButton* DLG_3D_PATH_CONFIG_BASE::m_btnEnvCfg
protectedinherited
wxButton* DLG_3D_PATH_CONFIG_BASE::m_btnMoveDown
protectedinherited
wxButton* DLG_3D_PATH_CONFIG_BASE::m_btnMoveUp
protectedinherited
wxString DLG_3D_PATH_CONFIG::m_curdir
private

Definition at line 37 of file dlg_3d_pathconfig.h.

Referenced by initDialog().

wxGrid* DLG_3D_PATH_CONFIG_BASE::m_EnvVars
protectedinherited
std::string DIALOG_SHIM::m_hash_key
protectedinherited
EVENT_LOOP* DIALOG_SHIM::m_qmodal_loop
protectedinherited

Definition at line 131 of file dialog_shim.h.

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

WDO_ENABLE_DISABLE* DIALOG_SHIM::m_qmodal_parent_disabler
protectedinherited
bool DIALOG_SHIM::m_qmodal_showing
protectedinherited
S3D_FILENAME_RESOLVER* DLG_3D_PATH_CONFIG::m_resolver
private

Definition at line 36 of file dlg_3d_pathconfig.h.

Referenced by initDialog(), TransferDataFromWindow(), and updateEnvVars().

wxStdDialogButtonSizer* DLG_3D_PATH_CONFIG_BASE::m_sdbSizer2
protectedinherited
wxButton* DLG_3D_PATH_CONFIG_BASE::m_sdbSizer2Cancel
protectedinherited
wxButton* DLG_3D_PATH_CONFIG_BASE::m_sdbSizer2Help
protectedinherited
wxButton* DLG_3D_PATH_CONFIG_BASE::m_sdbSizer2OK
protectedinherited
wxStaticLine* DLG_3D_PATH_CONFIG_BASE::m_staticline1
protectedinherited
wxStaticLine* DLG_3D_PATH_CONFIG_BASE::m_staticline2
protectedinherited

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