wxSystemSettings(3erl)

💖 NAME 💖

okay so this is wxSystemSettings — literally Functions for wxSystemSettings class — and the manual name is wxSystemSettings(3erl) from the Erlang Module Definition manual. bestie, we're in the right place 💅

🌸 DESCRIPTION 🌸

wxSystemSettings allows the application to ask for details about the system. No cap. This can include settings such as standard colours, fonts, and user interface element sizes. 💖

• See: wxFont, wx_color(), wxSystemOptions
• wxWidgets docs: wxSystemSettings

🎀 DATA TYPES 🎀

One data type, and it's giving object-wrapper realness:

wxSystemSettings() = wx:wx_object()

💅 EXPORTS 💅

These are the exports, bestie — every single one, periodt. 👑

getColour(Index) -> wx:wx_colour4()

Types:

• Index = wx:wx_enum()

Returns a system colour. Return: the returned colour is always valid. 🎀

getFont(Index) -> wxFont:wxFont()

Types:

• Index = wx:wx_enum()

Returns a system font. Return: the returned font is always valid. 🦋

getMetric(Index) -> integer()

Types:

• Index = wx:wx_enum()

Types check, bestie — that's the whole clause right there. ✨

getMetric(Index, Options :: [Option]) -> integer()

Types:

• Index = wx:wx_enum()
• Option = {win, wxWindow:wxWindow()}

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 display's cursor width is requested with wxSYS_CURSOR_X. 🔥

getScreenType() -> wx:wx_enum()

Returns the screen type. The return value is one of the ?wxSystemScreenType enum values. 🌈

---

Big periodt energy to the wxWidgets team — this page is from wx 2.2.2.1, and the footer has no separate date, so we're not inventing one, bestie. Original page name: wxSystemSettings(3erl). 💅🎀