From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Mon, 28 Aug 2006 10:05:23 +0000 (+0000)
Subject: document maxLenght and rectBounds ctor parameters; minor cleanup (use \arg, \NULL)
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/2511d95968a7e947d898f90e58a79f92fc8ee570?hp=7106497983220393044f3e74d6eccd9e8ee7b576

document maxLenght and rectBounds ctor parameters; minor cleanup (use \arg, \NULL)


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

diff --git a/docs/latex/wx/tipwin.tex b/docs/latex/wx/tipwin.tex
index f88dd8d04f..55278ced2d 100644
--- a/docs/latex/wx/tipwin.tex
+++ b/docs/latex/wx/tipwin.tex
@@ -22,37 +22,43 @@ wxPopupWindow\\
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxTipWindow::wxTipWindow}\label{wxtipwindowwxtipwindow}
 
-\func{}{wxTipWindow}{\param{wxWindow* }{parent}, \param{const wxString\& }{text}, \param{wxCoord }{maxLength = 100}, \param{wxTipWindow** }{windowPtr}}
+\func{}{wxTipWindow}{\param{wxWindow* }{parent}, \param{const wxString\& }{text}, \param{wxCoord }{maxLength = 100}, \param{wxTipWindow** }{windowPtr}, \param{wxRect *}{rectBounds = \NULL}}
 
-Constructor. The tip is shown immediately the window is constructed.
+Constructor. The tip is shown immediately after the window is constructed.
 
 \wxheading{Parameters}
 
-\docparam{parent}{The parent window, must be non-{\tt NULL}}
+\docparam{parent}{The parent window, must be non-\NULL}
 
 \docparam{text}{The text to show, may contain the new line characters}
 
+\docparam{maxLength}{The length of each line, in pixels. Set to a very large
+value to avoid wrapping lines}
+
 \docparam{windowPtr}{Simply passed to 
 \helpref{SetTipWindowPtr}{wxtipwindowsettipwindowptr} below, please see its
 documentation for the description of this parameter}
 
-\docparam{rectBounds}{If non-{\tt NULL}, passed to 
+\docparam{rectBounds}{If non-\NULL, passed to 
 \helpref{SetBoundingRect}{wxtipwindowsetboundingrect} below, please see its
 documentation for the description of this parameter}
 
 
+
 \membersection{wxTipWindow::SetTipWindowPtr}\label{wxtipwindowsettipwindowptr}
 
 \func{void}{SetTipWindowPtr}{\param{wxTipWindow** }{windowPtr}}
 
 When the tip window closes itself (which may happen at any moment and
-unexpectedly to the caller) it may {\tt NULL} out the pointer pointed to by 
-{\it windowPtr}. This is helpful to avoid dereferencing the tip window which
+unexpectedly to the caller) it may \NULL out the pointer pointed to by 
+\arg{it windowPtr}. This is helpful to avoid dereferencing the tip window which
 had been already closed and deleted.
 
 
+
 \membersection{wxTipWindow::SetBoundingRect}\label{wxtipwindowsetboundingrect}
 
 \func{void}{SetBoundingRect}{\param{const wxRect\& }{rectBound}}
@@ -61,7 +67,7 @@ By default, the tip window disappears when the user clicks the mouse or presses
 a keyboard key or if it loses focus in any other way - for example because the
 user switched to another application window.
 
-Additionally, if a non-empty {\it rectBound} is provided, the tip window will
+Additionally, if a non-empty \arg{rectBound} is provided, the tip window will
 also automatically close if the mouse leaves this area. This is useful to
 dismiss the tip mouse when the mouse leaves the object it is associated with.