Class to handle configuration and automatic determination of the DPI scale to use for canvases. More...

#include <dpi_scaling.h>

Public Member Functions
	DPI_SCALING (COMMON_SETTINGS aConfig, const wxWindow aWindow)
	Construct a DPI scale provider. More...

double	GetScaleFactor () const
	Get the DPI scale from all known sources in order: More...

double	GetContentScaleFactor () const
	Get the content scale factor, which may be different from the scale factor on some platforms. More...

bool	GetCanvasIsAutoScaled () const
	Is the current value auto scaled, or is it user-set in the config. More...

void	SetDpiConfig (bool aAuto, double aValue)
	Set the common DPI config in a given config object. More...

Static Public Member Functions
static double	GetMaxScaleFactor ()

static double	GetMinScaleFactor ()

static double	GetDefaultScaleFactor ()
	Get the "default" scaling factor to use if not other config is available. More...

Private Attributes
COMMON_SETTINGS *	m_config
	The configuration object to use to get/set user setting. More...

const wxWindow *	m_window
	The WX window to use for WX's automatic DPI checking. More...

Detailed Description

Class to handle configuration and automatic determination of the DPI scale to use for canvases.

This has several sources and the availability of some of them are platform dependent.

Definition at line 36 of file dpi_scaling.h.

Constructor & Destructor Documentation

◆ DPI_SCALING()

DPI_SCALING::DPI_SCALING	(	COMMON_SETTINGS *	aConfig,
		const wxWindow *	aWindow
	)

Construct a DPI scale provider.

Parameters

aConfig	the config store to check for a user value (can be nullptr, in which case on automatically determined values are considered)
aWindow	a WX window to use for automatic DPI determination

Returns: the scaling factor (1.0 = no scaling)

Definition at line 85 of file dpi_scaling.cpp.

 : m_config( aConfig ), m_window( aWindow )
{
}

Member Function Documentation

◆ GetCanvasIsAutoScaled()

bool DPI_SCALING::GetCanvasIsAutoScaled ( ) const

Is the current value auto scaled, or is it user-set in the config.

Definition at line 169 of file dpi_scaling.cpp.

{
 if( m_config == nullptr )
 {
 // No configuration given, so has to be automatic scaling
 return true;
 }
 
 const bool automatic = getKiCadConfiguredScale( *m_config ) == std::nullopt;
 wxLogTrace( traceHiDpi, wxS( "Scale is automatic: %d" ), automatic );
 return automatic;
}

References getKiCadConfiguredScale(), m_config, and traceHiDpi.

Referenced by PANEL_COMMON_SETTINGS::applySettingsToPanel().

◆ GetContentScaleFactor()

double DPI_SCALING::GetContentScaleFactor ( ) const

Get the content scale factor, which may be different from the scale factor on some platforms.

This value should be used for scaling user interface elements (fonts, icons, etc) whereas the scale factor should be used for scaling canvases.

Definition at line 130 of file dpi_scaling.cpp.

{
 std::optional<double> val;
 wxString src;
 
 if( m_config )
 {
 val = getKiCadConfiguredScale( *m_config );
 src = wxS( "config" );
 }
 
 if( !val )
 {
 val = getEnvironmentScale();
 src = wxS( "env" );
 }
 
 if( !val && m_window )
 {
 // Use the native WX reporting.
 // On Linux, this will not work until WX 3.2 and GTK >= 3.10
 // Otherwise it returns 1.0
 val = KIPLATFORM::UI::GetContentScaleFactor( m_window );
 src = wxS( "platform" );
 }
 
 if( !val )
 {
 // Nothing else we can do, give it a default value
 val = GetDefaultScaleFactor();
 src = wxS( "default" );
 }
 
 wxLogTrace( traceHiDpi, wxS( "Content scale factor (%s): %f" ), src, *val );
 
 return *val;
}

References KIPLATFORM::UI::GetContentScaleFactor(), GetDefaultScaleFactor(), getEnvironmentScale(), getKiCadConfiguredScale(), m_config, m_window, and traceHiDpi.

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), COLOR_SWATCH::COLOR_SWATCH(), GBR_LAYER_BOX_SELECTOR::Resync(), and PCB_LAYER_BOX_SELECTOR::Resync().

◆ GetDefaultScaleFactor()

double DPI_SCALING::GetDefaultScaleFactor ( )

static

Get the "default" scaling factor to use if not other config is available.

Definition at line 207 of file dpi_scaling.cpp.

{
 // no scaling => 1.0
 return 1.0;
}

