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 \twocolitem{gtk.desktopmargin.x}{The horizontal margin to subtract from the desktop size when Xinerama is not available.}
  57 \twocolitem{gtk.desktopmargin.y}{The vertical margin to subtract from the desktop size when Xinerama is not available.}
  58 \end{twocollist}
  59
  60 \wxheading{Mac}
  61
  62 \twocolwidtha{7cm}
  63 \begin{twocollist}\itemsep=0pt
  64 \twocolitem{{\bf Option}}{{\bf Value}}
  65 \twocolitem{mac.window-plain-transition}{If 1, uses a plainer transition when showing
  66 a window. You can also use the symbol wxMAC\_WINDOW\_PLAIN\_TRANSITION.}
  67 \twocolitem{window-default-variant}{The default variant used by windows (cast to integer from the wxWindowVariant enum).
  68 Also known as wxWINDOW\_DEFAULT\_VARIANT.}
  69 \twocolitem{mac.listctrl.always\_use\_generic}{Tells wxListCtrl to use the generic
  70 control even when it is capable of using the native control instead.
  71 Also knwon as wxMAC\_ALWAYS\_USE\_GENERIC\_LISTCTRL.}
  72 \end{twocollist}
  73
  74 \wxheading{MGL}
  75
  76 \twocolwidtha{7cm}
  77 \begin{twocollist}\itemsep=0pt
  78 \twocolitem{{\bf Option}}{{\bf Value}}
  79 \twocolitem{mgl.aa-threshold}{Set this integer option to point
  80 size below which fonts are not antialiased. Default: 10.}
  81 \twocolitem{mgl.screen-refresh}{Screen refresh rate in Hz.
  82 A reasonable default is used if not specified.}
  83 \end{twocollist}
  84
  85 \wxheading{Motif}
  86
  87 \twocolwidtha{7cm}
  88 \begin{twocollist}\itemsep=0pt
  89 \twocolitem{{\bf Option}}{{\bf Value}}
  90 \twocolitem{motif.largebuttons}{If 1, uses a bigger default size for wxButtons.}
  91 \end{twocollist}
  92
  93 The compile-time option to include or exclude this functionality
  94 is wxUSE\_SYSTEM\_OPTIONS.
  95
  96 \wxheading{Derived from}
  97
  98 \helpref{wxObject}{wxobject}
  99
 100 \wxheading{Include files}
 101
 102 <wx/sysopt.h>
 103
 104 \latexignore{\rtfignore{\wxheading{Members}}}
 105
 106
 107 \membersection{wxSystemOptions::wxSystemOptions}\label{wxsystemoptionsctor}
 108
 109 \func{}{wxSystemOptions}{\void}
 110
 111 Default constructor. You don't need to create an instance of wxSystemOptions
 112 since all of its functions are static.
 113
 114
 115 \membersection{wxSystemOptions::GetOption}\label{wxsystemoptionsgetoption}
 116
 117 \constfunc{wxString}{GetOption}{\param{const wxString\&}{ name}}
 118
 119 Gets an option. The function is case-insensitive to {\it name}.
 120
 121 Returns empty string if the option hasn't been set.
 122
 123 \wxheading{See also}
 124
 125 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
 126 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
 127 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
 128
 129
 130 \membersection{wxSystemOptions::GetOptionInt}\label{wxsystemoptionsgetoptionint}
 131
 132 \constfunc{int}{GetOptionInt}{\param{const wxString\&}{ name}}
 133
 134 Gets an option as an integer. The function is case-insensitive to {\it name}.
 135
 136 If the option hasn't been set, this function returns $0$.
 137
 138 \wxheading{See also}
 139
 140 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
 141 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
 142 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
 143
 144
 145 \membersection{wxSystemOptions::HasOption}\label{wxsystemoptionshasoption}
 146
 147 \constfunc{bool}{HasOption}{\param{const wxString\&}{ name}}
 148
 149 Returns \true if the given option is present. The function is case-insensitive to {\it name}.
 150
 151 \wxheading{See also}
 152
 153 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
 154 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
 155 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint}
 156
 157
 158 \membersection{wxSystemOptions::IsFalse}\label{wxsystemoptionsisfalse}
 159
 160 \constfunc{bool}{IsFalse}{\param{const wxString\&}{ name}}
 161
 162 Returns \true if the option with the given \arg{name} had been set to $0$
 163 value. This is mostly useful for boolean options for which you can't use
 164 \texttt{GetOptionInt(name) == 0} as this would also be true if the option
 165 hadn't been set at all.
 166
 167
 168 \membersection{wxSystemOptions::SetOption}\label{wxsystemoptionssetoption}
 169
 170 \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{const wxString\&}{ value}}
 171
 172 \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{int}{ value}}
 173
 174 Sets an option. The function is case-insensitive to {\it name}.
 175
 176 \wxheading{See also}
 177
 178 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
 179 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
 180 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
 181