wxSystemSettings Class Reference

#include <wx/settings.h>

Detailed Description

wxSystemSettings allows the application to ask for details about the system.

This can include settings such as standard colours, fonts, and user interface element sizes.

Library:  wxCore

Category:  Application and System configuration

See also

wxFont, wxColour, wxSystemOptions

Public Member Functions
	wxSystemSettings ()
	Default constructor. More...

Static Public Member Functions
static wxColour	GetColour (wxSystemColour index)
	Returns a system colour. More...
static wxFont	GetFont (wxSystemFont index)
	Returns a system font. More...
static int	GetMetric (wxSystemMetric index, wxWindow *win=nullptr)
	Returns the value of a system metric, or -1 if the metric is not supported on the current system. More...
static wxSystemScreenType	GetScreenType ()
	Returns the screen type. More...
static wxSystemAppearance	GetAppearance ()
	Returns the object describing the current system appearance. More...
static bool	HasFeature (wxSystemFeature index)
	Returns true if the port has certain feature. More...
static wxColour	SelectLightDark (wxColour colForLight, wxColour colForDark)
	Select one of the two colours depending on whether light or dark mode is used. More...

Constructor & Destructor Documentation

wxSystemSettings()

wxSystemSettings::wxSystemSettings

(

)

Default constructor.

You don't need to create an instance of wxSystemSettings since all of its functions are static.

Member Function Documentation

GetAppearance()

static wxSystemAppearance wxSystemSettings::GetAppearance ( )

static

Returns the object describing the current system appearance.

Since

3.1.3

GetColour()

static wxColour wxSystemSettings::GetColour ( wxSystemColour  index )

static

Returns a system colour.

Parameters

index

Can be one of the wxSystemColour enum values.

Returns

The returned colour is always valid.

GetFont()

static wxFont wxSystemSettings::GetFont ( wxSystemFont  index )

static

Returns a system font.

Parameters

index

Can be one of the wxSystemFont enum values.

Returns

The returned font is always valid.

GetMetric()

static int wxSystemSettings::GetMetric ( wxSystemMetric  index, wxWindow *  win = nullptr  )

static

Returns the value of a system metric, or -1 if the metric is not supported on the current system.

The value of win determines if the metric returned is a global value or a wxWindow based value, in which case it might determine the widget, the display the window is on, or something similar. The window given should be as close to the metric as possible (e.g. a wxTopLevelWindow in case of the wxSYS_CAPTION_Y metric).

index can be one of the wxSystemMetric enum values.

win is a pointer to the window for which the metric is requested. Specifying the win parameter is encouraged, because some metrics on some ports are not supported without one, or they might be capable of reporting better values if given one. If a window does not make sense for a metric, one should still be given, as for example it might determine which displays cursor width is requested with wxSYS_CURSOR_X.

GetScreenType()

static wxSystemScreenType wxSystemSettings::GetScreenType ( )

static

Returns the screen type.

The return value is one of the wxSystemScreenType enum values.

HasFeature()

static bool wxSystemSettings::HasFeature ( wxSystemFeature  index )

static

Returns true if the port has certain feature.

See the wxSystemFeature enum values.

SelectLightDark()

static wxColour wxSystemSettings::SelectLightDark ( wxColour  colForLight, wxColour  colForDark  )

static

Select one of the two colours depending on whether light or dark mode is used.

This is just a convenient helper using wxSystemAppearance::IsDark() to select between the two colours.

Parameters

colForLight	Colour returned when using light appearance.
colForDark	Colour returned when using dark appearance, as detected by wxSystemAppearance::IsDark().

Since

3.3.0