1\section{\class{wxTipWindow}}\label{wxtipwindow} 2 3Shows simple text in a popup tip window on creation. This is used by 4\helpref{wxSimpleHelpProvider}{wxsimplehelpprovider} to show popup help. The 5window automatically destroys itself when the user clicks on it or it loses the 6focus. 7 8You may also use this class to emulate the tooltips when you need finer 9control over them than what the standard tooltips provide. 10 11\wxheading{Derived from} 12 13wxPopupTransientWindow\\ 14wxPopupWindow\\ 15\helpref{wxWindow}{wxwindow}\\ 16\helpref{wxEvtHandler}{wxevthandler}\\ 17\helpref{wxObject}{wxobject} 18 19\wxheading{Include files} 20 21<wx/tipwin.h> 22 23\latexignore{\rtfignore{\wxheading{Members}}} 24 25 26\membersection{wxTipWindow::wxTipWindow}\label{wxtipwindowwxtipwindow} 27 28\func{}{wxTipWindow}{\param{wxWindow* }{parent}, \param{const wxString\& }{text}, \param{wxCoord }{maxLength = 100}, \param{wxTipWindow** }{windowPtr}, \param{wxRect *}{rectBounds = \NULL}} 29 30Constructor. The tip is shown immediately after the window is constructed. 31 32\wxheading{Parameters} 33 34\docparam{parent}{The parent window, must be non-\NULL} 35 36\docparam{text}{The text to show, may contain the new line characters} 37 38\docparam{maxLength}{The length of each line, in pixels. Set to a very large 39value to avoid wrapping lines} 40 41\docparam{windowPtr}{Simply passed to 42\helpref{SetTipWindowPtr}{wxtipwindowsettipwindowptr} below, please see its 43documentation for the description of this parameter} 44 45\docparam{rectBounds}{If non-\NULL, passed to 46\helpref{SetBoundingRect}{wxtipwindowsetboundingrect} below, please see its 47documentation for the description of this parameter} 48 49 50 51\membersection{wxTipWindow::SetTipWindowPtr}\label{wxtipwindowsettipwindowptr} 52 53\func{void}{SetTipWindowPtr}{\param{wxTipWindow** }{windowPtr}} 54 55When the tip window closes itself (which may happen at any moment and 56unexpectedly to the caller) it may \NULL out the pointer pointed to by 57\arg{it windowPtr}. This is helpful to avoid dereferencing the tip window which 58had been already closed and deleted. 59 60 61 62\membersection{wxTipWindow::SetBoundingRect}\label{wxtipwindowsetboundingrect} 63 64\func{void}{SetBoundingRect}{\param{const wxRect\& }{rectBound}} 65 66By default, the tip window disappears when the user clicks the mouse or presses 67a keyboard key or if it loses focus in any other way - for example because the 68user switched to another application window. 69 70Additionally, if a non-empty \arg{rectBound} is provided, the tip window will 71also automatically close if the mouse leaves this area. This is useful to 72dismiss the tip mouse when the mouse leaves the object it is associated with. 73 74\wxheading{Parameters} 75 76\docparam{rectBound}{The bounding rectangle for the mouse in the screen coordinates} 77 78