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 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
24#ifndef DPI_SCALING__H
25#define DPI_SCALING__H
26
27#include <wx/window.h>
28
29class COMMON_SETTINGS;
30
37{
38public:
47 DPI_SCALING( COMMON_SETTINGS* aConfig, const wxWindow* aWindow );
48
56 double GetScaleFactor() const;
57
61 bool GetCanvasIsAutoScaled() const;
62
71 void SetDpiConfig( bool aAuto, double aValue );
72
73 /*
74 * Get the maximum scaling factor that should be presented to the user.
75 * This is only advisory, it has no real technical use other than for validation.
76 */
77 static double GetMaxScaleFactor();
78
79 /*
80 * Get the minimum scaling factor that should be presented to the user.
81 * This is only advisory, it has no real technical use other than for validation.
82 */
83 static double GetMinScaleFactor();
84
88 static double GetDefaultScaleFactor();
89
90private:
96
100 const wxWindow* m_window;
101};
102
103#endif // DPI_SCALING__H
Class to handle configuration and automatic determination of the DPI scale to use for canvases.
Definition: dpi_scaling.h:37
double GetScaleFactor() const
Get the DPI scale from all known sources in order:
void SetDpiConfig(bool aAuto, double aValue)
Set the common DPI config in a given config object.
DPI_SCALING(COMMON_SETTINGS *aConfig, const wxWindow *aWindow)
Construct a DPI scale provider.
Definition: dpi_scaling.cpp:95
COMMON_SETTINGS * m_config
The configuration object to use to get/set user setting.
Definition: dpi_scaling.h:95
static double GetDefaultScaleFactor()
Get the "default" scaling factor to use if not other config is available.
const wxWindow * m_window
The WX window to use for WX's automatic DPI checking.
Definition: dpi_scaling.h:100
static double GetMaxScaleFactor()
bool GetCanvasIsAutoScaled() const
Is the current value auto scaled, or is it user-set in the config.
static double GetMinScaleFactor()