projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| f6bcfd97 BP |
1 | \section{\class{wxToolTip}}\label{wxtooltip} |
| 2 | ||
| 3 | This class holds information about a tooltip associated with a window | |
| 4 | (see \helpref{wxWindow::SetToolTip}{wxwindowsettooltip}). | |
| 5 | ||
| becac1ef VZ |
6 | The four static methods, \helpref{wxToolTip::Enable}{wxtooltipenable}, |
| 7 | \helpref{wxToolTip::SetDelay}{wxtooltipsetdelay} | |
| 8 | \helpref(wxToolTip::SetAutoPop)(wxtooltipsetautopop) and | |
| 9 | \helpref(wxToolTip::SetReshow)(wxtooltipsetreshow) can be used to globally | |
| f6bcfd97 BP |
10 | alter tooltips behaviour. |
| 11 | ||
| 12 | \wxheading{Derived from} | |
| 13 | ||
| 14 | \helpref{wxObject}{wxobject} | |
| 15 | ||
| 0e10e38d VZ |
16 | \wxheading{Include files} |
| 17 | ||
| 18 | <wx/tooltip.h> | |
| f6bcfd97 | 19 | |
| a7af285d VZ |
20 | \wxheading{Library} |
| 21 | ||
| 22 | \helpref{wxCore}{librarieslist} | |
| 23 | ||
| f6bcfd97 BP |
24 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 25 | ||
| 26 | ||
| 27 | \membersection{wxToolTip::Enable}\label{wxtooltipenable} | |
| 28 | ||
| 29 | \func{static void}{Enable}{\param{bool }{flag}} | |
| 30 | ||
| 31 | Enable or disable tooltips globally. | |
| 32 | ||
| 26191790 RN |
33 | May not be supported on all platforms (eg. wxCocoa). |
| 34 | ||
| f6bcfd97 BP |
35 | |
| 36 | \membersection{wxToolTip::SetDelay}\label{wxtooltipsetdelay} | |
| 37 | ||
| 38 | \func{static void}{SetDelay}{\param{long }{msecs}} | |
| 39 | ||
| 40 | Set the delay after which the tooltip appears. | |
| 41 | ||
| 26191790 | 42 | May not be supported on all platforms (eg. wxCocoa). |
| f6bcfd97 | 43 | |
| becac1ef VZ |
44 | \membersection{wxToolTip::SetAutoPop}\label{wxtooltipsetautopop} |
| 45 | ||
| 46 | \func{static void}{SetAutoPop}{\param{long }{msecs}} | |
| 47 | ||
| 48 | Set the delay after which the tooltip disappears or how long a | |
| 49 | tooltip remains visible. | |
| 50 | May not be supported on all platforms (eg. wxCocoa, GTK, Palmos). | |
| 51 | ||
| 52 | \membersection{wxToolTip::SetReshow}\label{wxtooltipsetreshow} | |
| 53 | ||
| 54 | \func{static void}{SetReshow}{\param{long }{msecs}} | |
| 55 | ||
| 56 | Set the delay between subsequent tooltips to appear. | |
| 57 | May not be supported on all platforms (eg. wxCocoa, GTK, Palmos). | |
| 58 | ||
| f6bcfd97 BP |
59 | \membersection{wxToolTip::wxToolTip}\label{wxtooltipwxtooltip} |
| 60 | ||
| 61 | \func{}{wxToolTip}{\param{const wxString\& }{tip}} | |
| 62 | ||
| 63 | Constructor. | |
| 64 | ||
| 65 | \membersection{wxToolTip::SetTip}\label{wxtooltipsettip} | |
| 66 | ||
| 67 | \func{void}{SetTip}{\param{const wxString\& }{tip}} | |
| 68 | ||
| 69 | Set the tooltip text. | |
| 70 | ||
| 71 | ||
| 72 | \membersection{wxToolTip::GetTip}\label{wxtooltipgettip} | |
| 73 | ||
| 74 | \constfunc{wxString}{GetTip}{\void} | |
| 75 | ||
| 76 | Get the tooltip text. | |
| 77 | ||
| 78 | \membersection{wxToolTip::GetWindow}\label{wxtooltipgetwindow} | |
| 79 | ||
| 80 | \constfunc{wxWindow*}{GetWindow}{\void} | |
| 81 | ||
| 82 | Get the associated window. | |
| 83 |