Missing wxWindow member, manual decorations to pure text list of changes.

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

\section{\class{wxSystemOptions}}\label{wxsystemoptions}

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 wxWidgets:

\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
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.screen-refresh}{(wxMGL only) Screen refresh rate in Hz.
Reasonable default is used if not specified.
}
\end{twocollist}

The compile-time option to include or exclude this functionality
is wxUSE\_SYSTEM\_OPTIONS.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/sysopt.h>

\latexignore{\rtfignore{\wxheading{Members}}}


\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}.

\wxheading{See also}

\helpref{wxSystemOptions::SetOption}{wxsystemoptionssetoption},\rtfsp
\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}}

\func{void}{SetOption}{\param{const wxString\&}{ name}, \param{int}{ value}}

Sets an option. The function is case-insensitive to {\it name}.

\wxheading{See also}

\helpref{wxSystemOptions::GetOption}{wxsystemoptionsgetoption},\rtfsp
\helpref{wxSystemOptions::GetOptionInt}{wxsystemoptionsgetoptionint},\rtfsp
\helpref{wxSystemOptions::HasOption}{wxsystemoptionshasoption}