65 m_errorGrid( nullptr ),
81 wxGridCellAttr* attr =
new wxGridCellAttr;
86 [
this]( wxCommandEvent& aEvent )
91 m_EnvVars->SetSelectionMode( wxGrid::wxGridSelectionModes::wxGridSelectRows );
97 m_EnvVars->Connect( wxEVT_GRID_CELL_CHANGING,
108 GetSizer()->SetSizeHints(
this );
118 m_EnvVars->Disconnect( wxEVT_GRID_CELL_CHANGING,
126 if( !wxDialog::TransferDataToWindow() )
131 for(
auto it = envVars.begin(); it != envVars.end(); ++it )
133 const wxString&
path = it->second.GetValue();
136 if(
m_curdir.IsEmpty() && !
path.StartsWith(
"${" ) && !
path.StartsWith(
"$(" ) )
156 nameCellAttr->SetEditor( nameTextEditor );
158 nameCellAttr->DecRef();
163 wxSystemColour c = isExternal ? wxSYS_COLOUR_MENU : wxSYS_COLOUR_LISTBOX;
164 pathCellAttr->SetBackgroundColour( wxSystemSettings::GetColour( c ) );
165 pathCellAttr->DecRef();
176 if( !wxDialog::TransferDataFromWindow() )
182 for(
int row = 0; row <
m_EnvVars->GetNumberRows(); ++row )
192 else if(
name.empty() &&
path.empty() )
197 else if(
name.IsEmpty() )
202 m_errorMsg =
_(
"Environment variable name cannot be empty." );
205 else if(
path.IsEmpty() )
210 m_errorMsg =
_(
"Environment variable path cannot be empty." );
214 if( envVarMap.count(
name ) )
215 envVarMap.at(
name ).SetValue(
path );
221 for(
auto it = envVarMap.begin(); it != envVarMap.end(); )
225 for(
int row = 0; row <
m_EnvVars->GetNumberRows(); ++row )
229 if( it->first ==
name )
239 it = envVarMap.erase( it );
250 wxGrid*
grid =
dynamic_cast<wxGrid*
>(
event.GetEventObject() );
251 int row =
event.GetRow();
252 int col =
event.GetCol();
253 wxString
text =
event.GetString();
255 text.Trim(
true ).Trim(
false );
256 grid->SetCellValue( row, col,
text );
263 m_errorMsg =
_(
"Environment variable name cannot be empty." );
265 m_errorMsg =
_(
"Environment variable path cannot be empty." );
270 m_errorMsg =
_(
"3D search path alias cannot be empty." );
272 m_errorMsg =
_(
"3D search path cannot be empty." );
275 m_errorGrid =
dynamic_cast<wxGrid*
>(
event.GetEventObject() );
287 wxString msg1 =
_(
"This path was defined externally to the running process and\n"
288 "will only be temporarily overwritten." );
289 wxString msg2 =
_(
"The next time KiCad is launched, any paths that have already\n"
290 "been defined are honored and any settings defined in the path\n"
291 "configuration dialog are ignored. If you did not intend for\n"
292 "this behavior, either rename any conflicting entries or remove\n"
293 "the external environment variable(s) from your system." );
295 dlg.ShowDetailedText( msg2 );
307 wxMessageBox( wxString::Format(
_(
"The name %s is reserved, and cannot be used." ),
323 [&]() -> std::pair<int, int>
368 grid->EnableCellEditControl(
true );
369 grid->ShowCellEditControl();
376 wxSizer* sizerMain = GetSizer();
381 wxHW_SCROLLBAR_AUTO );
383 wxString msg =
_(
"Enter the name and value for each environment variable. Grey entries "
384 "are names that have been defined externally at the system or user "
385 "level. Environment variables defined at the system or user level "
386 "take precedence over the ones defined in this table. This means the "
387 "values in this table are ignored." );
388 msg <<
"<br><br><b>";
389 msg <<
_(
"To ensure environment variable names are valid on all platforms, the name field "
390 "will only accept upper case letters, digits, and the underscore characters." );
395 msg <<
"<br><br><b>" << var <<
"</b>";
399 if( desc.size() > 0 )
407 sizerMain->Insert( sizerMain->GetItemCount() - 1,
m_helpBox, 1, wxALL|wxEXPAND, 10 );
420 int minHelpBoxHeight = GetTextExtent( wxT(
"T" ) ).y * 20;
422 if( GetClientSize().y < minHelpBoxHeight * 2 )
423 SetClientSize( wxSize( GetClientSize().x, GetClientSize().y + minHelpBoxHeight ) );
wxBitmapBundle KiBitmapBundle(BITMAPS aBitmap, int aMinHeight)
DO_NOT_SHOW_AGAIN m_DoNotShowAgain
void SetInitialFocus(wxWindow *aWindow)
Sets the window (usually a wxTextCtrl) that should be focused when the dialog is shown.
void SetupStandardButtons(std::map< int, wxString > aLabels={})
KiCad uses environment variables internally for determining the base paths for libraries,...
Provide a custom wxValidator object for limiting the allowable characters when defining an environmen...
Editor for wxGrid cells that adds a file/folder browser to the grid input field.
This class works around a bug in wxGrid where the first keystroke doesn't get sent through the valida...
Add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
Add dark theme support to wxHtmlWindow.
bool SetPage(const wxString &aSource) override
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
bool DoNotShowAgain() const
Checks the 'do not show again' setting for the dialog.
void DoNotShowCheckbox(wxString file, int line)
Shows the 'do not show again' checkbox.
virtual COMMON_SETTINGS * GetCommonSettings() const
virtual ENV_VAR_MAP & GetLocalEnvVariables() const
virtual void SetLocalEnvVariables()
Update the local environment with the contents of the current ENV_VAR_MAP stored in the COMMON_SETTIN...
std::map< int, int > COL_MIN_WIDTHS
Map of column indices to minimum widths.
void OnDeleteRows(const std::function< void(int row)> &aDeleter)
Handles a row deletion event.
void OnAddRow(const std::function< std::pair< int, int >()> &aAdder)
void ClearRows()
wxWidgets recently added an ASSERT which fires if the position is greater than or equal to the number...
bool CommitPendingChanges(bool aQuietMode=false)
Close any open cell edit controls.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
Functions related to environment variables, including help functions.
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
This file is part of the common library.
KICOMMON_API wxString LookUpEnvVarHelp(const wxString &aEnvVar)
Look up long-form help text for a given environment variable.
KICOMMON_API const std::vector< wxString > & GetPredefinedEnvVars()
Get the list of pre-defined environment variables.
KICOMMON_API bool IsEnvVarImmutable(const wxString &aEnvVar)
Determine if an environment variable is "predefined", i.e.
PGM_BASE & Pgm()
The global program "get" accessor.
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
bool env_var_overwrite_warning
Custom text control validator definitions.