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.staticbitmap.htclient}{If set to 1, allows the static bitmap to respond to mouse
  29 events. The default is 0, since a value of 1 can interfere with refresh in static boxes. Note that once set,
  30 this option cannot be unset later in the application.}
  31 \twocolitem{msw.staticbox.optimized-paint}{If set to 0, switches off optimized wxStaticBox painting.
  32 Setting this to 0 causes more flicker, but allows applications to paint graphics on the parent of a static box
  33 (the optimized refresh causes any such drawing to disappear).}
  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
  42 a 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).
  44 Also 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
  53 size below which fonts are not antialiased. Default: 10.}
  54 \twocolitem{mgl.screen-refresh}{Screen refresh rate in Hz.
  55 A 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.}
  64 \end{twocollist}
  65
  66 The compile-time option to include or exclude this functionality
  67 is 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
  79
  80 \membersection{wxSystemOptions::wxSystemOptions}\label{wxsystemoptionsctor}
  81
  82 \func{}{wxSystemOptions}{\void}
  83
  84 Default constructor. You don't need to create an instance of wxSystemOptions
  85 since all of its functions are static.
  86
  87
  88 \membersection{wxSystemOptions::GetOption}\label{wxsystemoptionsgetoption}
  89
  90 \constfunc{wxString}{GetOption}{\param{const wxString\&}{ name}}
  91
  92 Gets an option. The function is case-insensitive to {\it name}.
  93
  94 Returns empty string if the option hasn't been set.
  95
  96 \wxheading{See also}
  97
  98 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
  99 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
 100 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
 101
 102
 103 \membersection{wxSystemOptions::GetOptionInt}\label{wxsystemoptionsgetoptionint}
 104
 105 \constfunc{int}{GetOptionInt}{\param{const wxString\&}{ name}}
 106
 107 Gets an option as an integer. The function is case-insensitive to {\it name}.
 108
 109 If the option hasn't been set, this function returns $0$.
 110
 111 \wxheading{See also}
 112
 113 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
 114 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
 115 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
 116
 117
 118 \membersection{wxSystemOptions::HasOption}\label{wxsystemoptionshasoption}
 119
 120 \constfunc{bool}{HasOption}{\param{const wxString\&}{ name}}
 121
 122 Returns \true if the given option is present. The function is case-insensitive to {\it name}.
 123
 124 \wxheading{See also}
 125
 126 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
 127 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
 128 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint}
 129
 130
 131 \membersection{wxSystemOptions::IsFalse}\label{wxsystemoptionsisfalse}
 132
 133 \constfunc{bool}{IsFalse}{\param{const wxString\&}{ name}}
 134
 135 Returns \true if the option with the given \arg{name} had been set to $0$
 136 value. 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
 138 hadn't been set at all.
 139
 140
 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
 147 Sets 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