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.xp-tab-ok}{(wxMSW under Windows XP or later only) Some versions
  19 of Windows XP don't render \helpref{wxNotebook}{wxnotebook} controls with tabs
  20 not on the top of it correctly, so wxWidgets by default always uses
  21 \texttt{wxTOP} style under XP. If you are sure that this problem will not be
  22 present on your users machines, set this option to a non zero value to enable
  23 tabs with non default orientation.}
  24 \twocolitem{mgl.aa-threshold}{(wxMGL only) Set this integer option to point
  25 size below which fonts are not antialiased. Default: 10.
  26 }
  27 \twocolitem{mgl.screen-refresh}{(wxMGL only) Screen refresh rate in Hz.
  28 Reasonable default is used if not specified.
  29 }
  30 \end{twocollist}
  31
  32 The compile-time option to include or exclude this functionality
  33 is wxUSE\_SYSTEM\_OPTIONS.
  34
  35 \wxheading{Derived from}
  36
  37 \helpref{wxObject}{wxobject}
  38
  39 \wxheading{Include files}
  40
  41 <wx/sysopt.h>
  42
  43 \latexignore{\rtfignore{\wxheading{Members}}}
  44
  45
  46 \membersection{wxSystemOptions::wxSystemOptions}\label{wxsystemoptionsctor}
  47
  48 \func{}{wxSystemOptions}{\void}
  49
  50 Default constructor. You don't need to create an instance of wxSystemOptions
  51 since all of its functions are static.
  52
  53
  54 \membersection{wxSystemOptions::GetOption}\label{wxsystemoptionsgetoption}
  55
  56 \constfunc{wxString}{GetOption}{\param{const wxString\&}{ name}}
  57
  58 Gets an option. The function is case-insensitive to {\it name}.
  59
  60 Returns empty string if the option hasn't been set.
  61
  62 \wxheading{See also}
  63
  64 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
  65 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
  66 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
  67
  68
  69 \membersection{wxSystemOptions::GetOptionInt}\label{wxsystemoptionsgetoptionint}
  70
  71 \constfunc{int}{GetOptionInt}{\param{const wxString\&}{ name}}
  72
  73 Gets an option as an integer. The function is case-insensitive to {\it name}.
  74
  75 If the option hasn't been set, this function returns $0$.
  76
  77 \wxheading{See also}
  78
  79 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
  80 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
  81 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
  82
  83
  84 \membersection{wxSystemOptions::HasOption}\label{wxsystemoptionshasoption}
  85
  86 \constfunc{bool}{HasOption}{\param{const wxString\&}{ name}}
  87
  88 Returns \true if the given option is present. The function is case-insensitive to {\it name}.
  89
  90 \wxheading{See also}
  91
  92 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
  93 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
  94 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint}
  95
  96
  97 \membersection{wxSystemOptions::SetOption}\label{wxsystemoptionssetoption}
  98
  99 \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{const wxString\&}{ value}}
 100
 101 \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{int}{ value}}
 102
 103 Sets an option. The function is case-insensitive to {\it name}.
 104
 105 \wxheading{See also}
 106
 107 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
 108 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
 109 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
 110