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 \helpref{wxFrame}{wxframe}\\
  13 \helpref{wxWindow}{wxwindow}\\
  14 \helpref{wxEvtHandler}{wxevthandler}\\
  15 \helpref{wxObject}{wxobject}
  16
  17 \wxheading{Include files}
  18
  19 <wx/tipwin.h>
  20
  21 \latexignore{\rtfignore{\wxheading{Members}}}
  22
  23 \membersection{wxTipWindow::wxTipWindow}\label{wxtipwindowwxtipwindow}
  24
  25 \func{}{wxTipWindow}{\param{wxWindow* }{parent}, \param{const wxString\& }{text}, \param{wxCoord }{maxLength = 100}}
  26
  27 Constructor. The tip is shown immediately the window is constructed.
  28
  29 \membersection{wxTipWindow::Adjust}\label{wxtipwindowadjust}
  30
  31 \func{void}{Adjust}{\param{const wxString\& }{text}, \param{wxCoord }{maxLength}}
  32
  33 Calculates the client rect we need to display the text.
  34