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

NAME

6       wxSystemOptions - Functions for wxSystemOptions class
7

DESCRIPTION

9       wxSystemOptions  stores option/value pairs that wxWidgets itself or ap‐
10       plications can use to alter behaviour at run-time. It can  be  used  to
11       optimize  behaviour  that  doesn't deserve a distinct API, but is still
12       important to be able to configure.
13
14       System options can be set  by  the  program  itself  using  setOption/2
15       method  and they also can be set from the program environment by defin‐
16       ing an environment variable wx_option to set the given option  for  all
17       wxWidgets  applications or wx_appname_option to set it just for the ap‐
18       plication with the given name (as returned by wxApp::GetAppName()  (not
19       implemented  in wx)). Notice that any characters not allowed in the en‐
20       vironment variables names, such as periods and dashes,  should  be  re‐
21       placed  with  underscores. E.g. to define a system option "foo-bar" you
22       need to define the environment variable "wx_foo_bar".
23
24       The program may use system options for  its  own  needs  but  they  are
25       mostly used to control the behaviour of wxWidgets library itself.
26
27       These options are currently recognised by wxWidgets:
28
29       All platforms
30
31       Windows
32
33       GTK+
34
35       Mac
36
37       Motif
38
39       The  compile-time  option  to  include or exclude this functionality is
40       wxUSE_SYSTEM_OPTIONS.
41
42       See: wxSystemSettings
43
44       wxWidgets docs: wxSystemOptions
45

DATA TYPES

47       wxSystemOptions() = wx:wx_object()
48

EXPORTS

50       getOption(Name) -> unicode:charlist()
51
52              Types:
53
54                 Name = unicode:chardata()
55
56              Gets an option.
57
58              The function is case-insensitive to name. Returns  empty  string
59              if the option hasn't been set.
60
61              See: setOption/2, getOptionInt/1, hasOption/1
62
63       getOptionInt(Name) -> integer()
64
65              Types:
66
67                 Name = unicode:chardata()
68
69              Gets an option as an integer.
70
71              The  function  is case-insensitive to name. If the option hasn't
72              been set, this function returns 0.
73
74              See: setOption/2, getOption/1, hasOption/1
75
76       hasOption(Name) -> boolean()
77
78              Types:
79
80                 Name = unicode:chardata()
81
82              Returns true if the given option is present.
83
84              The function is case-insensitive to name.
85
86              See: setOption/2, getOption/1, getOptionInt/1
87
88       isFalse(Name) -> boolean()
89
90              Types:
91
92                 Name = unicode:chardata()
93
94              Returns true if the option with the given name had been set to 0
95              value.
96
97              This  is  mostly  useful for boolean options for which you can't
98              use GetOptionInt(name) == 0 as this would also be  true  if  the
99              option hadn't been set at all.
100
101       setOption(Name, Value) -> ok
102
103       setOption(Name, Value) -> ok
104
105              Types:
106
107                 Name = Value = unicode:chardata()
108
109              Sets an option.
110
111              The function is case-insensitive to name.
112
113
114
115wxWidgets team.                    wx 2.1.4                 wxSystemOptions(3)