KiCad PCB EDA Suite
panel_common_settings.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2018-2021 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
25 
26 #include <advanced_config.h>
27 #include <bitmaps.h>
28 #include <dialog_shim.h>
29 #include <gal/dpi_scaling.h>
30 #include <kiface_base.h>
31 #include <pgm_base.h>
32 #include <id.h>
35 #include <widgets/stepped_slider.h>
36 #include <wx/filedlg.h>
37 
38 /*
39  * What follows is a whole lot of ugly to handle various platform GUI deficiences with respect
40  * to light/dark mode, DPI scaling, and other foibles.
41  *
42  * Ugly as it all is, it does improve our usability on various platforms.
43  */
44 
46  : PANEL_COMMON_SETTINGS_BASE( aParent ),
47  m_dialog( aDialog ),
48  m_iconScaleLabel( nullptr ),
49  m_iconScaleSlider( nullptr ),
50  m_iconScaleAuto( nullptr ),
51  m_last_scale( -1 )
52 {
53  /*
54  * Cairo canvas doesn't work on Mac, so no need for fallback anti-aliasing options
55  */
56 #ifdef __WXMAC__
57  m_antialiasingFallback->Show( false );
58  m_antialiasingFallbackLabel->Show( false );
59 #endif
60 
63 
64  /*
65  * Automatic dark mode detection works fine on Mac, so no need for the explicit options.
66  */
67 #ifdef __WXMAC__
68  m_stIconTheme->Show( false );
69  m_rbIconThemeLight->Show( false );
70  m_rbIconThemeDark->Show( false );
71  m_rbIconThemeAuto->Show( false );
72 #endif
73 
74  /*
75  * Automatic icon scaling works fine on Mac. It works mostly fine on MSW, but perhaps not
76  * uniformly enough to exclude the explicit controls there.
77  */
78 #if defined( __WXGTK__ ) || defined( __WXMSW__ )
79  // Sadly wxSlider is poorly implemented and adds its legends as sibiling windows (so that
80  // showing/hiding the control doesn't work). So we have to create it conditionally.
81  wxWindow* parent = m_sbUserInterface->GetStaticBox();
82  wxGridBagSizer* gb = m_gbUserInterface;
83 
84  m_iconScaleLabel = new wxStaticText( parent, wxID_ANY, _( "Icon scale:" ) );
85  m_iconScaleLabel->Wrap( -1 );
86  gb->Add( m_iconScaleLabel, wxGBPosition( 2, 0 ), wxGBSpan( 1, 1 ), wxALIGN_CENTER_VERTICAL, 5 );
87 
88  m_iconScaleSlider = new STEPPED_SLIDER( parent, wxID_ANY, 100, 50, 275, wxDefaultPosition,
89  wxDefaultSize, wxSL_HORIZONTAL|wxSL_VALUE_LABEL );
91  gb->Add( m_iconScaleSlider, wxGBPosition( 2, 1 ), wxGBSpan( 1, 2 ), wxEXPAND|wxBOTTOM, 5 );
92 
93  m_iconScaleAuto = new wxCheckBox( parent, wxID_ANY, _( "Automatic" ) );
94  gb->Add( m_iconScaleAuto, wxGBPosition( 2, 3 ), wxGBSpan( 1, 1 ), wxALIGN_CENTER_VERTICAL|wxLEFT, 15 );
95 #endif
96 
97  /*
98  * Automatic canvas scaling works fine on Mac and MSW, and on GTK under wxWidgets 3.1 or
99  * better.
100  */
101 #if defined( __WXGTK__ ) && !wxCHECK_VERSION( 3, 1, 0 )
102  static constexpr int dpi_scaling_precision = 1;
103  static constexpr double dpi_scaling_increment = 0.5;
104 
107  m_canvasScaleCtrl->SetDigits( dpi_scaling_precision );
108  m_canvasScaleCtrl->SetIncrement( dpi_scaling_increment );
110 
111  m_canvasScaleCtrl->SetToolTip(
112  _( "Set the scale for the canvas."
113  "\n\n"
114  "On high-DPI displays on some platforms, KiCad cannot determine the "
115  "scaling factor. In this case you may need to set this to a value to "
116  "match your system's DPI scaling. 2.0 is a common value. "
117  "\n\n"
118  "If this does not match the system DPI scaling, the canvas will "
119  "not match the window size and cursor position." ) );
120 
121  m_canvasScaleAuto->SetToolTip(
122  _( "Use an automatic value for the canvas scale."
123  "\n\n"
124  "On some platforms, the automatic value is incorrect and should be "
125  "set manually." ) );
126 #else
127  m_staticTextCanvasScale->Show( false );
128  m_canvasScaleCtrl->Show( false );
129  m_canvasScaleCtrl = nullptr;
130  m_canvasScaleAuto->Show( false );
131 #endif
132 
133  /*
134  * Font scaling hacks are only needed on GTK under wxWidgets 3.0.
135  */
136 #if defined( __WXGTK__ ) && !wxCHECK_VERSION( 3, 1, 0 )
137  m_fontScalingHelp->SetFont( KIUI::GetInfoFont( this ).Italic() );
138 #else
139  m_scaleFonts->Show( false );
140  m_fontScalingHelp->Show( false );
141 #endif
142 
143  if( m_iconScaleSlider )
144  {
145  m_iconScaleSlider->Connect( wxEVT_SCROLL_TOP,
146  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
147  nullptr, this );
148  m_iconScaleSlider->Connect( wxEVT_SCROLL_BOTTOM,
149  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
150  nullptr, this );
151  m_iconScaleSlider->Connect( wxEVT_SCROLL_LINEUP,
152  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
153  nullptr, this );
154  m_iconScaleSlider->Connect( wxEVT_SCROLL_LINEDOWN,
155  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
156  nullptr, this );
157  m_iconScaleSlider->Connect( wxEVT_SCROLL_PAGEUP,
158  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
159  nullptr, this );
160  m_iconScaleSlider->Connect( wxEVT_SCROLL_PAGEDOWN,
161  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
162  nullptr, this );
163  m_iconScaleSlider->Connect( wxEVT_SCROLL_THUMBTRACK,
164  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
165  nullptr, this );
166  m_iconScaleSlider->Connect( wxEVT_SCROLL_THUMBRELEASE,
167  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
168  nullptr, this );
169  m_iconScaleSlider->Connect( wxEVT_SCROLL_CHANGED,
170  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
171  nullptr, this );
172  m_iconScaleAuto->Connect( wxEVT_COMMAND_CHECKBOX_CLICKED,
173  wxCommandEventHandler( PANEL_COMMON_SETTINGS::OnIconScaleAuto ),
174  nullptr, this );
175  }
176 
177  if( m_canvasScaleCtrl )
178  {
179  m_canvasScaleCtrl->Connect( wxEVT_COMMAND_TEXT_UPDATED,
180  wxCommandEventHandler( PANEL_COMMON_SETTINGS::OnCanvasScaleChange ),
181  nullptr, this );
182  }
183 }
184 
185 
187 {
188  if( m_iconScaleSlider )
189  {
190  m_iconScaleSlider->Disconnect( wxEVT_SCROLL_TOP,
191  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
192  nullptr, this );
193  m_iconScaleSlider->Disconnect( wxEVT_SCROLL_BOTTOM,
194  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
195  nullptr, this );
196  m_iconScaleSlider->Disconnect( wxEVT_SCROLL_LINEUP,
197  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
198  nullptr, this );
199  m_iconScaleSlider->Disconnect( wxEVT_SCROLL_LINEDOWN,
200  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
201  nullptr, this );
202  m_iconScaleSlider->Disconnect( wxEVT_SCROLL_PAGEUP,
203  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
204  nullptr, this );
205  m_iconScaleSlider->Disconnect( wxEVT_SCROLL_PAGEDOWN,
206  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
207  nullptr, this );
208  m_iconScaleSlider->Disconnect( wxEVT_SCROLL_THUMBTRACK,
209  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
210  nullptr, this );
211  m_iconScaleSlider->Disconnect( wxEVT_SCROLL_THUMBRELEASE,
212  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
213  nullptr, this );
214  m_iconScaleSlider->Disconnect( wxEVT_SCROLL_CHANGED,
215  wxScrollEventHandler( PANEL_COMMON_SETTINGS::OnScaleSlider ),
216  nullptr, this );
217  m_iconScaleAuto->Disconnect( wxEVT_COMMAND_CHECKBOX_CLICKED,
218  wxCommandEventHandler( PANEL_COMMON_SETTINGS::OnIconScaleAuto ),
219  nullptr, this );
220  }
221 
222  if( m_canvasScaleCtrl )
223  {
224  m_canvasScaleCtrl->Disconnect( wxEVT_COMMAND_TEXT_UPDATED,
225  wxCommandEventHandler( PANEL_COMMON_SETTINGS::OnCanvasScaleChange ),
226  nullptr, this );
227  }
228 }
229 
230 
232 {
233  COMMON_SETTINGS* commonSettings = Pgm().GetCommonSettings();
234 
235  applySettingsToPanel( *commonSettings );
236 
237  // TODO(JE) Move these into COMMON_SETTINGS probably
238  m_textEditorPath->SetValue( Pgm().GetTextEditor( false ) );
239  m_defaultPDFViewer->SetValue( Pgm().UseSystemPdfBrowser() );
240  m_otherPDFViewer->SetValue( !Pgm().UseSystemPdfBrowser() );
241  m_PDFViewerPath->SetValue( Pgm().GetPdfBrowserName() );
242 
243  return true;
244 }
245 
246 
248 {
249  COMMON_SETTINGS* commonSettings = Pgm().GetCommonSettings();
250 
251  commonSettings->m_System.autosave_interval = m_SaveTime->GetValue() * 60;
252  commonSettings->m_System.file_history_size = m_fileHistorySize->GetValue();
253  commonSettings->m_System.clear_3d_cache_interval = m_Clear3DCacheFilesOlder->GetValue();
254 
255  commonSettings->m_Graphics.opengl_aa_mode = m_antialiasing->GetSelection();
256  commonSettings->m_Graphics.cairo_aa_mode = m_antialiasingFallback->GetSelection();
257 
258  if( m_iconScaleSlider )
259  {
260  int scale_fourths = m_iconScaleAuto->GetValue() ? -1 : m_iconScaleSlider->GetValue() / 25;
261  commonSettings->m_Appearance.icon_scale = scale_fourths;
262  }
263 
264  if( m_canvasScaleCtrl )
265  {
266  DPI_SCALING dpi( commonSettings, this );
267  dpi.SetDpiConfig( m_canvasScaleAuto->GetValue(), m_canvasScaleCtrl->GetValue() );
268  }
269 
270  if( m_rbIconThemeLight->GetValue() )
271  commonSettings->m_Appearance.icon_theme = ICON_THEME::LIGHT;
272  else if( m_rbIconThemeDark->GetValue() )
273  commonSettings->m_Appearance.icon_theme = ICON_THEME::DARK;
274  else if( m_rbIconThemeAuto->GetValue() )
275  commonSettings->m_Appearance.icon_theme = ICON_THEME::AUTO;
276 
277  commonSettings->m_Appearance.use_icons_in_menus = m_checkBoxIconsInMenus->GetValue();
278  commonSettings->m_Appearance.apply_icon_scale_to_fonts = m_scaleFonts->GetValue();
279 
280  commonSettings->m_Input.immediate_actions = !m_NonImmediateActions->GetValue();
281  commonSettings->m_Input.warp_mouse_on_move = m_warpMouseOnMove->GetValue();
282 
283  commonSettings->m_Backup.enabled = m_cbBackupEnabled->GetValue();
284  commonSettings->m_Backup.backup_on_autosave = m_cbBackupAutosave->GetValue();
285  commonSettings->m_Backup.limit_total_files = m_backupLimitTotalFiles->GetValue();
286  commonSettings->m_Backup.limit_daily_files = m_backupLimitDailyFiles->GetValue();
287  commonSettings->m_Backup.min_interval = m_backupMinInterval->GetValue() * 60;
288  commonSettings->m_Backup.limit_total_size = m_backupLimitTotalSize->GetValue() * 1024 * 1024;
289 
290  commonSettings->m_Session.remember_open_files = m_cbRememberOpenFiles->GetValue();
291 
292  Pgm().SetTextEditor( m_textEditorPath->GetValue());
293 
294  Pgm().SetPdfBrowserName( m_PDFViewerPath->GetValue() );
295  Pgm().ForceSystemPdfBrowser( m_defaultPDFViewer->GetValue() );
296  Pgm().WritePdfBrowserInfos();
297 
298  Pgm().GetSettingsManager().Save( commonSettings );
299 
300  return true;
301 }
302 
303 
305 {
306  COMMON_SETTINGS defaultSettings;
307 
308  defaultSettings.ResetToDefaults();
309 
310  applySettingsToPanel( defaultSettings );
311 
312  // TODO(JE) Move these into COMMON_SETTINGS probably
313  m_textEditorPath->SetValue( defaultSettings.m_System.text_editor );
314  m_defaultPDFViewer->SetValue( defaultSettings.m_System.use_system_pdf_viewer );
315  m_otherPDFViewer->SetValue( !defaultSettings.m_System.use_system_pdf_viewer );
316  m_PDFViewerPath->SetValue( defaultSettings.m_System.pdf_viewer_name );
317 }
318 
319 
321 {
322  int timevalue = aSettings.m_System.autosave_interval;
323  wxString msg;
324 
325  msg << timevalue / 60;
326  m_SaveTime->SetValue( msg );
327 
328  m_fileHistorySize->SetValue( aSettings.m_System.file_history_size );
329 
330  m_antialiasing->SetSelection( aSettings.m_Graphics.opengl_aa_mode );
331  m_antialiasingFallback->SetSelection( aSettings.m_Graphics.cairo_aa_mode );
332 
334 
335  if( m_iconScaleSlider )
336  {
337  int icon_scale_fourths = aSettings.m_Appearance.icon_scale;
338 
339  if( icon_scale_fourths <= 0 )
340  {
341  m_iconScaleAuto->SetValue( true );
342  m_iconScaleSlider->SetValue( 25 * KiIconScale( GetParent() ) );
343  }
344  else
345  {
346  m_iconScaleAuto->SetValue( false );
347  m_iconScaleSlider->SetValue( icon_scale_fourths * 25 );
348  }
349  }
350 
351  if( m_canvasScaleCtrl )
352  {
353  const DPI_SCALING dpi( &aSettings, this );
354  m_canvasScaleCtrl->SetValue( dpi.GetScaleFactor() );
355  m_canvasScaleAuto->SetValue( dpi.GetCanvasIsAutoScaled() );
356  }
357 
358  switch( aSettings.m_Appearance.icon_theme )
359  {
360  case ICON_THEME::LIGHT: m_rbIconThemeLight->SetValue( true ); break;
361  case ICON_THEME::DARK: m_rbIconThemeDark->SetValue( true ); break;
362  case ICON_THEME::AUTO: m_rbIconThemeAuto->SetValue( true ); break;
363  }
364 
366  m_scaleFonts->SetValue( aSettings.m_Appearance.apply_icon_scale_to_fonts );
367 
368  m_warpMouseOnMove->SetValue( aSettings.m_Input.warp_mouse_on_move );
369  m_NonImmediateActions->SetValue( !aSettings.m_Input.immediate_actions );
370 
371  m_cbRememberOpenFiles->SetValue( aSettings.m_Session.remember_open_files );
372 
373  m_cbBackupEnabled->SetValue( aSettings.m_Backup.enabled );
374  m_cbBackupAutosave->SetValue( aSettings.m_Backup.backup_on_autosave );
375  m_backupLimitTotalFiles->SetValue( aSettings.m_Backup.limit_total_files );
376  m_backupLimitDailyFiles->SetValue( aSettings.m_Backup.limit_daily_files );
377  m_backupMinInterval->SetValue( aSettings.m_Backup.min_interval / 60 );
378  m_backupLimitTotalSize->SetValue( aSettings.m_Backup.limit_total_size / ( 1024 * 1024 ) );
379 }
380 
381 
382 void PANEL_COMMON_SETTINGS::OnScaleSlider( wxScrollEvent& aEvent )
383 {
384  m_iconScaleAuto->SetValue( false );
385  aEvent.Skip();
386 }
387 
388 
389 void PANEL_COMMON_SETTINGS::OnIconScaleAuto( wxCommandEvent& aEvent )
390 {
391  if( m_iconScaleSlider )
392  {
393  if( m_iconScaleAuto->GetValue() )
394  {
395  m_last_scale = m_iconScaleAuto->GetValue();
396  m_iconScaleSlider->SetValue( 25 * KiIconScale( GetParent() ) );
397  }
398  else
399  {
400  if( m_last_scale >= 0 )
401  m_iconScaleSlider->SetValue( m_last_scale );
402  }
403  }
404 }
405 
406 
407 void PANEL_COMMON_SETTINGS::OnCanvasScaleChange( wxCommandEvent& aEvent )
408 {
409  m_canvasScaleAuto->SetValue( false );
410 }
411 
412 
413 void PANEL_COMMON_SETTINGS::OnCanvasScaleAuto( wxCommandEvent& aEvent )
414 {
415  const bool automatic = m_canvasScaleAuto->GetValue();
416 
417  if( automatic && m_canvasScaleCtrl )
418  {
419  // set the scale to the auto value, without consulting the config
420  DPI_SCALING dpi( nullptr, this );
421 
422  // update the field (no events sent)
423  m_canvasScaleCtrl->SetValue( dpi.GetScaleFactor() );
424  }
425 }
426 
427 
428 void PANEL_COMMON_SETTINGS::OnTextEditorClick( wxCommandEvent& event )
429 {
430  // Ask the user to select a new editor, but suggest the current one as the default.
431  wxString editorname = Pgm().AskUserForPreferredEditor( m_textEditorPath->GetValue() );
432 
433  // If we have a new editor name request it to be copied to m_text_editor and saved
434  // to the preferences file. If the user cancelled the dialog then the previous
435  // value will be retained.
436  if( !editorname.IsEmpty() )
437  m_textEditorPath->SetValue( editorname );
438 }
439 
440 
441 void PANEL_COMMON_SETTINGS::OnPDFViewerClick( wxCommandEvent& event )
442 {
443  wxString mask( wxT( "*" ) );
444 
445 #ifdef __WINDOWS__
446  mask += wxT( ".exe" );
447 #endif
448 
449  wxString wildcard = _( "Executable files (" ) + mask + wxT( ")|" ) + mask;
450 
451  Pgm().ReadPdfBrowserInfos();
452  wxFileName fn = Pgm().GetPdfBrowserName();
453 
454  wxFileDialog dlg( this, _( "Select Preferred PDF Viewer" ), fn.GetPath(), fn.GetFullPath(),
455  wildcard, wxFD_OPEN | wxFD_FILE_MUST_EXIST );
456 
457  if( dlg.ShowModal() == wxID_CANCEL )
458  return;
459 
460  m_otherPDFViewer->SetValue( true );
461  m_PDFViewerPath->SetValue( dlg.GetPath() );
462 }
463 
464 
465 void PANEL_COMMON_SETTINGS::onUpdateUIPdfPath( wxUpdateUIEvent& event )
466 {
467  // Used by both the m_pdfViewerBtn and m_PDFViewerPath
468  event.Enable( m_otherPDFViewer->GetValue() );
469 }
void ResetToDefaults()
Resets all parameters to default values.
void ResetPanel() override
Reset the contents of this panel.
unsigned long long limit_total_size
Maximum total size of backups (bytes), 0 for unlimited.
void OnScaleSlider(wxScrollEvent &aEvent)
void OnCanvasScaleChange(wxCommandEvent &aEvent)
Event fired when the canvas scale field is modified.
int KiIconScale(wxWindow *aWindow)
Return the automatic scale factor that would be used for a given window by KiScaledBitmap and KiScale...
Definition: bitmap.cpp:122
bool enabled
Automatically back up the project when files are saved.
wxFont GetInfoFont(wxWindow *aWindow)
Definition: ui_common.cpp:144
AUTO_BACKUP m_Backup
void OnPDFViewerClick(wxCommandEvent &event) override
APPEARANCE m_Appearance
Dialog helper object to sit in the inheritance tree between wxDialog and any class written by wxFormB...
Definition: dialog_shim.h:82
static double GetDefaultScaleFactor()
Get the "default" scaling factor to use if not other config is available.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
Class PANEL_COMMON_SETTINGS_BASE.
double GetScaleFactor() const
Get the DPI scale from all known sources in order:
Class to handle configuration and automatic determination of the DPI scale to use for canvases.
Definition: dpi_scaling.h:36
bool TransferDataFromWindow() override
void OnTextEditorClick(wxCommandEvent &event) override
void SetDpiConfig(bool aAuto, double aValue)
Set the common DPI config in a given config object.
void applySettingsToPanel(COMMON_SETTINGS &aSettings)
static double GetMaxScaleFactor()
static double GetMinScaleFactor()
#define _(s)
void onUpdateUIPdfPath(wxUpdateUIEvent &event) override
void OnIconScaleAuto(wxCommandEvent &aEvent)
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
int m_last_scale
saved icon scale when Auto selected
int min_interval
Minimum time, in seconds, between subsequent backups.
see class PGM_BASE
Customized wxSlider with forced stepping.
void OnCanvasScaleAuto(wxCommandEvent &aEvent) override
Event fired when the canvas auto-scale option is changed.
bool TransferDataToWindow() override
bool backup_on_autosave
Trigger a backup on autosave.
PANEL_COMMON_SETTINGS(DIALOG_SHIM *aDialog, wxWindow *aParent)
int limit_daily_files
Maximum files to keep per day, 0 for unlimited.
void SetStep(int aSize)
Set the step size.
STEPPED_SLIDER * m_iconScaleSlider
int limit_total_files
Maximum number of backup archives to retain.
bool GetCanvasIsAutoScaled() const
Is the current value auto scaled, or is it user-set in the config.