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	\wxheading{Library}
	24
	25	\helpref{wxCore}{librarieslist}
	26
	27	\latexignore{\rtfignore{\wxheading{Members}}}
	28
	29
	30	\membersection{wxTipWindow::wxTipWindow}\label{wxtipwindowwxtipwindow}
	31
	32	\func{}{wxTipWindow}{\param{wxWindow* }{parent}, \param{const wxString\& }{text}, \param{wxCoord }{maxLength = 100}, \param{wxTipWindow** }{windowPtr}, \param{wxRect *}{rectBounds = \NULL}}
	33
	34	Constructor. The tip is shown immediately after the window is constructed.
	35
	36	\wxheading{Parameters}
	37
	38	\docparam{parent}{The parent window, must be non-\NULL}
	39
	40	\docparam{text}{The text to show, may contain the new line characters}
	41
	42	\docparam{maxLength}{The length of each line, in pixels. Set to a very large
	43	value to avoid wrapping lines}
	44
	45	\docparam{windowPtr}{Simply passed to
	46	\helpref{SetTipWindowPtr}{wxtipwindowsettipwindowptr} below, please see its
	47	documentation for the description of this parameter}
	48
	49	\docparam{rectBounds}{If non-\NULL, passed to
	50	\helpref{SetBoundingRect}{wxtipwindowsetboundingrect} below, please see its
	51	documentation for the description of this parameter}
	52
	53
	54
	55	\membersection{wxTipWindow::SetTipWindowPtr}\label{wxtipwindowsettipwindowptr}
	56
	57	\func{void}{SetTipWindowPtr}{\param{wxTipWindow** }{windowPtr}}
	58
	59	When the tip window closes itself (which may happen at any moment and
	60	unexpectedly to the caller) it may \NULL out the pointer pointed to by
	61	\arg{it windowPtr}. This is helpful to avoid dereferencing the tip window which
	62	had been already closed and deleted.
	63
	64
	65
	66	\membersection{wxTipWindow::SetBoundingRect}\label{wxtipwindowsetboundingrect}
	67
	68	\func{void}{SetBoundingRect}{\param{const wxRect\& }{rectBound}}
	69
	70	By default, the tip window disappears when the user clicks the mouse or presses
	71	a keyboard key or if it loses focus in any other way - for example because the
	72	user switched to another application window.
	73
	74	Additionally, if a non-empty \arg{rectBound} is provided, the tip window will
	75	also automatically close if the mouse leaves this area. This is useful to
	76	dismiss the tip mouse when the mouse leaves the object it is associated with.
	77
	78	\wxheading{Parameters}
	79
	80	\docparam{rectBound}{The bounding rectangle for the mouse in the screen coordinates}
	81