docs/latex/wx/sysopt.tex

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