KiCad PCB EDA Suite
DIALOG_ENV_VAR_CONFIG Class Reference

DIALOG_ENV_VAR_CONFIG class declaration. More...

#include <dialog_env_var_config.h>

Inheritance diagram for DIALOG_ENV_VAR_CONFIG:
DIALOG_ENV_VAR_CONFIG_BASE DIALOG_SHIM KIWAY_HOLDER

Public Member Functions

 DIALOG_ENV_VAR_CONFIG (wxWindow *parent, const ENV_VAR_MAP &aEnvVarMap)
 
virtual ~DIALOG_ENV_VAR_CONFIG ()
 
bool TransferDataToWindow () override
 
bool TransferDataFromWindow () override
 
bool ExternalDefsChanged () const
 
const ENV_VAR_MAPGetEnvVarMap () const
 
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 PopulatePathList ()
 Update the displayed list of ENV_VAR paths. More...
 
void EditSelectedEntry ()
 Edit the currently selected ENV_VAR entry. More...
 
virtual void OnAddButton (wxCommandEvent &event) override
 
virtual void OnEditButton (wxCommandEvent &event) override
 
virtual void OnRemoveButton (wxCommandEvent &event) override
 
virtual void OnHelpButton (wxCommandEvent &event) override
 
virtual void OnPathSelected (wxListEvent &event) override
 
virtual void OnPathActivated (wxListEvent &event) override
 
bool GetPathAtIndex (unsigned int aIndex, wxString &aEnvVar, wxString &aEnvPath)
 Extract the NAME and PATH data from the ENV_VAR at the provided index. More...
 
bool IsEnvVarImmutable (const wxString aEnvVar)
 Determine if a particular ENV_VAR is protected. More...
 
void SelectListIndex (unsigned int aIndex)
 Select the ENV_VAR at the provided index. More...
 
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

unsigned int m_pathIndex = 0
 
wxListCtrl * m_pathList
 
wxButton * m_addPathButton
 
wxButton * m_editPathButton
 
wxButton * m_deletePathButton
 
wxStaticLine * m_staticline1
 
wxStdDialogButtonSizer * m_sdbSizer
 
wxButton * m_sdbSizerOK
 
wxButton * m_sdbSizerCancel
 
wxButton * m_sdbSizerHelp
 
std::string m_hash_key
 
EVENT_LOOPm_qmodal_loop
 
bool m_qmodal_showing
 
WDO_ENABLE_DISABLEm_qmodal_parent_disabler
 

Private Attributes

ENV_VAR_MAP m_envVarMap
 
bool m_extDefsChanged = false
 

Detailed Description

DIALOG_ENV_VAR_CONFIG class declaration.

Definition at line 39 of file dialog_env_var_config.h.

Constructor & Destructor Documentation

DIALOG_ENV_VAR_CONFIG::DIALOG_ENV_VAR_CONFIG ( wxWindow *  parent,
const ENV_VAR_MAP aEnvVarMap 
)

Definition at line 72 of file dialog_env_var_config.cpp.

References m_envVarMap.

