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