1\section{\class{wxSystemOptions}}\label{wxsystemoptions}
2
3wxSystemOptions stores option/value pairs that wxWidgets itself or
4applications can use to alter behaviour at run-time. It can be
5used to optimize behaviour that doesn't deserve a distinct API,
6but is still important to be able to configure.
7
8These options are currently recognised by wxWidgets.
9
10\wxheading{All platforms}
11
12\twocolwidtha{7cm}
13\begin{twocollist}\itemsep=0pt
14\twocolitem{{\bf Option}}{{\bf Value}}
15\twocolitem{filesys.no-mimetypesmanager}{Set to 1 to avoid using the mime types manager in wxFileSystemHandler.
16This can cut down loading time when loading an XRC file at startup, for example.}
17\twocolitem{msw.window.no-clip-children}{If 1, windows will not automatically get the WS\_CLIPCHILDREN
18style. This restores the way windows are refreshed back to the method used in versions of wxWidgets
19earlier than 2.5.4, and for some complex window hierarchies it can reduce apparent refresh delays. You may
20still specify wxCLIP\_CHILDREN for individual windows.}
21\twocolitem{msw.notebook.themed-background}{If set to 0, globally disables themed backgrounds on notebook
22pages. Note that this won't disable the theme on the actual notebook background (noticeable only if there are no
23pages).}
24\twocolitem{msw.staticbox.optimized-paint}{If set to 0, switches off optimized wxStaticBox painting.
25Setting this to 0 causes more flicker, but allows applications to paint graphics on the parent of a static box
26(the optimized refresh causes any such drawing to disappear).}
27\twocolitem{msw.display.directdraw}{If set to 1, use DirectDraw-based implementation of
28\helpref{wxDisplay}{wxdisplay}. By default the standard Win32 functions are
29used.}
30\twocolitem{msw.font.no-proof-quality}{If set to 1, use default fonts quality
31instead of proof quality when creating fonts. With proof quality the fonts
32have slightly better appearance but not all fonts are available in this
33quality, e.g. the Terminal font in small sizes is not and this option may be
34used if wider fonts selection is more important than higher quality.}
35\end{twocollist}
36
37
38\wxheading{Windows}
39
40\twocolwidtha{7cm}
41\begin{twocollist}\itemsep=0pt
42\twocolitem{{\bf Option}}{{\bf Value}}
43\twocolitem{no-maskblt}{1 to never use WIN32's MaskBlt function, 0 to allow it to be used where possible. Default: 0.
44In some circumstances the MaskBlt function can be slower than using the fallback code, especially if using
45DC cacheing. By default, MaskBlt will be used where it is implemented by the operating system and driver.}
46\twocolitem{msw.remap}{If 1 (the default), wxToolBar bitmap colours will be remapped
47to the current theme's values. Set this to 0 to disable this functionality, for example if you're using
48more than 16 colours in your tool bitmaps.}
49\twocolitem{msw.window.no-clip-children}{If 1, windows will not automatically get the WS\_CLIPCHILDREN
50style. This restores the way windows are refreshed back to the method used in versions of wxWidgets
51earlier than 2.5.4, and for some complex window hierarchies it can reduce apparent refresh delays. You may
52still specify wxCLIP\_CHILDREN for individual windows.}
53\twocolitem{msw.notebook.themed-background}{If set to 0, globally disables themed backgrounds on notebook
54pages. Note that this won't disable the theme on the actual notebook background (noticeable only if there are no
55pages).}
56\twocolitem{msw.staticbox.optimized-paint}{If set to 0, switches off optimized wxStaticBox painting.
57Setting this to 0 causes more flicker, but allows applications to paint graphics on the parent of a static box
58(the optimized refresh causes any such drawing to disappear).}
59\twocolitem{msw.display.directdraw}{If set to 1, use DirectDraw-based implementation of
60\helpref{wxDisplay}{wxdisplay}. By default the standard Win32 functions are
61used.}
62\twocolitem{msw.font.no-proof-quality}{If set to 1, use default fonts quality
63instead of proof quality when creating fonts. With proof quality the fonts
64have slightly better appearance but not all fonts are available in this
65quality, e.g. the Terminal font in small sizes is not and this option may be
66used if wider fonts selection is more important than higher quality.}
67\end{twocollist}
68
69\wxheading{GTK+}
70
71\twocolwidtha{7cm}
72\begin{twocollist}\itemsep=0pt
73\twocolitem{{\bf Option}}{{\bf Value}}
74\twocolitem{gtk.window.force-background-colour}{If 1, the backgrounds of windows with the wxBG\_STYLE\_COLOUR background style are cleared forcibly instead
75of relying on the underlying GTK+ window colour. This works around a display problem when running applications under KDE with the gtk-qt theme installed (0.6 and below).}
76\end{twocollist}
77
78\wxheading{Mac}
79
80\twocolwidtha{7cm}
81\begin{twocollist}\itemsep=0pt
82\twocolitem{{\bf Option}}{{\bf Value}}
83\twocolitem{mac.window-plain-transition}{If 1, uses a plainer transition when showing
84a window. You can also use the symbol wxMAC\_WINDOW\_PLAIN\_TRANSITION.}
85\twocolitem{window-default-variant}{The default variant used by windows (cast to integer from the wxWindowVariant enum).
86Also known as wxWINDOW\_DEFAULT\_VARIANT.}
87\twocolitem{mac.listctrl.always\_use\_generic}{Tells wxListCtrl to use the generic 
88control even when it is capable of using the native control instead. 
89Also knwon as wxMAC\_ALWAYS\_USE\_GENERIC\_LISTCTRL.}
90\end{twocollist}
91
92\wxheading{MGL}
93
94\twocolwidtha{7cm}
95\begin{twocollist}\itemsep=0pt
96\twocolitem{{\bf Option}}{{\bf Value}}
97\twocolitem{mgl.aa-threshold}{Set this integer option to point
98size below which fonts are not antialiased. Default: 10.}
99\twocolitem{mgl.screen-refresh}{Screen refresh rate in Hz.
100A reasonable default is used if not specified.}
101\end{twocollist}
102
103\wxheading{Motif}
104
105\twocolwidtha{7cm}
106\begin{twocollist}\itemsep=0pt
107\twocolitem{{\bf Option}}{{\bf Value}}
108\twocolitem{motif.largebuttons}{If 1, uses a bigger default size for wxButtons.}
109\end{twocollist}
110
111The compile-time option to include or exclude this functionality
112is wxUSE\_SYSTEM\_OPTIONS.
113
114\wxheading{Derived from}
115
116\helpref{wxObject}{wxobject}
117
118\wxheading{Include files}
119
120<wx/sysopt.h>
121
122\latexignore{\rtfignore{\wxheading{Members}}}
123
124
125\membersection{wxSystemOptions::wxSystemOptions}\label{wxsystemoptionsctor}
126
127\func{}{wxSystemOptions}{\void}
128
129Default constructor. You don't need to create an instance of wxSystemOptions
130since all of its functions are static.
131
132
133\membersection{wxSystemOptions::GetOption}\label{wxsystemoptionsgetoption}
134
135\constfunc{wxString}{GetOption}{\param{const wxString\&}{ name}}
136
137Gets an option. The function is case-insensitive to {\it name}.
138
139Returns empty string if the option hasn't been set.
140
141\wxheading{See also}
142
143\helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
144\helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
145\helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
146
147
148\membersection{wxSystemOptions::GetOptionInt}\label{wxsystemoptionsgetoptionint}
149
150\constfunc{int}{GetOptionInt}{\param{const wxString\&}{ name}}
151
152Gets an option as an integer. The function is case-insensitive to {\it name}.
153
154If the option hasn't been set, this function returns $0$.
155
156\wxheading{See also}
157
158\helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
159\helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
160\helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
161
162
163\membersection{wxSystemOptions::HasOption}\label{wxsystemoptionshasoption}
164
165\constfunc{bool}{HasOption}{\param{const wxString\&}{ name}}
166
167Returns \true if the given option is present. The function is case-insensitive to {\it name}.
168
169\wxheading{See also}
170
171\helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
172\helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
173\helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint}
174
175
176\membersection{wxSystemOptions::IsFalse}\label{wxsystemoptionsisfalse}
177
178\constfunc{bool}{IsFalse}{\param{const wxString\&}{ name}}
179
180Returns \true if the option with the given \arg{name} had been set to $0$
181value. This is mostly useful for boolean options for which you can't use
182\texttt{GetOptionInt(name) == 0} as this would also be true if the option
183hadn't been set at all.
184
185
186\membersection{wxSystemOptions::SetOption}\label{wxsystemoptionssetoption}
187
188\func{void}{SetOption}{\param{const wxString\&}{ name}, \param{const wxString\&}{ value}}
189
190\func{void}{SetOption}{\param{const wxString\&}{ name}, \param{int}{ value}}
191
192Sets an option. The function is case-insensitive to {\it name}.
193
194\wxheading{See also}
195
196\helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
197\helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
198\helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
199
200