X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dbfb85a7658eb8e6443191c852ac5d39e38d17cf..fd52f2552593cffab61c8b126119fb5e0be47e38:/docs/latex/wx/settings.tex

diff --git a/docs/latex/wx/settings.tex b/docs/latex/wx/settings.tex
index f030a46b6b..3f290a8a30 100644
--- a/docs/latex/wx/settings.tex
+++ b/docs/latex/wx/settings.tex
@@ -97,10 +97,13 @@ standalone function named {\tt wxSystemSettings\_GetFont}}
 
 \membersection{wxSystemSettings::GetMetric}\label{wxsystemsettingsgetmetric}
 
-\func{static int}{GetMetric}{\param{wxSystemMetric}{ index}}
+\func{static int}{GetMetric}{\param{wxSystemMetric}{ index}, \param{wxWindow*}{ win = NULL}}
 
-Returns the value of a system metric, or -1 if the metric is not
-supported on the current platform.
+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:
 
@@ -152,6 +155,12 @@ 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\_GetMetric}}
 
@@ -163,10 +172,10 @@ 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}
+\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}