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

\section{\class{wxTipWindow}}\label{wxtipwindow}

Shows simple text in a popup tip window on creation. This is used by \helpref{wxSimpleHelpProvider}{wxsimplehelpprovider} to
show popup help. The window automatically destroys itself when the user clicks on it or it loses
the focus.

You should not normally need to use it explicitly in your application since a help provider class
will create it when required.

\wxheading{Derived from}

wxPopupTransientWindow\\
wxPopupWindow\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/tipwin.h>

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxTipWindow::wxTipWindow}\label{wxtipwindowwxtipwindow}

\func{}{wxTipWindow}{\param{wxWindow* }{parent}, \param{const wxString\& }{text}, \param{wxCoord }{maxLength = 100}}

Constructor. The tip is shown immediately the window is constructed.

\membersection{wxTipWindow::Adjust}\label{wxtipwindowadjust}

\func{void}{Adjust}{\param{const wxString\& }{text}, \param{wxCoord }{maxLength}}

Calculates the client rect we need to display the text.
Commit	Line	Data
e3c10211 JS	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
8962e1d9 RD	12	wxPopupTransientWindow\\
8962e1d9 RD	13	wxPopupWindow\\
e3c10211 JS	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