72  :
74 {
75  // Copy environment variables across
76  m_envVarMap = aEnvVarMap;
77 }
DIALOG_ENV_VAR_CONFIG_BASE(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=_("Path Configuration"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(582, 283), long style=wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
virtual DIALOG_ENV_VAR_CONFIG::~DIALOG_ENV_VAR_CONFIG ( )
inlinevirtual

Definition at line 89 of file dialog_env_var_config.h.

89 {}

Member Function Documentation

void DIALOG_ENV_VAR_CONFIG::EditSelectedEntry ( )
protected

Edit the currently selected ENV_VAR entry.

Definition at line 216 of file dialog_env_var_config.cpp.

References DisplayErrorMessage(), Format(), GetPathAtIndex(), IsEnvVarImmutable(), m_envVarMap, m_extDefsChanged, m_pathIndex, and PopulatePathList().

Referenced by OnEditButton(), and OnPathActivated().

217 {
218  wxString envName;
219  wxString envPath;
220 
221  if( GetPathAtIndex( m_pathIndex, envName, envPath ) )
222  {
223  auto dlg = new DIALOG_ENV_VAR_SINGLE( nullptr, envName, envPath );
224 
225  if( IsEnvVarImmutable( envName ) )
226  {
227  dlg->SetEnvVarProtected();
228  }
229 
230  if( dlg->ShowModal() == wxID_OK )
231  {
232  wxString newName = dlg->GetEnvVarName();
233  wxString newPath = dlg->GetEnvVarValue();
234 
235  // If the path name has not been changed
236  if( envName.Cmp( newName ) == 0 )
237  {
238  m_envVarMap[envName].SetValue( newPath );
239 
240  if( m_envVarMap[envName].GetDefinedExternally() )
241  {
242  m_extDefsChanged = true;
243  }
244  }
245  // Path-name needs to be updated
246  else
247  {
248  if( IsEnvVarImmutable( envName ) )
249  {
250  DisplayErrorMessage( this,
251  wxString::Format( _( "Environment variable '%s' cannot be renamed" ),
252  envName.ToStdString() ),
253  _( "The selected environment variable name "
254  "is required for KiCad functionality and "
255  "can not be renamed." ) );
256 
257  return;
258  }
259 
260  auto envVar = m_envVarMap[envName];
261 
262  m_envVarMap.erase( envName );
263 
264  envVar.SetValue( newPath );
265  envVar.SetDefinedExternally( false );
266  m_envVarMap[newName] = envVar;
267  }
268 
269  // Update the path list
271  }
272 
273  dlg->Destroy();
274  }
275 }
bool GetPathAtIndex(unsigned int aIndex, wxString &aEnvVar, wxString &aEnvPath)
Extract the NAME and PATH data from the ENV_VAR at the provided index.
void PopulatePathList()
Update the displayed list of ENV_VAR paths.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString aExtraInfo)
Function DisplayErrorMessage displays an error message with aMessage.
Definition: confirm.cpp:87
bool IsEnvVarImmutable(const wxString aEnvVar)
Determine if a particular ENV_VAR is protected.
A helper dialog to edit a env var name and/or its value (often a path)
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
bool DIALOG_SHIM::Enable ( bool  enable)
overrideinherited

Definition at line 184 of file dialog_shim.cpp.

Referenced by DIALOG_PRINT_USING_PRINTER::InitValues().

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

Definition at line 542 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().

543 {
544  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
545  // handle validation in the same way as other dialogs.
546  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
547  return;
548 
549  SetReturnCode( retCode );
550 
551  if( !IsQuasiModal() )
552  {
553  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
554  return;
555  }
556 
557  m_qmodal_showing = false;
558 
559  if( m_qmodal_loop )
560  {
561  if( m_qmodal_loop->IsRunning() )
562  m_qmodal_loop->Exit( 0 );
563  else
564  m_qmodal_loop->ScheduleExit( 0 );
565 
566  m_qmodal_loop = NULL;
567  }
568 
571 
572  Show( false );
573 }
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
bool DIALOG_ENV_VAR_CONFIG::ExternalDefsChanged ( ) const
inline

Definition at line 94 of file dialog_env_var_config.h.

References m_extDefsChanged.

Referenced by PGM_BASE::ConfigurePaths().

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 COLOR4D_PICKER_DLG::COLOR4D_PICKER_DLG(), 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_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_EDIT_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), 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_GLOBAL_SYM_LIB_TABLE_CONFIG::DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG(), 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 }
const ENV_VAR_MAP& DIALOG_ENV_VAR_CONFIG::GetEnvVarMap ( ) const
inline

Definition at line 96 of file dialog_env_var_config.h.

References m_envVarMap.

Referenced by PGM_BASE::ConfigurePaths().

97  {
98  return m_envVarMap;
99  }
bool DIALOG_ENV_VAR_CONFIG::GetPathAtIndex ( unsigned int  aIndex,
wxString &  aEnvVar,
wxString &  aEnvPath 
)
protected

