Doc clarifications

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@20496 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex
index 6e52405916dd1c9f0bdde60ad50c3b8be31f64b7..c5fee6e53e32bf7cd1c1ff6560c5b18fa5eb78f3 100644 (file)
--- a/docs/latex/wx/colour.tex
+++ b/docs/latex/wx/colour.tex
@@ -7,6 +7,8 @@ named colour may be returned instead of creating a new colour.
 
 Valid RGB values are in the range 0 to 255.
 
+You can retrieve the current system colour settings with \helpref{wxSystemSettings}{wxsystemsettings}.
+
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
@@ -34,7 +36,7 @@ wxLIGHT\_GREY}
 \wxheading{See also}
 
 \helpref{wxColourDatabase}{wxcolourdatabase}, \helpref{wxPen}{wxpen}, \helpref{wxBrush}{wxbrush},\rtfsp
-\helpref{wxColourDialog}{wxcolourdialog}
+\helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxSystemSettings}{wxsystemsettings}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

diff --git a/docs/latex/wx/font.tex b/docs/latex/wx/font.tex
index df1fa98279ec3b23279987e4f8ec9b345b0a54d3..014c8b680b0af04fbf1b8670f14788242448a3d4 100644 (file)
--- a/docs/latex/wx/font.tex
+++ b/docs/latex/wx/font.tex
@@ -4,6 +4,10 @@ A font is an object which determines the appearance of text. Fonts are
 used for drawing text to a device context, and setting the appearance of
 a window's text.
 
+You can retrieve the current system font settings with \helpref{wxSystemSettings}{wxsystemsettings}.
+
+\helpref{wxSystemSettings}{wxsystemsettings}
+
 \wxheading{Derived from}
 
 \helpref{wxGDIObject}{wxgdiobject}\\
@@ -118,7 +122,7 @@ wxSWISS\_FONT}
 
 \helpref{wxFont overview}{wxfontoverview}, \helpref{wxDC::SetFont}{wxdcsetfont},\rtfsp
 \helpref{wxDC::DrawText}{wxdcdrawtext}, \helpref{wxDC::GetTextExtent}{wxdcgettextextent},\rtfsp
-\helpref{wxFontDialog}{wxfontdialog}
+\helpref{wxFontDialog}{wxfontdialog}, \helpref{wxSystemSettings}{wxsystemsettings}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

diff --git a/docs/latex/wx/keyevent.tex b/docs/latex/wx/keyevent.tex
index daaafb0258ce2195154c96b7185706a294f49c1c..e2b47c7fb8017efa47bdc069c01afa82b84fe168 100644 (file)
--- a/docs/latex/wx/keyevent.tex
+++ b/docs/latex/wx/keyevent.tex
@@ -170,13 +170,13 @@ platform-dependent and should only be used in advanced applications.
 
 \constfunc{long}{GetX}{\void}
 
-Returns the X position of the event.
+Returns the X position (in client coordinates) of the event.
 
 \membersection{wxKeyEvent::GetY}
 
 \constfunc{long}{GetY}{\void}
 
-Returns the Y position of the event.
+Returns the Y (in client coordinates) position of the event.
 
 \membersection{wxKeyEvent::MetaDown}
 
@@ -190,7 +190,7 @@ Returns true if the Meta key was down at the time of the key event.
 
 \constfunc{void}{GetPosition}{\param{long *}{x}, \param{long *}{y}}
 
-Obtains the position at which the key was pressed.
+Obtains the position (in client coordinates) at which the key was pressed.
 
 \membersection{wxKeyEvent::HasModifiers}
 

diff --git a/docs/latex/wx/listitem.tex b/docs/latex/wx/listitem.tex
index 1d8d7137921e25b72fc0ef45365a1abd5b5a9942..6ff8dc618d93f648021ed4179090162d61c0ee73 100644 (file)
--- a/docs/latex/wx/listitem.tex
+++ b/docs/latex/wx/listitem.tex
@@ -169,8 +169,7 @@ into the image list.
 
 \func{void}{SetMask}{\param{long }{mask}}
 
-Sets the mask of valid fields. See
-\helpref{wxListItem::SetMask}{wxlistitemsetmask}.
+Sets the mask of valid fields. See \helpref{wxListItem::GetMask}{wxlistitemgetmask}.
 
 \membersection{wxListItem::SetState}\label{wxlistitemsetstate}
 

