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 \twocolwidtha{7cm}
  11 \begin{twocollist}\itemsep=0pt
  12 \twocolitem{{\bf Option}}{{\bf Value}}
  13 \twocolitem{no-maskblt}{1 to never use WIN32's MaskBlt function, 0 to allow it to be used where possible. Default: 0.
  14
  15 In some circumstances the MaskBlt function can be slower than using the fallback code, especially if using
  16 DC cacheing. By default, MaskBlt will be used where it is implemented by the operating system and driver.
  17 }
  18 \twocolitem{msw.remap}{(wxMSW only) 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{mgl.aa-threshold}{(wxMGL only) Set this integer option to point
  22 size below which fonts are not antialiased. Default: 10.
  23 }
  24 \twocolitem{mgl.screen-refresh}{(wxMGL only) Screen refresh rate in Hz.
  25 Reasonable default is used if not specified.
  26 }
  27 \end{twocollist}
  28
  29 The compile-time option to include or exclude this functionality
  30 is wxUSE\_SYSTEM\_OPTIONS.
  31
  32 \wxheading{Derived from}
  33
  34 \helpref{wxObject}{wxobject}
  35
  36 \wxheading{Include files}
  37
  38 <wx/sysopt.h>
  39
  40 \latexignore{\rtfignore{\wxheading{Members}}}
  41
  42
  43 \membersection{wxSystemOptions::wxSystemOptions}\label{wxsystemoptionsctor}
  44
  45 \func{}{wxSystemOptions}{\void}
  46
  47 Default constructor. You don't need to create an instance of wxSystemOptions
  48 since all of its functions are static.
  49
  50
  51 \membersection{wxSystemOptions::GetOption}\label{wxsystemoptionsgetoption}
  52
  53 \constfunc{wxString}{GetOption}{\param{const wxString\&}{ name}}
  54
  55 Gets an option. The function is case-insensitive to {\it name}.
  56
  57 Returns empty string if the option hasn't been set.
  58
  59 \wxheading{See also}
  60
  61 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
  62 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
  63 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
  64
  65
  66 \membersection{wxSystemOptions::GetOptionInt}\label{wxsystemoptionsgetoptionint}
  67
  68 \constfunc{int}{GetOptionInt}{\param{const wxString\&}{ name}}
  69
  70 Gets an option as an integer. The function is case-insensitive to {\it name}.
  71
  72 If the option hasn't been set, this function returns $0$.
  73
  74 \wxheading{See also}
  75
  76 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
  77 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
  78 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
  79
  80
  81 \membersection{wxSystemOptions::HasOption}\label{wxsystemoptionshasoption}
  82
  83 \constfunc{bool}{HasOption}{\param{const wxString\&}{ name}}
  84
  85 Returns \true if the given option is present. The function is case-insensitive to {\it name}.
  86
  87 \wxheading{See also}
  88
  89 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
  90 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
  91 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint}
  92
  93
  94 \membersection{wxSystemOptions::SetOption}\label{wxsystemoptionssetoption}
  95
  96 \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{const wxString\&}{ value}}
  97
  98 \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{int}{ value}}
  99
 100 Sets an option. The function is case-insensitive to {\it name}.
 101
 102 \wxheading{See also}
 103
 104 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
 105 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
 106 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
 107