Extract the NAME and PATH data from the ENV_VAR at the provided index.

Parameters
aIndexis the index to extract data from
Returns
true if data was extracted else false

Definition at line 157 of file dialog_env_var_config.cpp.

References m_envVarMap.

Referenced by EditSelectedEntry(), OnRemoveButton(), and SelectListIndex().

158 {
159  if( aIndex > m_envVarMap.size() )
160  {
161  return false;
162  }
163 
164  unsigned int idx = 0;
165 
166  for( auto it = m_envVarMap.begin(); it != m_envVarMap.end(); ++it )
167  {
168  if( idx == aIndex )
169  {
170  aEnvVar = it->first;
171  aEnvPath = it->second.GetValue();
172 
173  return true;
174  }
175 
176  idx++;
177  }
178 
179  return false;
180 }
bool DIALOG_ENV_VAR_CONFIG::IsEnvVarImmutable ( const wxString  aEnvVar)
protected

Determine if a particular ENV_VAR is protected.

Parameters
aEnvVaris the name of the ENV_VAR

Definition at line 312 of file dialog_env_var_config.cpp.

Referenced by EditSelectedEntry(), OnRemoveButton(), and SelectListIndex().

313 {
314  /*
315  * TODO - Instead of defining these values here,
316  * extract them from elsewhere in the program
317  * (where they are originally defined)
318  */
319 
320  static const wxString immutable[] = {
321  "KIGITHUB",
322  "KISYS3DMOD",
323  "KISYSMOD",
324  "KIPRJMOD",
325  "KICAD_PTEMPLATES",
326  "KICAD_SYMBOL_DIR"
327  };
328 
329  for( unsigned int ii=0; ii<6; ii++ )
330  {
331  if( aEnvVar.Cmp( immutable[ii] ) == 0 )
332  {
333  return true;
334  }
335  }
336 
337  return false;
338 }
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::AppendSchematic(), 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(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), SCH_EDIT_FRAME::ImportFile(), PCB_EDIT_FRAME::ImportFile(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), PCB_EDIT_FRAME::InstallModuleOptionsFrame(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), 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::rescueProject(), 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(), LIB_MANAGER::UpdatePart(), 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 DIALOG_ENV_VAR_CONFIG::OnAddButton ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_ENV_VAR_CONFIG_BASE.

Definition at line 184 of file dialog_env_var_config.cpp.

References DisplayError(), DIALOG_ENV_VAR_SINGLE::GetEnvVarName(), DIALOG_ENV_VAR_SINGLE::GetEnvVarValue(), m_envVarMap, and PopulatePathList().

185 {
186  DIALOG_ENV_VAR_SINGLE dlg( this, wxEmptyString, wxEmptyString );
187 
188  if( dlg.ShowModal() == wxID_OK )
189  {
190  wxString newName = dlg.GetEnvVarName();
191  wxString newPath = dlg.GetEnvVarValue();
192 
193  // Check that the name does not already exist
194  if( m_envVarMap.count( newName ) > 0 )
195  {
196  //TODO - Improve this message, use DisplayErrorMessage instead
197  DisplayError( this, _( "Path already exists" ) );
198  }
199  else
200  {
201  m_envVarMap[newName] = ENV_VAR_ITEM( newPath );
202 
203  // Update path list
205  }
206  }
207 }
Class ENV_VAR_ITEM.
Definition: pgm_base.h:58
void PopulatePathList()
Update the displayed list of ENV_VAR paths.
A helper dialog to edit a env var name and/or its value (often a path)
void DisplayError(wxWindow *parent, const wxString &text, int displaytime)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:73
void DIALOG_ENV_VAR_CONFIG::OnEditButton ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_ENV_VAR_CONFIG_BASE.

Definition at line 210 of file dialog_env_var_config.cpp.

References EditSelectedEntry().

