git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	\section{\class{wxTipWindow}}\label{wxtipwindow}
	2
	3	Shows simple text in a popup tip window on creation. This is used by
	4	\helpref{wxSimpleHelpProvider}{wxsimplehelpprovider} to show popup help. The
	5	window automatically destroys itself when the user clicks on it or it loses the
	6	focus.
	7
	8	You may also use this class to emulate the tooltips when you need finer
	9	control over them than what the standard tooltips provide.
	10
	11	\wxheading{Derived from}
	12
	13	wxPopupTransientWindow\\
	14	wxPopupWindow\\
	15	\helpref{wxWindow}{wxwindow}\\
	16	\helpref{wxEvtHandler}{wxevthandler}\\
	17	\helpref{wxObject}{wxobject}
	18
	19	\wxheading{Include files}
	20
	21	<wx/tipwin.h>
	22
	23	\latexignore{\rtfignore{\wxheading{Members}}}
	24
	25	\membersection{wxTipWindow::wxTipWindow}\label{wxtipwindowwxtipwindow}
	26
	27	\func{}{wxTipWindow}{\param{wxWindow* }{parent}, \param{const wxString\& }{text}, \param{wxCoord }{maxLength = 100}, \param{wxTipWindow** }{windowPtr}}
	28
	29	Constructor. The tip is shown immediately the window is constructed.
	30
	31	\wxheading{Parameters}
	32
	33	\docparam{parent}{The parent window, must be non-{\tt NULL}}
	34
	35	\docparam{text}{The text to show, may contain the new line characters}
	36
	37	\docparam{windowPtr}{Simply passed to
	38	\helpref{SetTipWindowPtr}{wxtipwindowsettipwindowptr} below, please see its
	39	documentation for the description of this parameter}
	40
	41	\docparam{rectBounds}{If non-{\tt NULL}, passed to
	42	\helpref{SetBoundingRect}{wxtipwindowsetboundingrect} below, please see its
	43	documentation for the description of this parameter}
	44
	45
	46	\membersection{wxTipWindow::SetTipWindowPtr}\label{wxtipwindowsettipwindowptr}
	47
	48	\func{void}{SetTipWindowPtr}{\param{wxTipWindow** }{windowPtr}}
	49
	50	When the tip window closes itself (which may happen at any moment and
	51	unexpectedly to the caller) it may {\tt NULL} out the pointer pointed to by
	52	{\it windowPtr}. This is helpful to avoid dereferencing the tip window which
	53	had been already closed and deleted.
	54
	55
	56	\membersection{wxTipWindow::SetBoundingRect}\label{wxtipwindowsetboundingrect}
	57
	58	\func{void}{SetBoundingRect}{\param{const wxRect\& }{rectBound}}
	59
	60	By default, the tip window disappears when the user clicks the mouse or presses
	61	a keyboard key or if it loses focus in any other way - for example because the
	62	user switched to another application window.
	63
	64	Additionally, if a non-empty {\it rectBound} is provided, the tip window will
	65	also automatically close if the mouse leaves this area. This is useful to
	66	dismiss the tip mouse when the mouse leaves the object it is associated with.
	67
	68	\wxheading{Parameters}
	69
	70	\docparam{rectBound}{The bounding rectangle for the mouse in the screen coordinates}
	71