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