]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/sysopt.tex
Missing wxWindow member, manual decorations to pure text list of changes.
[wxWidgets.git] / docs / latex / wx / sysopt.tex
index 346c437b3b55b926c809cee31bd5527171ad30f7..d1a067dfa50ca8f4e6022dc6dcbe99e716f5e1a7 100644 (file)
@@ -1,11 +1,11 @@
 \section{\class{wxSystemOptions}}\label{wxsystemoptions}
 
-wxSystemOptions stores option/value pairs that wxWindows itself or
+wxSystemOptions stores option/value pairs that wxWidgets itself or
 applications can use to alter behaviour at run-time. It can be
 used to optimize behaviour that doesn't deserve a distinct API,
 but is still important to be able to configure.
 
-These options are currently recognised by wxWindows:
+These options are currently recognised by wxWidgets:
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
@@ -18,7 +18,7 @@ DC cacheing. By default, MaskBlt will be used where it is implemented by the ope
 \twocolitem{mgl.aa-threshold}{(wxMGL only) Set this integer option to point
 size below which fonts are not antialiased. Default: 10.
 }
-\twocolitem{mgl.aa-threshold}{(wxMGL only) Screen refresh rate in Hz.
+\twocolitem{mgl.screen-refresh}{(wxMGL only) Screen refresh rate in Hz.
 Reasonable default is used if not specified.
 }
 \end{twocollist}
@@ -36,42 +36,50 @@ is wxUSE\_SYSTEM\_OPTIONS.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxSystemOptions::wxSystemOptions}
+
+\membersection{wxSystemOptions::wxSystemOptions}\label{wxsystemoptionsctor}
 
 \func{}{wxSystemOptions}{\void}
 
 Default constructor. You don't need to create an instance of wxSystemOptions
 since all of its functions are static.
 
+
 \membersection{wxSystemOptions::GetOption}\label{wxsystemoptionsgetoption}
 
 \constfunc{wxString}{GetOption}{\param{const wxString\&}{ name}}
 
 Gets an option. The function is case-insensitive to {\it name}.
 
+Returns empty string if the option hasn't been set.
+
 \wxheading{See also}
 
 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
 
+
 \membersection{wxSystemOptions::GetOptionInt}\label{wxsystemoptionsgetoptionint}
 
 \constfunc{int}{GetOptionInt}{\param{const wxString\&}{ name}}
 
 Gets an option as an integer. The function is case-insensitive to {\it name}.
 
+If the option hasn't been set, this function returns $0$.
+
 \wxheading{See also}
 
 \helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
 \helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}
 
+
 \membersection{wxSystemOptions::HasOption}\label{wxsystemoptionshasoption}
 
 \constfunc{bool}{HasOption}{\param{const wxString\&}{ name}}
 
-Returns true if the given option is present. The function is case-insensitive to {\it name}.
+Returns \true if the given option is present. The function is case-insensitive to {\it name}.
 
 \wxheading{See also}
 
@@ -79,6 +87,7 @@ Returns true if the given option is present. The function is case-insensitive to
 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint}
 
+
 \membersection{wxSystemOptions::SetOption}\label{wxsystemoptionssetoption}
 
 \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{const wxString\&}{ value}}