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

... / ...

Commit	Line	Data
	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: tipwin.h
	3	// Purpose: interface of wxTipWindow
	4	// Author: wxWidgets team
	5	// Licence: wxWindows licence
	6	/////////////////////////////////////////////////////////////////////////////
	7
	8	/**
	9	@class wxTipWindow
	10
	11	Shows simple text in a popup tip window on creation.
	12	This is used by wxSimpleHelpProvider to show popup help.
	13	The window automatically destroys itself when the user clicks on it or it
	14	loses the focus.
	15
	16	You may also use this class to emulate the tooltips when you need finer
	17	control over them than what the standard tooltips provide.
	18
	19	@library{wxcore}
	20	@category{managedwnd}
	21	*/
	22	class wxTipWindow : public wxWindow
	23	{
	24	public:
	25	/**
	26	Constructor. The tip is shown immediately after the window is constructed.
	27
	28	@param parent
	29	The parent window, must be non-@NULL
	30	@param text
	31	The text to show, may contain the new line characters
	32	@param maxLength
	33	The length of each line, in pixels. Set to a very large
	34	value to avoid wrapping lines
	35	@param windowPtr
	36	Simply passed to SetTipWindowPtr() below, please see its
	37	documentation for the description of this parameter
	38	@param rectBounds
	39	If non-@NULL, passed to SetBoundingRect() below, please see its
	40	documentation for the description of this parameter
	41	*/
	42	wxTipWindow(wxWindow* parent, const wxString& text,
	43	wxCoord maxLength = 100,
	44	wxTipWindow** windowPtr = NULL,
	45	wxRect* rectBounds = NULL);
	46
	47	/**
	48	By default, the tip window disappears when the user clicks the mouse or presses
	49	a keyboard key or if it loses focus in any other way - for example because the
	50	user switched to another application window.
	51
	52	Additionally, if a non-empty @a rectBound is provided, the tip window will
	53	also automatically close if the mouse leaves this area. This is useful to
	54	dismiss the tip mouse when the mouse leaves the object it is associated with.
	55
	56	@param rectBound
	57	The bounding rectangle for the mouse in the screen coordinates
	58	*/
	59	void SetBoundingRect(const wxRect& rectBound);
	60
	61	/**
	62	When the tip window closes itself (which may happen at any moment and
	63	unexpectedly to the caller) it may @NULL out the pointer pointed to by
	64	@a windowPtr. This is helpful to avoid dereferencing the tip window which
	65	had been already closed and deleted.
	66	*/
	67	void SetTipWindowPtr(wxTipWindow** windowPtr);
	68	};
	69