]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/tooltip.tex
initial draft of wxCollapsiblePane (patch 1577412 by Francesco)
[wxWidgets.git] / docs / latex / wx / tooltip.tex
... / ...
CommitLineData
1\section{\class{wxToolTip}}\label{wxtooltip}
2
3This class holds information about a tooltip associated with a window
4(see \helpref{wxWindow::SetToolTip}{wxwindowsettooltip}).
5
6The two static methods, \helpref{wxToolTip::Enable}{wxtooltipenable} and
7\helpref{wxToolTip::SetDelay}{wxtooltipsetdelay} can be used to globally
8alter tooltips behaviour.
9
10\wxheading{Derived from}
11
12\helpref{wxObject}{wxobject}
13
14\wxheading{Include files}
15
16<wx/tooltip.h>
17
18\latexignore{\rtfignore{\wxheading{Members}}}
19
20
21\membersection{wxToolTip::Enable}\label{wxtooltipenable}
22
23\func{static void}{Enable}{\param{bool }{flag}}
24
25Enable or disable tooltips globally.
26
27May not be supported on all platforms (eg. wxCocoa).
28
29
30\membersection{wxToolTip::SetDelay}\label{wxtooltipsetdelay}
31
32\func{static void}{SetDelay}{\param{long }{msecs}}
33
34Set the delay after which the tooltip appears.
35
36May not be supported on all platforms (eg. wxCocoa).
37
38\membersection{wxToolTip::wxToolTip}\label{wxtooltipwxtooltip}
39
40\func{}{wxToolTip}{\param{const wxString\& }{tip}}
41
42Constructor.
43
44\membersection{wxToolTip::SetTip}\label{wxtooltipsettip}
45
46\func{void}{SetTip}{\param{const wxString\& }{tip}}
47
48Set the tooltip text.
49
50
51\membersection{wxToolTip::GetTip}\label{wxtooltipgettip}
52
53\constfunc{wxString}{GetTip}{\void}
54
55Get the tooltip text.
56
57\membersection{wxToolTip::GetWindow}\label{wxtooltipgetwindow}
58
59\constfunc{wxWindow*}{GetWindow}{\void}
60
61Get the associated window.
62