no changes, just come cleanup and more comments

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

diff --git a/docs/latex/wx/settings.tex b/docs/latex/wx/settings.tex
index 674adbc13183746cb916b7d18e4435d272d1ea9e..4a66fa7fac764dce29f86b8a1e0c597bf84d9703 100644 (file)
--- a/docs/latex/wx/settings.tex
+++ b/docs/latex/wx/settings.tex
@@ -12,6 +12,10 @@ and user interface element sizes.
 
 <wx/settings.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxFont}{wxfont}, \helpref{wxColour}{wxcolour}
@@ -97,10 +101,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:
 
@@ -115,6 +122,8 @@ supported on the current platform.
 clicks must fall to generate a double-click.}
 \twocolitem{{\bf wxSYS\_DCLICK\_Y}}{Height in pixels of rectangle within which two successive mouse
 clicks must fall to generate a double-click.}
+\twocolitem{{\bf wxSYS\_DCLICK\_MSEC}}{Maximal time, in milliseconds, which may
+pass between subsequent clicks for a double click to be generated.}
 \twocolitem{{\bf wxSYS\_DRAG\_X}}{Width in pixels of a rectangle centered on a drag point
 to allow for limited movement of the mouse pointer before a drag operation begins.}
 \twocolitem{{\bf wxSYS\_DRAG\_Y}}{Height in pixels of a rectangle centered on a drag point
@@ -152,6 +161,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}}