wx.DarkModeSettings

Allows to customize some of the settings used in MSW dark mode.

An object of this class may be passed to wx.App.MSWEnableDarkMode to customize some aspects of the dark mode when it is used under MSW systems.

For example, to customize the background colour to use a reddish black instead of normal black used by default, you could do the following:

Added in version 4.3/wxWidgets-3.3.0.

Class Hierarchy

Inheritance diagram for class DarkModeSettings:

Methods Summary

__init__	Default constructor does nothing.
GetBorderPen	Get the pen to use for drawing wx.StaticBox border in dark mode.
GetColour	Get the colour to use for the given system colour when dark mode is on.
GetMenuColour	Get the colour to use for the menu bar in the given state.

Properties Summary

BorderPen

See GetBorderPen

Class API

class wx.DarkModeSettings(object)

Possible constructors:

DarkModeSettings() -> None

Allows to customize some of the settings used in MSW dark mode.

Methods

__init__(self)

Default constructor does nothing.

Return type:

None

---

GetBorderPen(self)

Get the pen to use for drawing wx.StaticBox border in dark mode.

Returning an invalid pen indicates that the default border drawn by the system should be used, which doesn’t look very well in dark mode but shouldn’t result in any problems worse than cosmetic ones.

The base class version returns a grey pen, which looks better than the default white one.

Return type:

wx.Pen

---

GetColour(self, index)

Get the colour to use for the given system colour when dark mode is on.

The base class version of this function returns the colours commonly used in dark mode. As the rest of dark mode support, their exact values are not documented and are subject to change in the future Windows or wxWidgets versions.

Parameters:

index (SystemColour)

Return type:

wx.Colour

See also

GetMenuColour

---

GetMenuColour(self, which)

Get the colour to use for the menu bar in the given state.

Currently the colours used by the menus in the menu bar in dark mode don’t correspond to any of SystemColour values and this separate function is used for customizing them instead of GetColour .

Note that the colours returned by this function only affect the top level menus, the colours of the menu items inside them can be customized in the usual way using OwnerDrawn.SetTextColour().

The returned colour must be valid.

Parameters:

which (MenuColour)

Return type:

wx.Colour

Properties

BorderPen

See GetBorderPen