1wxSystemSettings(3)        Erlang Module Definition        wxSystemSettings(3)
2
3
4

NAME

6       wxSystemSettings - Functions for wxSystemSettings class
7

DESCRIPTION

9       wxSystemSettings  allows  the  application to ask for details about the
10       system.
11
12       This can include settings such as standard colours, fonts, and user in‐
13       terface element sizes.
14
15       See: wxFont, wx_color(), wxSystemOptions
16
17       wxWidgets docs: wxSystemSettings
18

DATA TYPES

20       wxSystemSettings() = wx:wx_object()
21

EXPORTS

23       getColour(Index) -> wx:wx_colour4()
24
25              Types:
26
27                 Index = wx:wx_enum()
28
29              Returns a system colour.
30
31              Return: The returned colour is always valid.
32
33       getFont(Index) -> wxFont:wxFont()
34
35              Types:
36
37                 Index = wx:wx_enum()
38
39              Returns a system font.
40
41              Return: The returned font is always valid.
42
43       getMetric(Index) -> integer()
44
45              Types:
46
47                 Index = wx:wx_enum()
48
49       getMetric(Index, Options :: [Option]) -> integer()
50
51              Types:
52
53                 Index = wx:wx_enum()
54                 Option = {win, wxWindow:wxWindow()}
55
56              Returns the value of a system metric, or -1 if the metric is not
57              supported on the current system.
58
59              The value of win determines if the metric returned is  a  global
60              value  or  a wxWindow based value, in which case it might deter‐
61              mine the widget, the display the window is on, or something sim‐
62              ilar.  The window given should be as close to the metric as pos‐
63              sible (e.g. a wxTopLevelWindow in case  of  the  wxSYS_CAPTION_Y
64              metric).
65
66              index can be one of the ?wxSystemMetric enum values.
67
68              win  is  a  pointer  to  the  window for which the metric is re‐
69              quested. Specifying the win  parameter  is  encouraged,  because
70              some metrics on some ports are not supported without one,or they
71              might be capable of reporting better values if given one.  If  a
72              window  does  not  make  sense for a metric, one should still be
73              given, as for example it might determine which  displays  cursor
74              width is requested with wxSYS_CURSOR_X.
75
76       getScreenType() -> wx:wx_enum()
77
78              Returns the screen type.
79
80              The return value is one of the ?wxSystemScreenType enum values.
81
82
83
84wxWidgets team.                     wx 2.1                 wxSystemSettings(3)