KiCad PCB EDA Suite
dpi_scaling.h
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) 2019 KiCad Developers, see CHANGELOG.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 
24 #ifndef DPI_SCALING__H
25 #define DPI_SCALING__H
26 
27 #include <wx/config.h>
28 #include <wx/window.h>
29 
36 {
37 public:
46  DPI_SCALING( wxConfigBase* aConfig, const wxWindow* aWindow );
47 
55  double GetScaleFactor() const;
56 
60  bool GetCanvasIsAutoScaled() const;
61 
70  void SetDpiConfig( bool aAuto, double aValue );
71 
72  /*
73  * Get the maximum scaling factor that should be presented to the user.
74  * This is only advisory, it has no real technical use other than for validation.
75  */
76  static double GetMaxScaleFactor();
77 
78  /*
79  * Get the minimum scaling factor that should be presented to the user.
80  * This is only advisory, it has no real technical use other than for validation.
81  */
82  static double GetMinScaleFactor();
83 
87  static double GetDefaultScaleFactor();
88 
89 private:
94  wxConfigBase* m_config;
95 
99  const wxWindow* m_window;
100 };
101 
102 #endif // DPI_SCALING__H
static double GetDefaultScaleFactor()
Get the "default" scaling factor to use if not other config is available.
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:35
void SetDpiConfig(bool aAuto, double aValue)
Set the common DPI config in a given config object.
static double GetMaxScaleFactor()
DPI_SCALING(wxConfigBase *aConfig, const wxWindow *aWindow)
Construct a DPI scale provider.
Definition: dpi_scaling.cpp:96
static double GetMinScaleFactor()
const wxWindow * m_window
The WX window to use for WX's automatic DPI checking.
Definition: dpi_scaling.h:99
wxConfigBase * m_config
The configuration object to use to get/set user setting.
Definition: dpi_scaling.h:94
bool GetCanvasIsAutoScaled() const
Is the current value auto scaled, or is it user-set in the config.