phoenix_title wx.SystemAppearance

Provides information about the current system appearance.

An object of this class can be retrieved using wx.SystemSettings.GetAppearance and can then be queried for some aspects of the current system appearance, notably whether the system is using a dark theme, i.e. a theme with predominantly dark background.

This is useful for custom controls that don’t use the standard system colours, as they need to adjust the colours used for drawing them to fit in the system look.

New in version 4.1/wxWidgets-3.1.3.


class_hierarchy Class Hierarchy

Inheritance diagram for class SystemAppearance:

method_summary Methods Summary

GetName

Return the name if available or empty string otherwise.

IsDark

Return True if the current system there is explicitly recognized as being a dark theme or if the default window background is dark.

IsUsingDarkBackground

Return True if the default window background is significantly darker than foreground.


property_summary Properties Summary

Name

See GetName


api Class API

class wx.SystemAppearance(object)

Provides information about the current system appearance.


Methods

GetName(self)

Return the name if available or empty string otherwise.

This is currently only implemented for macOS 10.9 or later and returns a not necessarily user-readable string such as “NSAppearanceNameAqua” there and an empty string under all the other platforms.

Return type

string



IsDark(self)

Return True if the current system there is explicitly recognized as being a dark theme or if the default window background is dark.

This method should be used to check whether custom colours more appropriate for the default (light) or dark appearance should be used.

Return type

bool



IsUsingDarkBackground(self)

Return True if the default window background is significantly darker than foreground.

This is used by IsDark if there is no platform-specific way to determine whether a dark mode is being used and is generally not very useful to call directly.

Return type

bool


Properties

Name

See GetName