wxWidgets/docs/latex/wx/tooltip.tex
2007-08-15 21:27:25 +00:00

84 lines
2.1 KiB
TeX

\section{\class{wxToolTip}}\label{wxtooltip}
This class holds information about a tooltip associated with a window
(see \helpref{wxWindow::SetToolTip}{wxwindowsettooltip}).
The four static methods, \helpref{wxToolTip::Enable}{wxtooltipenable},
\helpref{wxToolTip::SetDelay}{wxtooltipsetdelay}
\helpref{wxToolTip::SetAutoPop}{wxtooltipsetautopop} and
\helpref{wxToolTip::SetReshow}{wxtooltipsetreshow} can be used to globally
alter tooltips behaviour.
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
\wxheading{Include files}
<wx/tooltip.h>
\wxheading{Library}
\helpref{wxCore}{librarieslist}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxToolTip::Enable}\label{wxtooltipenable}
\func{static void}{Enable}{\param{bool }{flag}}
Enable or disable tooltips globally.
May not be supported on all platforms (eg. wxCocoa).
\membersection{wxToolTip::SetDelay}\label{wxtooltipsetdelay}
\func{static void}{SetDelay}{\param{long }{msecs}}
Set the delay after which the tooltip appears.
May not be supported on all platforms (eg. wxCocoa).
\membersection{wxToolTip::SetAutoPop}\label{wxtooltipsetautopop}
\func{static void}{SetAutoPop}{\param{long }{msecs}}
Set the delay after which the tooltip disappears or how long a
tooltip remains visible.
May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
\membersection{wxToolTip::SetReshow}\label{wxtooltipsetreshow}
\func{static void}{SetReshow}{\param{long }{msecs}}
Set the delay between subsequent tooltips to appear.
May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
\membersection{wxToolTip::wxToolTip}\label{wxtooltipwxtooltip}
\func{}{wxToolTip}{\param{const wxString\& }{tip}}
Constructor.
\membersection{wxToolTip::SetTip}\label{wxtooltipsettip}
\func{void}{SetTip}{\param{const wxString\& }{tip}}
Set the tooltip text.
\membersection{wxToolTip::GetTip}\label{wxtooltipgettip}
\constfunc{wxString}{GetTip}{\void}
Get the tooltip text.
\membersection{wxToolTip::GetWindow}\label{wxtooltipgetwindow}
\constfunc{wxWindow*}{GetWindow}{\void}
Get the associated window.