]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/sysopt.tex
Update docs to mention new filesystem handlers.
[wxWidgets.git] / docs / latex / wx / sysopt.tex
CommitLineData
0cbff120
JS
1\section{\class{wxSystemOptions}}\label{wxsystemoptions}
2
fc2171bd 3wxSystemOptions stores option/value pairs that wxWidgets itself or
0cbff120
JS
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
b0dd9c00
JS
8These options are currently recognised by wxWidgets.
9
10\wxheading{Windows}
0cbff120
JS
11
12\twocolwidtha{7cm}
13\begin{twocollist}\itemsep=0pt
14\twocolitem{{\bf Option}}{{\bf Value}}
15\twocolitem{no-maskblt}{1 to never use WIN32's MaskBlt function, 0 to allow it to be used where possible. Default: 0.
0cbff120 16In some circumstances the MaskBlt function can be slower than using the fallback code, especially if using
b0dd9c00
JS
17DC cacheing. By default, MaskBlt will be used where it is implemented by the operating system and driver.}
18\twocolitem{msw.remap}{If 1 (the default), wxToolBar bitmap colours will be remapped
6fdd4565
JS
19to the current theme's values. Set this to 0 to disable this functionality, for example if you're using
20more than 16 colours in your tool bitmaps.}
b0dd9c00
JS
21\twocolitem{msw.window.no-clip-children}{If 1, windows will not automatically get the WS\_CLIPCHILDREN
22style. This restores the way windows are refreshed back to the method used in versions of wxWidgets
23earlier than 2.5.4, and for some complex window hierarchies it can reduce apparent refresh delays. You may
24still specify wxCLIP\_CHILDREN for individual windows.}
25\twocolitem{msw.notebook.themed-background}{If set to 0, globally disables themed backgrounds on notebook
26pages. Note that this won't disable the theme on the actual notebook background (noticeable only if there are no
27pages).}
8e44f3ca
JS
28\twocolitem{msw.staticbox.optimized-paint}{If set to 0, switches off optimized wxStaticBox painting.
29Setting this to 0 causes more flicker, but allows applications to paint graphics on the parent of a static box
30(the optimized refresh causes any such drawing to disappear).}
afcc11bb
VZ
31\twocolitem{msw.display.directdraw}{If set to 1, use DirectDraw-based implementation of
32\helpref{wxDisplay}{wxdisplay}. By default the standard Win32 functions are
33used.}
b0dd9c00
JS
34\end{twocollist}
35
36\wxheading{Mac}
37
38\twocolwidtha{7cm}
39\begin{twocollist}\itemsep=0pt
40\twocolitem{{\bf Option}}{{\bf Value}}
41\twocolitem{mac.window-plain-transition}{If 1, uses a plainer transition when showing
42a window. You can also use the symbol wxMAC\_WINDOW\_PLAIN\_TRANSITION.}
43\twocolitem{window-default-variant}{The default variant used by windows (cast to integer from the wxWindowVariant enum).
44Also known as wxWINDOW\_DEFAULT\_VARIANT.}
45\end{twocollist}
46
47\wxheading{MGL}
48
49\twocolwidtha{7cm}
50\begin{twocollist}\itemsep=0pt
51\twocolitem{{\bf Option}}{{\bf Value}}
52\twocolitem{mgl.aa-threshold}{Set this integer option to point
53size below which fonts are not antialiased. Default: 10.}
54\twocolitem{mgl.screen-refresh}{Screen refresh rate in Hz.
55A reasonable default is used if not specified.}
56\end{twocollist}
57
58\wxheading{Motif}
59
60\twocolwidtha{7cm}
61\begin{twocollist}\itemsep=0pt
62\twocolitem{{\bf Option}}{{\bf Value}}
63\twocolitem{motif.largebuttons}{If 1, uses a bigger default size for wxButtons.}
0cbff120
JS
64\end{twocollist}
65
66The compile-time option to include or exclude this functionality
67is wxUSE\_SYSTEM\_OPTIONS.
68
69\wxheading{Derived from}
70
71\helpref{wxObject}{wxobject}
72
73\wxheading{Include files}
74
75<wx/sysopt.h>
76
77\latexignore{\rtfignore{\wxheading{Members}}}
78
82a16d7e 79
08f1d438 80\membersection{wxSystemOptions::wxSystemOptions}\label{wxsystemoptionsctor}
0cbff120
JS
81
82\func{}{wxSystemOptions}{\void}
83
84Default constructor. You don't need to create an instance of wxSystemOptions
85since all of its functions are static.
86
82a16d7e 87
0cbff120
JS
88\membersection{wxSystemOptions::GetOption}\label{wxsystemoptionsgetoption}
89
90\constfunc{wxString}{GetOption}{\param{const wxString\&}{ name}}
91
92Gets an option. The function is case-insensitive to {\it name}.
93
82a16d7e
VZ
94Returns empty string if the option hasn't been set.
95
0cbff120
JS
96\wxheading{See also}
97
98\helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
99\helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
100\helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
101
82a16d7e 102
0cbff120
JS
103\membersection{wxSystemOptions::GetOptionInt}\label{wxsystemoptionsgetoptionint}
104
105\constfunc{int}{GetOptionInt}{\param{const wxString\&}{ name}}
106
107Gets an option as an integer. The function is case-insensitive to {\it name}.
108
82a16d7e
VZ
109If the option hasn't been set, this function returns $0$.
110
0cbff120
JS
111\wxheading{See also}
112
113\helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
114\helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
115\helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
116
82a16d7e 117
0cbff120
JS
118\membersection{wxSystemOptions::HasOption}\label{wxsystemoptionshasoption}
119
120\constfunc{bool}{HasOption}{\param{const wxString\&}{ name}}
121
82a16d7e 122Returns \true if the given option is present. The function is case-insensitive to {\it name}.
0cbff120
JS
123
124\wxheading{See also}
125
126\helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
127\helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
128\helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint}
129
82a16d7e 130
8de6b9bb
VZ
131\membersection{wxSystemOptions::IsFalse}\label{wxsystemoptionsisfalse}
132
133\constfunc{bool}{IsFalse}{\param{const wxString\&}{ name}}
134
135Returns \true if the option with the given \arg{name} had been set to $0$
136value. This is mostly useful for boolean options for which you can't use
137\texttt{GetOptionInt(name) == 0} as this would also be true if the option
138hadn't been set at all.
139
140
0cbff120
JS
141\membersection{wxSystemOptions::SetOption}\label{wxsystemoptionssetoption}
142
143\func{void}{SetOption}{\param{const wxString\&}{ name}, \param{const wxString\&}{ value}}
144
145\func{void}{SetOption}{\param{const wxString\&}{ name}, \param{int}{ value}}
146
147Sets an option. The function is case-insensitive to {\it name}.
148
149\wxheading{See also}
150
151\helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
152\helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
153\helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
154