docs/latex/wx/sysopt.tex

   1 \section{\class{wxSystemOptions}}\label{wxsystemoptions}
   2
   3 wxSystemOptions stores option/value pairs that wxWindows 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 wxWindows:
   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 \end{twocollist}
  19
  20 The compile-time option to include or exclude this functionality
  21 is wxUSE\_SYSTEM\_OPTIONS.
  22
  23 \wxheading{Derived from}
  24
  25 \helpref{wxObject}{wxobject}
  26
  27 \wxheading{Include files}
  28
  29 <wx/sysopt.h>
  30
  31 \latexignore{\rtfignore{\wxheading{Members}}}
  32
  33 \membersection{wxSystemOptions::wxSystemOptions}
  34
  35 \func{}{wxSystemOptions}{\void}
  36
  37 Default constructor. You don't need to create an instance of wxSystemOptions
  38 since all of its functions are static.
  39
  40 \membersection{wxSystemOptions::GetOption}\label{wxsystemoptionsgetoption}
  41
  42 \constfunc{wxString}{GetOption}{\param{const wxString\&}{ name}}
  43
  44 Gets an option. The function is case-insensitive to {\it name}.
  45
  46 \wxheading{See also}
  47
  48 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
  49 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
  50 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
  51
  52 \membersection{wxSystemOptions::GetOptionInt}\label{wxsystemoptionsgetoptionint}
  53
  54 \constfunc{int}{GetOptionInt}{\param{const wxString\&}{ name}}
  55
  56 Gets an option as an integer. The function is case-insensitive to {\it name}.
  57
  58 \wxheading{See also}
  59
  60 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
  61 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
  62 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
  63
  64 \membersection{wxSystemOptions::HasOption}\label{wxsystemoptionshasoption}
  65
  66 \constfunc{bool}{HasOption}{\param{const wxString\&}{ name}}
  67
  68 Returns TRUE if the given option is present. The function is case-insensitive to {\it name}.
  69
  70 \wxheading{See also}
  71
  72 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
  73 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
  74 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint}
  75
  76 \membersection{wxSystemOptions::SetOption}\label{wxsystemoptionssetoption}
  77
  78 \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{const wxString\&}{ value}}
  79
  80 \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{int}{ value}}
  81
  82 Sets an option. The function is case-insensitive to {\it name}.
  83
  84 \wxheading{See also}
  85
  86 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
  87 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
  88 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
  89