wxColour source cleaning. Corrections to 'const unsigned char' within wxColour docs.

[wxWidgets.git] / docs / latex / wx / sysopt.tex

diff --git a/docs/latex/wx/sysopt.tex b/docs/latex/wx/sysopt.tex
index 346c437b3b55b926c809cee31bd5527171ad30f7..6f9d54436d63d5f1ffd9c616e9427f16412cfef9 100644 (file)
--- a/docs/latex/wx/sysopt.tex
+++ b/docs/latex/wx/sysopt.tex
@@ -1,26 +1,63 @@
 \section{\class{wxSystemOptions}}\label{wxsystemoptions}
 
 \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.
 
 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.
+
+\wxheading{Windows}

 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf Option}}{{\bf Value}}
 \twocolitem{no-maskblt}{1 to never use WIN32's MaskBlt function, 0 to allow it to be used where possible. Default: 0.
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf Option}}{{\bf Value}}
 \twocolitem{no-maskblt}{1 to never use WIN32's MaskBlt function, 0 to allow it to be used where possible. Default: 0.

-

 In some circumstances the MaskBlt function can be slower than using the fallback code, especially if using
 In some circumstances the MaskBlt function can be slower than using the fallback code, especially if using

-DC cacheing. By default, MaskBlt will be used where it is implemented by the operating system and driver.
-}
-\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.
-Reasonable default is used if not specified.
-}
+DC cacheing. By default, MaskBlt will be used where it is implemented by the operating system and driver.}
+\twocolitem{msw.remap}{If 1 (the default), wxToolBar bitmap colours will be remapped
+to the current theme's values. Set this to 0 to disable this functionality, for example if you're using
+more than 16 colours in your tool bitmaps.}
+\twocolitem{msw.window.no-clip-children}{If 1, windows will not automatically get the WS\_CLIPCHILDREN
+style. This restores the way windows are refreshed back to the method used in versions of wxWidgets
+earlier than 2.5.4, and for some complex window hierarchies it can reduce apparent refresh delays. You may
+still specify wxCLIP\_CHILDREN for individual windows.}
+\twocolitem{msw.notebook.themed-background}{If set to 0, globally disables themed backgrounds on notebook
+pages. Note that this won't disable the theme on the actual notebook background (noticeable only if there are no
+pages).}
+\twocolitem{msw.staticbox.optimized-paint}{If set to 0, switches off optimized wxStaticBox painting.
+Setting this to 0 causes more flicker, but allows applications to paint graphics on the parent of a static box
+(the optimized refresh causes any such drawing to disappear).}
+\end{twocollist}
+
+\wxheading{Mac}
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf Option}}{{\bf Value}}
+\twocolitem{mac.window-plain-transition}{If 1, uses a plainer transition when showing
+a window. You can also use the symbol wxMAC\_WINDOW\_PLAIN\_TRANSITION.}
+\twocolitem{window-default-variant}{The default variant used by windows (cast to integer from the wxWindowVariant enum).
+Also known as wxWINDOW\_DEFAULT\_VARIANT.}
+\end{twocollist}
+
+\wxheading{MGL}
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf Option}}{{\bf Value}}
+\twocolitem{mgl.aa-threshold}{Set this integer option to point
+size below which fonts are not antialiased. Default: 10.}
+\twocolitem{mgl.screen-refresh}{Screen refresh rate in Hz.
+A reasonable default is used if not specified.}
+\end{twocollist}
+
+\wxheading{Motif}
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf Option}}{{\bf Value}}
+\twocolitem{motif.largebuttons}{If 1, uses a bigger default size for wxButtons.}

 \end{twocollist}
 
 The compile-time option to include or exclude this functionality
 \end{twocollist}
 
 The compile-time option to include or exclude this functionality


@@ -36,42 +73,50 @@ is wxUSE\_SYSTEM\_OPTIONS.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \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.
 
 
 \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}.
 
 \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}
 
 \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}.
 
 \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}
 
 \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}}
 
 \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}
 
 
 \wxheading{See also}
 


@@ -79,6 +124,17 @@ Returns true if the given option is present. The function is case-insensitive to
 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint}
 
 \helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
 \helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint}
 

+
+\membersection{wxSystemOptions::IsFalse}\label{wxsystemoptionsisfalse}
+
+\constfunc{bool}{IsFalse}{\param{const wxString\&}{ name}}
+
+Returns \true if the option with the given \arg{name} had been set to $0$
+value. This is mostly useful for boolean options for which you can't use
+\texttt{GetOptionInt(name) == 0} as this would also be true if the option
+hadn't been set at all.
+
+

 \membersection{wxSystemOptions::SetOption}\label{wxsystemoptionssetoption}
 
 \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{const wxString\&}{ value}}
 \membersection{wxSystemOptions::SetOption}\label{wxsystemoptionssetoption}
 
 \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{const wxString\&}{ value}}