added wxWindow::IsVisible() method

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

diff --git a/docs/latex/wx/settings.tex b/docs/latex/wx/settings.tex
index 2882173e624566f81cad0ac95d33a4ef8bb258ea..3f290a8a30f9c6f123a21dec4841db3941e44f89 100644 (file)
--- a/docs/latex/wx/settings.tex
+++ b/docs/latex/wx/settings.tex
@@ -18,16 +18,16 @@ and user interface element sizes.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxSystemSettings::wxSystemSettings}
+\membersection{wxSystemSettings::wxSystemSettings}\label{wxsystemsettingsctor}
 
 \func{}{wxSystemSettings}{\void}
 
 Default constructor. You don't need to create an instance of wxSystemSettings
 since all of its functions are static.
 
-\membersection{wxSystemSettings::GetSystemColour}\label{wxsystemsettingsgetsystemcolour}
+\membersection{wxSystemSettings::GetColour}\label{wxsystemsettingsgetcolour}
 
-\func{static wxColour}{GetSystemColour}{\param{int}{ index}}
+\func{static wxColour}{GetColour}{\param{wxSystemColour}{ index}}
 
 Returns a system colour.
 
@@ -56,7 +56,7 @@ Returns a system colour.
 \twocolitem{{\bf wxSYS\_COLOUR\_BTNTEXT}}{Text on push buttons.}
 \twocolitem{{\bf wxSYS\_COLOUR\_INACTIVECAPTIONTEXT}}{Colour of text in active captions.}
 \twocolitem{{\bf wxSYS\_COLOUR\_BTNHIGHLIGHT}}{Highlight colour for buttons (same as wxSYS\_COLOUR\_3DHILIGHT).}
-\twocolitem{{\bf wxSYS\_COLOUR\_3DDKSHADOW}}{Dark shadow for three-dimensional dispaly elements.}
+\twocolitem{{\bf wxSYS\_COLOUR\_3DDKSHADOW}}{Dark shadow for three-dimensional display elements.}
 \twocolitem{{\bf wxSYS\_COLOUR\_3DLIGHT}}{Light colour for three-dimensional display elements.}
 \twocolitem{{\bf wxSYS\_COLOUR\_INFOTEXT}}{Text colour for tooltip controls.}
 \twocolitem{{\bf wxSYS\_COLOUR\_INFOBK}}{Background colour for tooltip controls.}
@@ -69,11 +69,11 @@ Returns a system colour.
 \end{twocollist}
 
 \pythonnote{This static method is implemented in Python as a
-standalone function named \tt{wxSystemSettings_GetSystemColour}}
+standalone function named {\tt wxSystemSettings\_GetColour}}
 
-\membersection{wxSystemSettings::GetSystemFont}\label{wxsystemsettingsgetsystemfont}
+\membersection{wxSystemSettings::GetFont}\label{wxsystemsettingsgetfont}
 
-\func{static wxFont}{GetSystemFont}{\param{int}{ index}}
+\func{static wxFont}{GetFont}{\param{wxSystemFont}{ index}}
 
 Returns a system font.
 
@@ -86,18 +86,24 @@ Returns a system font.
 \twocolitem{{\bf wxSYS\_ANSI\_VAR\_FONT}}{Windows variable-pitch (proportional) font.}
 \twocolitem{{\bf wxSYS\_SYSTEM\_FONT}}{System font.}
 \twocolitem{{\bf wxSYS\_DEVICE\_DEFAULT\_FONT}}{Device-dependent font (Windows NT only).}
-\twocolitem{{\bf wxSYS\_DEFAULT\_GUI\_FONT}}{Default font for user interface objects such as menus and dialog boxes.
-Not available in versions of Windows earlier than Windows 95 or Windows NT 4.0.}
+\twocolitem{{\bf wxSYS\_DEFAULT\_GUI\_FONT}}{Default font for user interface
+objects such as menus and dialog boxes. Note that with modern GUIs nothing
+guarantees that the same font is used for all GUI elements, so some controls
+might use a different font by default.}
 \end{twocollist}
 
 \pythonnote{This static method is implemented in Python as a
-standalone function named \tt{wxSystemSettings_GetSystemFont}}
+standalone function named {\tt wxSystemSettings\_GetFont}}
 
-\membersection{wxSystemSettings::GetSystemMetric}\label{wxsystemsettingsgetsystemmetric}
+\membersection{wxSystemSettings::GetMetric}\label{wxsystemsettingsgetmetric}
 
-\func{static int}{GetSystemMetric}{\param{int}{ index}}
+\func{static int}{GetMetric}{\param{wxSystemMetric}{ index}, \param{wxWindow*}{ win = NULL}}
 
-Returns a system metric.
+Returns the value of a system metric, or -1 if the metric is not supported on the current system.
+The value of {\it win} determines if the metric returned is a global value or
+a \helpref{wxWindow}{wxwindow} based value, in which case it might determine the widget, the
+display the window is on, or something similar. The window given should be as close to the
+metric as possible (e.g a wxTopLevelWindow in case of the wxSYS\_CAPTION\_Y metric).
 
 {\it index} can be one of:
 
@@ -149,6 +155,27 @@ where it would otherwise present the information only in audible form; zero othe
 \twocolitem{{\bf wxSYS\_SWAP\_BUTTONS}}{Non-zero if the meanings of the left and right mouse buttons are swapped; zero otherwise.}
 \end{twocollist}
 
+{\it win} is a pointer to the window for which the metric is requested.
+Specifying the {\it win} parameter is encouraged, because some metrics on some ports are not supported without one,
+or they might be capable of reporting better values if given one. If a window does not make sense for a metric,
+one should still be given, as for example it might determine which displays cursor width is requested with
+wxSYS\_CURSOR\_X.
+
 \pythonnote{This static method is implemented in Python as a
-standalone function named \tt{wxSystemSettings_GetSystemMetric}}
+standalone function named {\tt wxSystemSettings\_GetMetric}}
+
+\membersection{wxSystemSettings::GetScreenType}\label{wxsystemsettingsgetscreentype}
+
+\func{static wxSystemScreenType}{GetScreenType}{\void}
+
+Returns the screen type. The return value is one of:
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxSYS\_SCREEN\_NONE}}{Undefined screen type}
+\twocolitem{{\bf wxSYS\_SCREEN\_TINY}}{Tiny screen, less than 320x240}
+\twocolitem{{\bf wxSYS\_SCREEN\_PDA}}{PDA screen, 320x240 or more but less than 640x480}
+\twocolitem{{\bf wxSYS\_SCREEN\_SMALL}}{Small screen, 640x480 or more but less than 800x600}
+\twocolitem{{\bf wxSYS\_SCREEN\_DESKTOP}}{Desktop screen, 800x600 or more}
+\end{twocollist}