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