211 {
213 }
void EditSelectedEntry()
Edit the currently selected ENV_VAR entry.
void DIALOG_ENV_VAR_CONFIG::OnHelpButton ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_ENV_VAR_CONFIG_BASE.

Definition at line 277 of file dialog_env_var_config.cpp.

References DisplayHtmlInfoMessage().

278 {
279  wxString msg = _( "Enter the name and path for each environment variable. Grey entries "
280  "are names that have been defined externally at the system or user "
281  "level. Environment variables defined at the system or user level "
282  "take precedence over the ones defined in this table. This means the "
283  "values in this table are ignored." );
284  msg << wxT( "<br><br><b>" );
285  msg << _( "To ensure environment variable names are valid on all platforms, the name field "
286  "will only accept upper case letters, digits, and the underscore characters." );
287  msg << wxT( "</b><br><br>" );
288  msg << _( "<b>KICAD_SYMBOL_DIR</b> is the base path of the locally installed symbol libraries." );
289  msg << wxT( "<br><br>" );
290  msg << _( "<b>KIGITHUB</b> is used by KiCad to define the URL of the repository "
291  "of the official KiCad libraries." );
292  msg << wxT( "<br><br>" );
293  msg << _( "<b>KISYS3DMOD</b> is the base path of system footprint 3D "
294  "shapes (.3Dshapes folders)." );
295  msg << wxT( "<br><br>" );
296  msg << _( "<b>KISYSMOD</b> is the base path of locally installed system "
297  "footprint libraries (.pretty folders)." );
298  msg << wxT( "<br><br>" );
299  msg << _( "<b>KIPRJMOD</b> is internally defined by KiCad (cannot be edited) and is set "
300  "to the absolute path of the currently loaded project file. This environment "
301  "variable can be used to define files and paths relative to the currently loaded "
302  "project. For instance, ${KIPRJMOD}/libs/footprints.pretty can be defined as a "
303  "folder containing a project specific footprint library named footprints.pretty." );
304  msg << wxT( "<br><br>" );
305  msg << _( "<b>KICAD_PTEMPLATES</b> is optional and can be defined if you want to "
306  "create your own project templates folder." );
307 
308  DisplayHtmlInfoMessage( GetParent(), _( "Environment Variable Help" ), msg );
309 }
void DisplayHtmlInfoMessage(wxWindow *parent, const wxString &title, const wxString &text, const wxSize &size)
Function DisplayHtmlInforMessage displays aMessage in HTML format.
Definition: confirm.cpp:121
void DIALOG_ENV_VAR_CONFIG::OnPathActivated ( wxListEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_ENV_VAR_CONFIG_BASE.

Definition at line 385 of file dialog_env_var_config.cpp.

References EditSelectedEntry(), and SelectListIndex().

386 {
387  SelectListIndex( event.GetIndex() );
388 
390 }
void EditSelectedEntry()
Edit the currently selected ENV_VAR entry.
void SelectListIndex(unsigned int aIndex)
Select the ENV_VAR at the provided index.
void DIALOG_ENV_VAR_CONFIG::OnPathSelected ( wxListEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_ENV_VAR_CONFIG_BASE.

Definition at line 379 of file dialog_env_var_config.cpp.

References SelectListIndex().

380 {
381  SelectListIndex( event.GetIndex() );
382 }
void SelectListIndex(unsigned int aIndex)
Select the ENV_VAR at the provided index.
void DIALOG_ENV_VAR_CONFIG::OnRemoveButton ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_ENV_VAR_CONFIG_BASE.

Definition at line 341 of file dialog_env_var_config.cpp.

References GetPathAtIndex(), IsEnvVarImmutable(), m_envVarMap, m_pathIndex, and PopulatePathList().

342 {
343  wxString envName;
344  wxString envPath;
345 
346  if( GetPathAtIndex( m_pathIndex, envName, envPath ) )
347  {
348  if( IsEnvVarImmutable( envName ) )
349  {
350  return;
351  }
352 
353  m_envVarMap.erase( envName );
354 
356  }
357 }
bool GetPathAtIndex(unsigned int aIndex, wxString &aEnvVar, wxString &aEnvPath)
Extract the NAME and PATH data from the ENV_VAR at the provided index.
void PopulatePathList()
Update the displayed list of ENV_VAR paths.
bool IsEnvVarImmutable(const wxString aEnvVar)
Determine if a particular ENV_VAR is protected.
void DIALOG_ENV_VAR_CONFIG::PopulatePathList ( )
protected

Update the displayed list of ENV_VAR paths.

Definition at line 126 of file dialog_env_var_config.cpp.

References m_envVarMap, and DIALOG_ENV_VAR_CONFIG_BASE::m_pathList.

Referenced by EditSelectedEntry(), OnAddButton(), OnRemoveButton(), and TransferDataToWindow().

127 {
128  m_pathList->Freeze();
129 
130  m_pathList->ClearAll();
131 
132  m_pathList->AppendColumn( _( "Name" ) );
133  m_pathList->AppendColumn( _( "Path" ) );
134 
135  int row = 0;
136 
137  for( auto it = m_envVarMap.begin(); it != m_envVarMap.end(); ++it )
138  {
139  long index = m_pathList->InsertItem( row, it->first );
140 
141  m_pathList->SetItem( index, 1, it->second.GetValue() );
142 
143  //TODO - Indicate via background colour if the path is defined external to KiCad
144 
145  row++;
146  }
147 
148  m_pathList->SetColumnWidth( 0, wxLIST_AUTOSIZE );
149  m_pathList->SetColumnWidth( 1, wxLIST_AUTOSIZE );
150 
151  m_pathList->Update();
152 
153  m_pathList->Thaw();
154 }
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 DIALOG_EDIT_COMPONENT_IN_LIBRARY::AddAliasOfPart(), SCH_EDIT_FRAME::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), DIALOG_MODULE_MODULE_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_MODULE_BOARD_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::BrowseAndSelectDocFile(), DIALOG_EXCHANGE_MODULE::BrowseAndSelectFootprint(), DIALOG_SYMBOL_LIB_TABLE::browseLibrariesHandler(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_MODULE_MODULE_EDITOR::Cfg3DPath(), DIALOG_MODULE_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::copyPanelToOptions(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPlotFileName(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), 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_SYMBOL_LIB_TABLE::DIALOG_SYMBOL_LIB_TABLE(), LIB_VIEW_FRAME::DisplayLibInfos(), LIB_EDIT_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_MODULE_MODULE_EDITOR::Edit3DShapeFileName(), DIALOG_MODULE_BOARD_EDITOR::Edit3DShapeFileName(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_EDIT_FRAME::GenD356File(), NETLIST_DIALOG::GenNetlist(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_VIEWER_FRAME::getCurFootprintName(), LIB_EDIT_FRAME::GetCurLib(), FOOTPRINT_VIEWER_FRAME::getCurNickname(), FOOTPRINT_EDIT_FRAME::GetCurrentLib(), SCH_BASE_FRAME::GetLibAlias(), SCH_BASE_FRAME::GetLibPart(), FOOTPRINT_EDIT_FRAME::getLibPath(), LIB_EDIT_FRAME::getLibraryFileName(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), DIALOG_BOM::getPluginFileName(), LIB_VIEW_FRAME::getSelectedAlias(), FP_THREAD_IFACE::GetTable(), SCH_EDIT_FRAME::ImportFile(), PCB_EDIT_FRAME::ImportFile(), DIALOG_MODULE_MODULE_EDITOR::initModeditProperties(), DIALOG_MODULE_BOARD_EDITOR::InitModeditProperties(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), SCH_EDIT_FRAME::Load_Component(), SCH_EDIT_FRAME::LoadCmpToFootprintLinkFile(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), CVPCB_MAINFRAME::LoadFootprintFiles(), DIALOG_SPICE_MODEL::loadLibrary(), LIB_EDIT_FRAME::LoadOneSymbol(), CVPCB_MAINFRAME::LoadProjectFile(), SCH_EDIT_FRAME::LoadProjectFile(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC_CONTROL::makeValidFileNameReport(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_GENCAD_EXPORT_OPTIONS::onBrowse(), DIALOG_DRC_CONTROL::OnButtonBrowseRptFileClick(), DIALOG_EDIT_COMPONENTS_LIBID::onClickOrphansButton(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), DIALOG_GENDRILL::OnGenReportFile(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_CHOOSE_COMPONENT::OnInitDialog(), PCB_EDIT_FRAME::OnLeftClick(), 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_CHOOSE_COMPONENT::OnSchViewPaint(), DIALOG_SPICE_MODEL::onSelectLibrary(), LIB_VIEW_FRAME::OnSelectSymbol(), 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(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), SCH_EDIT_FRAME::Process_Config(), PCB_EDIT_FRAME::Process_Config(), 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::RescueLegacyProject(), SCH_EDIT_FRAME::RescueSymbolLibTableProject(), FOOTPRINT_EDIT_FRAME::restoreLastFootprint(), FOOTPRINT_EDIT_FRAME::retainLastFootprint(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), LIB_EDIT_FRAME::saveLibrary(), LIB_EDIT_FRAME::SaveOneSymbol(), CVPCB_MAINFRAME::SaveProjectFile(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), SCH_BASE_FRAME::saveSymbolLibTables(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), SCH_BASE_FRAME::SelectComponentFromLibrary(), FOOTPRINT_VIEWER_FRAME::SelectCurrentFootprint(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), LIB_EDIT_FRAME::selectSymLibTable(), SCH_EDIT_FRAME::sendNetlist(), FOOTPRINT_VIEWER_FRAME::setCurFootprintName(), LIB_EDIT_FRAME::SetCurLib(), FOOTPRINT_VIEWER_FRAME::setCurNickname(), LIB_EDIT_FRAME::SetCurPart(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), EDA_3D_VIEWER::takeScreenshot(), SIM_PLOT_FRAME::updateNetlistExporter(), SCH_SCREEN::UpdateSymbolLinks(), 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 DIALOG_ENV_VAR_CONFIG::SelectListIndex ( unsigned int  aIndex)
protected

Select the ENV_VAR at the provided index.

Definition at line 360 of file dialog_env_var_config.cpp.

References GetPathAtIndex(), IsEnvVarImmutable(), DIALOG_ENV_VAR_CONFIG_BASE::m_deletePathButton, m_envVarMap, and m_pathIndex.

Referenced by OnPathActivated(), OnPathSelected(), and TransferDataToWindow().

361 {
362  if( aIndex >= m_envVarMap.size() )
363  {
364  aIndex = 0;
365  }
366 
367  m_pathIndex = aIndex;
368 
369  wxString envName;
370  wxString envPath;
371 
372  if( GetPathAtIndex( m_pathIndex, envName, envPath ) )
373  {
374  // Disable the 'delete' button if the path cannot be deleted
375  m_deletePathButton->Enable( !IsEnvVarImmutable( envName ) );
376  }
377 }
bool GetPathAtIndex(unsigned int aIndex, wxString &aEnvVar, wxString &aEnvPath)
Extract the NAME and PATH data from the ENV_VAR at the provided index.
bool IsEnvVarImmutable(const wxString aEnvVar)
Determine if a particular ENV_VAR is protected.
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 #ifndef __WINDOWS__
159  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
160 #endif
161  ret = wxDialog::Show( show );
162 
163  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
164  EDA_RECT r = class_map[ hash_key ];
165 
166  if( r.GetSize().x != 0 && r.GetSize().y != 0 )
167  SetSize( r.GetPosition().x, r.GetPosition().y, r.GetSize().x, r.GetSize().y, 0 );
168  }
169  else
170  {
171  // Save the dialog's position & size before hiding, using classname as key
172  EDA_RECT r( wxDialog::GetPosition(), wxDialog::GetSize() );
173  class_map[ hash_key ] = r;
174 
175  ret = wxDialog::Show( show );
176  }
177 
179 
180  return ret;
181 }
const wxSize GetSize() const
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.
int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 497 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 SCH_EDIT_FRAME::EditComponent(), SCH_EDIT_FRAME::EditComponentFieldText(), LIB_EDIT_FRAME::EditField(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::InstallExchangeModuleFrame(), LIB_EDIT_FRAME::InstallFieldsEditorDialog(), SCH_EDIT_FRAME::InstallHierarchyFrame(), InvokeDialogCreateBOMEditor(), InvokeDialogUpdateFields(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), and SCH_BASE_FRAME::SelectComponentFromLibrary().

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

Definition at line 113 of file dialog_env_var_config.cpp.

References m_envVarMap, Pgm(), and PGM_BASE::SetLocalEnvVariables().

114 {
115  if( !wxDialog::TransferDataFromWindow() )
116  {
117  return false;
118  }
119 
121 
122  return true;
123 }
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
VTBL_ENTRY void SetLocalEnvVariables(const ENV_VAR_MAP &aEnvVarMap)
Function SetLocalEnvVariables.
Definition: pgm_base.cpp:884
bool DIALOG_ENV_VAR_CONFIG::TransferDataToWindow ( )
override

Definition at line 80 of file dialog_env_var_config.cpp.

References PopulatePathList(), and SelectListIndex().

81 {
82  wxLogDebug( wxT( "In DIALOG_ENV_VAR_CONFIG::TransferDataToWindow()." ) );
83 
84  if( !wxDialog::TransferDataToWindow() )
85  return false;
86 
87  //TODO
88  /*
89  // Grab the project path var (not editable)
90  wxString prjPath;
91 
92  wxGetEnv( PROJECT_VAR_NAME, &prjPath );
93 
94  m_kiprjmod->SetLabel( prjPath );
95  */
96 
97  //TODO - Call SetAlternateRowColour first to prevent assertion error
98  //m_pathList->EnableAlternateRowColours( true );
99 
101 
102  // Select the first item in the list
103  SelectListIndex( 0 );
104 
105  GetSizer()->Layout();
106  GetSizer()->Fit( this );
107  GetSizer()->SetSizeHints( this );
108 
109  return true;
110 }
void PopulatePathList()
Update the displayed list of ENV_VAR paths.
void SelectListIndex(unsigned int aIndex)
Select the ENV_VAR at the provided index.

Member Data Documentation

wxButton* DIALOG_ENV_VAR_CONFIG_BASE::m_addPathButton
protectedinherited
wxButton* DIALOG_ENV_VAR_CONFIG_BASE::m_deletePathButton
protectedinherited
wxButton* DIALOG_ENV_VAR_CONFIG_BASE::m_editPathButton
protectedinherited
bool DIALOG_ENV_VAR_CONFIG::m_extDefsChanged = false
private

Definition at line 43 of file dialog_env_var_config.h.

Referenced by EditSelectedEntry(), and ExternalDefsChanged().

std::string DIALOG_SHIM::m_hash_key
protectedinherited
unsigned int DIALOG_ENV_VAR_CONFIG::m_pathIndex = 0
protected

Definition at line 67 of file dialog_env_var_config.h.

Referenced by EditSelectedEntry(), OnRemoveButton(), and SelectListIndex().

wxListCtrl* DIALOG_ENV_VAR_CONFIG_BASE::m_pathList
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
wxStdDialogButtonSizer* DIALOG_ENV_VAR_CONFIG_BASE::m_sdbSizer
protectedinherited
wxButton* DIALOG_ENV_VAR_CONFIG_BASE::m_sdbSizerCancel
protectedinherited
wxButton* DIALOG_ENV_VAR_CONFIG_BASE::m_sdbSizerHelp
protectedinherited
wxButton* DIALOG_ENV_VAR_CONFIG_BASE::m_sdbSizerOK
protectedinherited
wxStaticLine* DIALOG_ENV_VAR_CONFIG_BASE::m_staticline1
protectedinherited

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