diff --git a/docs/latex/wx/valtext.tex b/docs/latex/wx/valtext.tex
index 0928570119ab582f62c8cc0d10c86c9993f6d106..ff425a63f9b44614e905512d109e2a46fd68e6d0 100644 (file)
--- a/docs/latex/wx/valtext.tex
+++ b/docs/latex/wx/valtext.tex
@@ -43,13 +43,17 @@ Constructor, taking a style and optional pointer to a wxString variable.
 \twocolitem{{\bf wxFILTER\_ALPHANUMERIC}}{Non-alphanumeric characters are filtered out.}
 \twocolitem{{\bf wxFILTER\_NUMERIC}}{Non-numeric characters are filtered out.}
 \twocolitem{{\bf wxFILTER\_INCLUDE\_LIST}}{Use an include list. The validator
-checks if the user input is on the list, complaining if not.}
+checks if the user input is on the list, complaining if not. See 
+\helpref{wxTextValidator::SetIncludeList}{wxtextvalidatorsetincludelist}.}
 \twocolitem{{\bf wxFILTER\_EXCLUDE\_LIST}}{Use an exclude list. The validator
-checks if the user input is on the list, complaining if it is.}
+checks if the user input is on the list, complaining if it is. See 
+\helpref{wxTextValidator::SetExcludeList}{wxtextvalidatorsetexcludelist}.}
 \twocolitem{{\bf wxFILTER\_INCLUDE\_CHAR\_LIST}}{Use an include list. The validator
-checks if each input character is in the list (one character per list element), complaining if not.}
+checks if each input character is in the list (one character per list element), complaining if not.
+See \helpref{wxTextValidator::SetIncludeList}{wxtextvalidatorsetincludelist}.}
 \twocolitem{{\bf wxFILTER\_EXCLUDE\_CHAR\_LIST}}{Use an include list. The validator
-checks if each input character is in the list (one character per list element), complaining if it is.}
+checks if each input character is in the list (one character per list element), complaining if it is.
+See \helpref{wxTextValidator::SetExcludeList}{wxtextvalidatorsetexcludelist}.}
 \end{twocollist}
 }
 

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index b78c4eb1dddff29f55659769b501ab8df241c192..be1eff42af94ac8e2304f0b1a40f1bd5eb39100f 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -975,6 +975,12 @@ Gets the window's title. Applicable only to frames and dialogs.
 
 \helpref{wxWindow::SetTitle}{wxwindowsettitle}
 
+\membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip}
+
+\constfunc{wxToolTip*}{GetToolTip}{\void}
+
+Get the associated tooltip or NULL if none.
+
 \membersection{wxWindow::GetUpdateRegion}\label{wxwindowgetupdateregion}
 
 \constfunc{virtual wxRegion}{GetUpdateRegion}{\void}
@@ -2592,15 +2598,7 @@ create a new validator of this type.
 Attach a tooltip to the window.
 
 See also: \helpref{GetToolTip}{wxwindowgettooltip},
-          \helpref{wxToolTip}{wxtooltip}
-
-
-\membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip}
-
-\constfunc{wxToolTip*}{GetToolTip}{\void}
-
-Get the associated tooltip or NULL if none.
-
+ \helpref{wxToolTip}{wxtooltip}
 
 \membersection{wxWindow::SetVirtualSize}\label{wxwindowsetvirtualsize}
 
@@ -2610,7 +2608,6 @@ Get the associated tooltip or NULL if none.
 
 Sets the virtual size of the window in pixels.
 
-
 \membersection{wxWindow::SetVirtualSizeHints}\label{wxwindowsetvirtualsizehints}
 
 \func{virtual void}{SetVirtualSizeHints}{\param{int}{ minW},\param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}}

diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex
index 063ab26142903fbf3dea82c6a8bf6b70f73f1984..6ec4de849fa8c324dd392434c7ed10e2dc1cf93d 100644 (file)
--- a/docs/latex/wx/wxstring.tex
+++ b/docs/latex/wx/wxstring.tex
@@ -644,6 +644,8 @@ Returns a reference to the character at position {\it n}.
 \func{wxChar*}{GetWriteBuf}{\param{size\_t}{ len}}
 
 Returns a writable buffer of at least {\it len} bytes.
+It returns a pointer to a new memory block, and the
+existing data will not be copied.
 
 Call \helpref{wxString::UngetWriteBuf}{wxstringungetwritebuf} as soon as possible
 to put the string back into a reasonable state.