Referenced by GetContentScaleFactor(), GetScaleFactor(), and PANEL_COMMON_SETTINGS::PANEL_COMMON_SETTINGS().

◆ GetMaxScaleFactor()

double DPI_SCALING::GetMaxScaleFactor ( )

static

Definition at line 193 of file dpi_scaling.cpp.

{
 // displays with higher than 4.0 DPI are not really going to be useful
 // for KiCad (even an 8k display would be effectively only ~1080p at 4x)
 return 6.0;
}

Referenced by PANEL_COMMON_SETTINGS::PANEL_COMMON_SETTINGS().

◆ GetMinScaleFactor()

double DPI_SCALING::GetMinScaleFactor ( )

static

Definition at line 201 of file dpi_scaling.cpp.

{
 // scales under 1.0 don't make sense from a HiDPI perspective
 return 1.0;
}

Referenced by PANEL_COMMON_SETTINGS::PANEL_COMMON_SETTINGS().

◆ GetScaleFactor()

double DPI_SCALING::GetScaleFactor ( ) const

Get the DPI scale from all known sources in order:

user config, if given
user's environment variables, if set and according to platform
WX's internal determination of the DPI scaling (WX > 3.1)

Definition at line 91 of file dpi_scaling.cpp.

{
 std::optional<double> val;
 wxString src;
 
 if( m_config )
 {
 val = getKiCadConfiguredScale( *m_config );
 src = wxS( "config" );
 }
 
 if( !val )
 {
 val = getEnvironmentScale();
 src = wxS( "env" );
 }
 
 if( !val && m_window )
 {
 // Use the native WX reporting.
 // On Linux, this will not work until WX 3.2 and GTK >= 3.10
 // Otherwise it returns 1.0
 val = KIPLATFORM::UI::GetPixelScaleFactor( m_window );
 src = wxS( "platform" );
 }
 
 if( !val )
 {
 // Nothing else we can do, give it a default value
 val = GetDefaultScaleFactor();
 src = wxS( "default" );
 }
 
 wxLogTrace( traceHiDpi, wxS( "Scale factor (%s): %f" ), src, *val );
 
 return *val;
}

References GetDefaultScaleFactor(), getEnvironmentScale(), getKiCadConfiguredScale(), KIPLATFORM::UI::GetPixelScaleFactor(), m_config, m_window, and traceHiDpi.

Referenced by PANEL_COMMON_SETTINGS::applySettingsToPanel(), APPEARANCE_CONTROLS::GetBestSize(), PANEL_COMMON_SETTINGS::OnCanvasScaleAuto(), LAYER_BOX_SELECTOR::ResyncBitmapOnly(), and KIGFX::GAL_DISPLAY_OPTIONS::UpdateScaleFactor().

◆ SetDpiConfig()

void DPI_SCALING::SetDpiConfig	(	bool	aAuto,
		double	aValue
	)

Set the common DPI config in a given config object.

The encoding of the automatic/manual nature of the config is handled internally.

Parameters

aAuto	store a value meaning "no user-set scale"
aValue	the value to store (ignored if aAuto set)

Definition at line 183 of file dpi_scaling.cpp.

{
 wxCHECK_RET( m_config != nullptr, wxS( "Setting DPI config without a config store." ) );
 
 const double value = aAuto ? 0.0 : aValue;
 
 m_config->m_Appearance.canvas_scale = value;
}

References COMMON_SETTINGS::APPEARANCE::canvas_scale, COMMON_SETTINGS::m_Appearance, and m_config.

Referenced by PANEL_COMMON_SETTINGS::TransferDataFromWindow().

Member Data Documentation

◆ m_config

COMMON_SETTINGS* DPI_SCALING::m_config

private

The configuration object to use to get/set user setting.

nullptr if only automatic options are wanted

Definition at line 103 of file dpi_scaling.h.

Referenced by GetCanvasIsAutoScaled(), GetContentScaleFactor(), GetScaleFactor(), and SetDpiConfig().

◆ m_window

const wxWindow* DPI_SCALING::m_window

private

The WX window to use for WX's automatic DPI checking.

Definition at line 108 of file dpi_scaling.h.

Referenced by GetContentScaleFactor(), and GetScaleFactor().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DPI_SCALING()

Member Function Documentation

◆ GetCanvasIsAutoScaled()

◆ GetContentScaleFactor()

◆ GetDefaultScaleFactor()

◆ GetMaxScaleFactor()

◆ GetMinScaleFactor()

◆ GetScaleFactor()

◆ SetDpiConfig()

Member Data Documentation

◆ m_config

◆ m_window