]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/tipwin.tex
Fixed '_' chars that were not quoted with a '\'
[wxWidgets.git] / docs / latex / wx / tipwin.tex
1 \section{\class{wxTipWindow}}\label{wxtipwindow}
2
3 Shows simple text in a popup tip window on creation. This is used by \helpref{wxSimpleHelpProvider}{wxsimplehelpprovider} to
4 show popup help. The window automatically destroys itself when the user clicks on it or it loses
5 the focus.
6
7 You should not normally need to use it explicitly in your application since a help provider class
8 will create it when required.
9
10 \wxheading{Derived from}
11
12 wxPopupTransientWindow\\
13 wxPopupWindow\\
14 \helpref{wxWindow}{wxwindow}\\
15 \helpref{wxEvtHandler}{wxevthandler}\\
16 \helpref{wxObject}{wxobject}
17
18 \wxheading{Include files}
19
20 <wx/tipwin.h>
21
22 \latexignore{\rtfignore{\wxheading{Members}}}
23
24 \membersection{wxTipWindow::wxTipWindow}\label{wxtipwindowwxtipwindow}
25
26 \func{}{wxTipWindow}{\param{wxWindow* }{parent}, \param{const wxString\& }{text}, \param{wxCoord }{maxLength = 100}}
27
28 Constructor. The tip is shown immediately the window is constructed.
29
30 \membersection{wxTipWindow::Adjust}\label{wxtipwindowadjust}
31
32 \func{void}{Adjust}{\param{const wxString\& }{text}, \param{wxCoord }{maxLength}}
33
34 Calculates the client rect we need to display the text.
35