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
 
void OnPaint (wxPaintEvent &event)
 
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 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...
 

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
 
bool m_fixupsRun
 
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=_("Environment Variable Configuration"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(-1,-1), 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.

References TransferDataFromWindow(), and TransferDataToWindow().

89 {}

Member Function Documentation

void DIALOG_ENV_VAR_CONFIG::EditSelectedEntry ( )
protected

Edit the currently selected ENV_VAR entry.

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

222 {
223  wxString envName;
224  wxString envPath;
225 
226  if( GetPathAtIndex( m_pathIndex, envName, envPath ) )
227  {
228  auto dlg = new DIALOG_ENV_VAR_SINGLE( nullptr, envName, envPath );
229 
230  if( IsEnvVarImmutable( envName ) )
231  {
232  dlg->SetEnvVarProtected();
233  }
234 
235  if( dlg->ShowModal() == wxID_OK )
236  {
237  wxString newName = dlg->GetEnvVarName();
238  wxString newPath = dlg->GetEnvVarValue();
239 
240  // If the path name has not been changed
241  if( envName.Cmp( newName ) == 0 )
242  {
243  m_envVarMap[envName].SetValue( newPath );
244 
245  if( m_envVarMap[envName].GetDefinedExternally() )
246  {
247  m_extDefsChanged = true;
248  }
249  }
250  // Path-name needs to be updated
251  else
252  {
253  if( IsEnvVarImmutable( envName ) )
254  {
255  DisplayErrorMessage( this,
256  wxString::Format( _( "Environment variable \"%s\" cannot "
257  "be renamed." ),
258  envName.ToStdString() ),
259  _( "The selected environment variable name "
260  "is required for KiCad functionality and "
261  "can not be renamed." ) );
262 
263  return;
264  }
265 
266  auto envVar = m_envVarMap[envName];
267 
268  m_envVarMap.erase( envName );
269 
270  envVar.SetValue( newPath );
271  envVar.SetDefinedExternally( false );
272  m_envVarMap[newName] = envVar;
273  }
274 
275  // Update the path list
277  }
278 
279  dlg->Destroy();
280  }
281 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Function DisplayErrorMessage displays an error message with aMessage.
Definition: confirm.cpp:255
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.
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 199 of file dialog_shim.cpp.

Referenced by DIALOG_PRINT_USING_PRINTER::InitValues(), and DIALOG_SHIM::IsQuasiModal().

200 {
201  // so we can do logging of this state change:
202 
203 #if defined(DEBUG)
204  const char* type_id = typeid( *this ).name();
205  printf( "wxDialog %s: %s\n", type_id, enable ? "enabled" : "disabled" );
206 #endif
207 
208  return wxDialog::Enable( enable );
209 }
void DIALOG_SHIM::EndQuasiModal ( int  retCode)
inherited

Definition at line 604 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 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_FOOTPRINTS::OnQuit(), DIALOG_CHOOSE_COMPONENT::OnSchViewDClick(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::SetInitCmp(), and DIALOG_SHIM::~DIALOG_SHIM().

605 {
606  // Hook up validator and transfer data from controls handling so quasi-modal dialogs
607  // handle validation in the same way as other dialogs.
608  if( ( retCode == wxID_OK ) && ( !Validate() || !TransferDataFromWindow() ) )
609  return;
610 
611  SetReturnCode( retCode );
612 
613  if( !IsQuasiModal() )
614  {
615  wxFAIL_MSG( wxT( "either DIALOG_SHIM::EndQuasiModal called twice or ShowQuasiModal wasn't called" ) );
616  return;
617  }
618 
619  m_qmodal_showing = false;
620 
621  if( m_qmodal_loop )
622  {
623  if( m_qmodal_loop->IsRunning() )
624  m_qmodal_loop->Exit( 0 );
625  else
626  m_qmodal_loop->ScheduleExit( 0 );
627 
628  m_qmodal_loop = NULL;
629  }
630 
633 
634  Show( false );
635 }
bool m_qmodal_showing
Definition: dialog_shim.h:155
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:154
bool IsQuasiModal()
Definition: dialog_shim.h:103
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:156
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_3D_VIEW_OPTIONS::DIALOG_3D_VIEW_OPTIONS(), DIALOG_ANNOTATE::DIALOG_ANNOTATE(), 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_LINE_STYLE::DIALOG_EDIT_LINE_STYLE(), DIALOG_EESCHEMA_OPTIONS::DIALOG_EESCHEMA_OPTIONS(), DIALOG_ENUM_PADS::DIALOG_ENUM_PADS(), DIALOG_EXCHANGE_FOOTPRINTS::DIALOG_EXCHANGE_FOOTPRINTS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_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_PADS_MASK_CLEARANCE::DIALOG_PADS_MASK_CLEARANCE(), 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(), DIALOG_SHIM::IsQuasiModal(), 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(), DIALOG_EDIT_FPTEXT::OnInitDlg(), DIALOG_SET_GRID::OnInitDlg(), DIALOG_PCB_TEXT_PROPERTIES::OnInitDlg(), DIALOG_PRINT_FOR_MODEDIT::OnInitDlg(), DIALOG_FOOTPRINT_FP_EDITOR::OnInitDlg(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnInitDlg(), DIALOG_SIM_SETTINGS::onInitDlg(), DIALOG_SPICE_MODEL::onInitDlg(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnInitDlg(), DIALOG_PRINT_USING_PRINTER::OnInitDlg(), DIALOG_EDIT_COMPONENT_IN_SCHEMATIC::OnInitDlg(), TARGET_PROPERTIES_DIALOG_EDITOR::TARGET_PROPERTIES_DIALOG_EDITOR(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), and DIALOG_UPDATE_FIELDS::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 }
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 162 of file dialog_env_var_config.cpp.

References m_envVarMap.

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

164 {
165  if( aIndex > m_envVarMap.size() )
166  {
167  return false;
168  }
169 
170  unsigned int idx = 0;
171 
172  for( auto it = m_envVarMap.begin(); it != m_envVarMap.end(); ++it )
173  {
174  if( idx == aIndex )
175  {
176  aEnvVar = it->first;
177  aEnvPath = it->second.GetValue();
178 
179  return true;
180  }
181 
182  idx++;
183  }
184 
185  return false;
186 }
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 125 of file dialog_shim.cpp.

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

126 {
127  wxSize sz( x, 0 );
128  return ConvertDialogToPixels( sz ).x;
129 }
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 322 of file dialog_env_var_config.cpp.

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

323 {
324  /*
325  * TODO - Instead of defining these values here,
326  * extract them from elsewhere in the program
327  * (where they are originally defined)
328  */
329 
330  static const wxString immutable[] = {
331  "KIGITHUB",
332  "KISYS3DMOD",
333  "KISYSMOD",
334  "KIPRJMOD",
335  "KICAD_PTEMPLATES",
336  "KICAD_SYMBOL_DIR"
337  };
338 
339  for( unsigned int ii=0; ii<6; ii++ )
340  {
341  if( aEnvVar.Cmp( immutable[ii] ) == 0 )
342  {
343  return true;
344  }
345  }
346 
347  return false;
348 }
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, KIWAY_HOLDER::Prj(), and KIWAY_HOLDER::SetKiway().

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(), FOOTPRINT_EDIT_FRAME::GetIconScale(), LIB_MANAGER::getLibraryBuffer(), FOOTPRINT_EDIT_FRAME::GetPlotSettings(), SCH_EDIT_FRAME::ImportFile(), PCB_EDIT_FRAME::ImportFile(), DIALOG_EDIT_LIBENTRY_FIELDS_IN_LIB::initBuffers(), KIWAY_PLAYER::language_change(), CVPCB_MAINFRAME::LoadFootprintFiles(), KIWAY_PLAYER::OnChangeIconsOptions(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), SCH_BASE_FRAME::OnEditSymbolLibTable(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), 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(), FOOTPRINT_WIZARD_FRAME::ReCreateVToolbar(), LIB_EDIT_FRAME::refreshSchematic(), SCH_EDIT_FRAME::SaveEEFile(), CVPCB_MAINFRAME::SaveFootprintAssociation(), SCH_BASE_FRAME::SelectComponentFromLibBrowser(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), 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_FOOTPRINTS::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 189 of file dialog_env_var_config.cpp.

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

190 {
191  DIALOG_ENV_VAR_SINGLE dlg( nullptr, wxEmptyString, wxEmptyString );
192 
193  if( dlg.ShowModal() == wxID_OK )
194  {
195  wxString newName = dlg.GetEnvVarName();
196  wxString newPath = dlg.GetEnvVarValue();
197 
198  // Check that the name does not already exist
199  if( m_envVarMap.count( newName ) > 0 )
200  {
201  //TODO - Improve this message, use DisplayErrorMessage instead
202  DisplayError( this, _( "Path already exists." ) );
203  }
204  else
205  {
206  m_envVarMap[newName] = ENV_VAR_ITEM( newPath );
207 
208  // Update path list
210  }
211  }
212 }
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:241
void DIALOG_ENV_VAR_CONFIG::OnEditButton ( wxCommandEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_ENV_VAR_CONFIG_BASE.

Definition at line 215 of file dialog_env_var_config.cpp.

References EditSelectedEntry().

216 {
218 }
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 283 of file dialog_env_var_config.cpp.

References HTML_MESSAGE_BOX::AddHTML_Text(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

284 {
285  wxString msg = _( "Enter the name and value for each environment variable. Grey entries "
286  "are names that have been defined externally at the system or user "
287  "level. Environment variables defined at the system or user level "
288  "take precedence over the ones defined in this table. This means the "
289  "values in this table are ignored." );
290  msg << wxT( "<br><br><b>" );
291  msg << _( "To ensure environment variable names are valid on all platforms, the name field "
292  "will only accept upper case letters, digits, and the underscore characters." );
293  msg << wxT( "</b><br><br>" );
294  msg << _( "<b>KICAD_SYMBOL_DIR</b> is the base path of the locally installed symbol libraries." );
295  msg << wxT( "<br><br>" );
296  msg << _( "<b>KIGITHUB</b> is used by KiCad to define the URL of the repository "
297  "of the official KiCad footprint libraries." );
298  msg << wxT( "<br><br>" );
299  msg << _( "<b>KISYS3DMOD</b> is the base path of system footprint 3D "
300  "shapes (.3Dshapes folders)." );
301  msg << wxT( "<br><br>" );
302  msg << _( "<b>KISYSMOD</b> is the base path of locally installed system "
303  "footprint libraries (.pretty folders)." );
304  msg << wxT( "<br><br>" );
305  msg << _( "<b>KIPRJMOD</b> is internally defined by KiCad (cannot be edited) and is set "
306  "to the absolute path of the currently loaded project file. This environment "
307  "variable can be used to define files and paths relative to the currently loaded "
308  "project. For instance, ${KIPRJMOD}/libs/footprints.pretty can be defined as a "
309  "folder containing a project specific footprint library named footprints.pretty." );
310  msg << wxT( "<br><br>" );
311  msg << _( "<b>KICAD_PTEMPLATES</b> is optional and can be defined if you want to "
312  "create your own project templates folder." );
313 
314  HTML_MESSAGE_BOX dlg( GetParent(), _( "Environment Variable Help" ) );
315  dlg.SetDialogSizeInDU( 400, 350 );
316 
317  dlg.AddHTML_Text( msg );
318  dlg.ShowModal();
319 }
Class HTML_MESSAGE_BOX.
void DIALOG_SHIM::OnPaint ( wxPaintEvent &  event)
inherited

Definition at line 265 of file dialog_shim.cpp.

References DIALOG_SHIM::m_fixupsRun, and recursiveDescent().

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

266 {
267  if( !m_fixupsRun )
268  {
269 #if DLGSHIM_SELECT_ALL_IN_TEXT_CONTROLS
270  const bool selectAllInTextCtrls = true;
271 #else
272  const bool selectAllInTextCtrls = false;
273 #endif
274  wxWindow* firstTextCtrl = NULL;
275  wxWindow* windowWithFocus = NULL;
276 
277  recursiveDescent( GetChildren(), selectAllInTextCtrls, firstTextCtrl,
278  windowWithFocus );
279 
280 #if DLGSHIM_USE_SETFOCUS
281  // While it would be nice to honour any focus already set (which was
282  // recorded in windowWithFocus), the reality is that it's currently wrong
283  // far more often than it's right.
284  // So just focus on the first text control if we have one; otherwise the
285  // focus on the dialog itself, which will at least allow esc, return, etc.
286  // to function.
287  if( firstTextCtrl )
288  firstTextCtrl->SetFocus();
289  else
290  SetFocus();
291 #endif
292 
293 #ifdef __WXMAC__
294  fixOSXCancelButtonIssue( this );
295 #endif
296 
297  m_fixupsRun = true;
298  }
299 
300  event.Skip();
301 }
static void recursiveDescent(wxWindowList &children, const bool selectTextInTextCtrls, wxWindow *&firstTextCtrl, wxWindow *&windowWithFocus)
bool m_fixupsRun
Definition: dialog_shim.h:149
void DIALOG_ENV_VAR_CONFIG::OnPathActivated ( wxListEvent &  event)
overrideprotectedvirtual

Reimplemented from DIALOG_ENV_VAR_CONFIG_BASE.

Definition at line 395 of file dialog_env_var_config.cpp.

References EditSelectedEntry(), and SelectListIndex().

396 {
397  SelectListIndex( event.GetIndex() );
398 
400 }
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 389 of file dialog_env_var_config.cpp.

References SelectListIndex().

390 {
391  SelectListIndex( event.GetIndex() );
392 }
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 351 of file dialog_env_var_config.cpp.

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

352 {
353  wxString envName;
354  wxString envPath;
355 
356  if( GetPathAtIndex( m_pathIndex, envName, envPath ) )
357  {
358  if( IsEnvVarImmutable( envName ) )
359  {
360  return;
361  }
362 
363  m_envVarMap.erase( envName );
364 
366  }
367 }
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 color, 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  if( it->second.GetDefinedExternally() )
144  {
145  wxColour color = wxSystemSettings::GetColour( wxSYS_COLOUR_GRAYTEXT );
146 
147  m_pathList->SetItemBackgroundColour( index, color );
148  }
149 
150  row++;
151  }
152 
153  m_pathList->SetColumnWidth( 0, wxLIST_AUTOSIZE );
154  m_pathList->SetColumnWidth( 1, wxLIST_AUTOSIZE );
155 
156  m_pathList->Update();
157 
158  m_pathList->Thaw();
159 }
int color
Definition: DXF_plotter.cpp:62
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::AppendSchematic(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), DIALOG_SYMBOL_REMAP::backupProject(), LIB_VIEW_FRAME::BestZoom(), DIALOG_FOOTPRINT_FP_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_FOOTPRINT_BOARD_EDITOR::BrowseAndAdd3DShapeFile(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::BrowseAndSelectDocFile(), DIALOG_SYMBOL_LIB_TABLE::browseLibrariesHandler(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_FOOTPRINT_FP_EDITOR::Cfg3DPath(), DIALOG_FOOTPRINT_BOARD_EDITOR::Cfg3DPath(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::checkNewAlias(), 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_FOOTPRINT_BOARD_EDITOR::DIALOG_FOOTPRINT_BOARD_EDITOR(), DIALOG_FOOTPRINT_FP_EDITOR::DIALOG_FOOTPRINT_FP_EDITOR(), DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS(), DIALOG_SYMBOL_LIB_TABLE::DIALOG_SYMBOL_LIB_TABLE(), DIALOG_SYMBOL_REMAP::DIALOG_SYMBOL_REMAP(), LIB_VIEW_FRAME::DisplayLibInfos(), LIB_EDIT_FRAME::DisplayLibInfos(), SCH_BASE_FRAME::DisplayListComponentsInLib(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_FOOTPRINT_FP_EDITOR::Edit3DShapeFileName(), DIALOG_FOOTPRINT_BOARD_EDITOR::Edit3DShapeFileName(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), PCB_EDIT_FRAME::Files_io_from_id(), 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_FOOTPRINT_FP_EDITOR::initModeditProperties(), DIALOG_FOOTPRINT_BOARD_EDITOR::InitModeditProperties(), PCB_EDIT_FRAME::InstallNetlistFrame(), SCH_EDIT_FRAME::IsSearchCacheObsolete(), KIWAY_HOLDER::Kiway(), 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(), LIB_EDIT_FRAME::OnPlotCurrentComponent(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SCH_EDIT_FRAME::OnRightClick(), DIALOG_BOM::OnRunPlugin(), 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(), 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(), LIB_MANAGER::symTable(), 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_FOOTPRINT_BOARD_EDITOR::~DIALOG_FOOTPRINT_BOARD_EDITOR(), and DIALOG_FOOTPRINT_FP_EDITOR::~DIALOG_FOOTPRINT_FP_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:142
void DIALOG_ENV_VAR_CONFIG::SelectListIndex ( unsigned int  aIndex)
protected

Select the ENV_VAR at the provided index.

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

371 {
372  if( aIndex >= m_envVarMap.size() )
373  {
374  aIndex = 0;
375  }
376 
377  m_pathIndex = aIndex;
378 
379  wxString envName;
380  wxString envPath;
381 
382  if( GetPathAtIndex( m_pathIndex, envName, envPath ) )
383  {
384  // Disable the 'delete' button if the path cannot be deleted
385  m_deletePathButton->Enable( !IsEnvVarImmutable( envName ) );
386  }
387 }
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(), KIWAY_HOLDER::Kiway(), 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
Definition: DXF_plotter.cpp:61
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 118 of file dialog_shim.cpp.

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_EDIT_COMPONENTS_LIBID::DIALOG_EDIT_COMPONENTS_LIBID(), DIALOG_FIELDS_EDITOR_GLOBAL::DIALOG_FIELDS_EDITOR_GLOBAL(), DIALOG_RESCUE_EACH::DIALOG_RESCUE_EACH(), DIALOG_SYMBOL_LIB_TABLE::DIALOG_SYMBOL_LIB_TABLE(), HOTKEYS_EDITOR_DIALOG::HOTKEYS_EDITOR_DIALOG(), HTML_MESSAGE_BOX::HTML_MESSAGE_BOX(), DIALOG_SHIM::IsQuasiModal(), DIALOG_LAYERS_SETUP::OnInitDialog(), and HTML_MESSAGE_BOX::SetDialogSizeInDU().

119 {
120  wxSize sz( x, y );
121  SetSize( ConvertDialogToPixels( sz ) );
122 }
bool DIALOG_SHIM::Show ( bool  show)
overrideinherited

Definition at line 146 of file dialog_shim.cpp.

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

Referenced by DisplayHotkeyList(), DIALOG_SHIM::EndQuasiModal(), InvokeDialogERC(), DIALOG_SHIM::IsQuasiModal(), DIALOG_SCH_FIND::OnCancel(), DIALOG_DRC_CONTROL::OnLeftDClickClearance(), DIALOG_DRC_CONTROL::OnLeftDClickUnconnected(), DIALOG_DRC_CONTROL::OnPopupMenu(), DIALOG_EXCHANGE_FOOTPRINTS::OnQuit(), POSITION_RELATIVE_TOOL::PositionRelative(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), SCH_COMPONENT::SetPosition(), DRC::ShowDRCDialog(), and DIALOG_SHIM::ShowQuasiModal().

147 {
148  bool ret;
149  const char* hash_key;
150 
151  if( m_hash_key.size() )
152  {
153  // a special case like EDA_LIST_DIALOG, which has multiple uses.
154  hash_key = m_hash_key.c_str();
155  }
156  else
157  {
158  hash_key = typeid(*this).name();
159  }
160 
161  // Show or hide the window. If hiding, save current position and size.
162  // If showing, use previous position and size.
163  if( show )
164  {
165 #ifndef __WINDOWS__
166  wxDialog::Raise(); // Needed on OS X and some other window managers (i.e. Unity)
167 #endif
168  ret = wxDialog::Show( show );
169 
170  // classname is key, returns a zeroed out default EDA_RECT if none existed before.
171  EDA_RECT savedDialogRect = class_map[ hash_key ];
172 
173  if( savedDialogRect.GetSize().x != 0 && savedDialogRect.GetSize().y != 0 )
174  {
175  SetSize( savedDialogRect.GetPosition().x,
176  savedDialogRect.GetPosition().y,
177  std::max( wxDialog::GetSize().x, savedDialogRect.GetSize().x ),
178  std::max( wxDialog::GetSize().y, savedDialogRect.GetSize().y ),
179  0 );
180  }
181  }
182  else
183  {
184  // Save the dialog's position & size before hiding, using classname as key
185  class_map[ hash_key ] = EDA_RECT( wxDialog::GetPosition(), wxDialog::GetSize() );
186 
187 #ifdef __WXMAC__
188  if ( m_eventLoop )
189  m_eventLoop->Exit( GetReturnCode() ); // Needed for APP-MODAL dlgs on OSX
190 #endif
191 
192  ret = wxDialog::Show( show );
193  }
194 
195  return ret;
196 }
const wxSize GetSize() const
Definition: eda_rect.h:101
std::string m_hash_key
Definition: dialog_shim.h:151
static RECT_MAP class_map
const wxPoint GetPosition() const
Definition: eda_rect.h:113
#define max(a, b)
Definition: auxiliary.h:86
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
int DIALOG_SHIM::ShowQuasiModal ( )
inherited

Definition at line 552 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(), InvokeDialogEditComponentsLibId(), InvokeDialogUpdateFields(), SCH_EDIT_FRAME::OnRemapSymbols(), LIB_VIEW_FRAME::OnSelectSymbol(), SCH_EDIT_FRAME::OpenProjectFiles(), and SCH_BASE_FRAME::SelectComponentFromLibrary().

553 {
554  // This is an exception safe way to zero a pointer before returning.
555  // Yes, even though DismissModal() clears this first normally, this is
556  // here in case there's an exception before the dialog is dismissed.
557  struct NULLER
558  {
559  void*& m_what;
560  NULLER( void*& aPtr ) : m_what( aPtr ) {}
561  ~NULLER() { m_what = 0; } // indeed, set it to NULL on destruction
562  } clear_this( (void*&) m_qmodal_loop );
563 
564  // release the mouse if it's currently captured as the window having it
565  // will be disabled when this dialog is shown -- but will still keep the
566  // capture making it impossible to do anything in the modal dialog itself
567  wxWindow* win = wxWindow::GetCapture();
568  if( win )
569  win->ReleaseMouse();
570 
571  // Get the optimal parent
572  wxWindow* parent = GetParentForModalDialog( GetParent(), GetWindowStyle() );
573 
574  // Show the optimal parent
575  DBG( if( parent ) printf( "%s: optimal parent: %s\n", __func__, typeid(*parent).name() );)
576 
577  wxASSERT_MSG( !m_qmodal_parent_disabler,
578  wxT( "Caller using ShowQuasiModal() twice on same window?" ) );
579 
580  // quasi-modal: disable only my "optimal" parent
582 
583 #ifdef __WXMAC__
584  // Apple in its infinite wisdom will raise a disabled window before even passing
585  // us the event, so we have no way to stop it. Instead, we must set an order on
586  // the windows so that the quasi-modal will be pushed in front of the disabled
587  // window when it is raised.
588  ReparentQuasiModal();
589 #endif
590  Show( true );
591 
592  m_qmodal_showing = true;
593 
594  EVENT_LOOP event_loop;
595 
596  m_qmodal_loop = &event_loop;
597 
598  event_loop.Run();
599 
600  return GetReturnCode();
601 }
bool m_qmodal_showing
Definition: dialog_shim.h:155
EVENT_LOOP * m_qmodal_loop
Definition: dialog_shim.h:154
bool Show(bool show) override
WDO_ENABLE_DISABLE * m_qmodal_parent_disabler
Definition: dialog_shim.h:156
Toggle a window&#39;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().

Referenced by ~DIALOG_ENV_VAR_CONFIG().

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

Referenced by ~DIALOG_ENV_VAR_CONFIG().

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

Referenced by DIALOG_CHOOSE_COMPONENT::DIALOG_CHOOSE_COMPONENT(), DIALOG_SHIM::IsQuasiModal(), and DIALOG_LAYERS_SETUP::OnInitDialog().

133 {
134  wxSize sz( 0, y );
135  return ConvertDialogToPixels( sz ).y;
136 }

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

bool DIALOG_SHIM::m_fixupsRun
protectedinherited

Definition at line 149 of file dialog_shim.h.

Referenced by DIALOG_SHIM::OnPaint().

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 154 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: