ToolTip functions

Defines
#define	TOOLTIPFLAG_NoEventHandler   0x00000002
Typedefs
typedef void *	TOOLTIPHANDLE
Functions
DEPRECATED ERRVALUE	MxToolTipAdd (Widget widget, const MIUNICODE *string, TOOLTIPHANDLE *tthandle=0, UINT32 flags=0)
DEPRECATED bool	MxToolTipCheckMotion (TOOLTIPHANDLE handle, const XEvent *ev, bool bAutoHide=true)
DEPRECATED bool	MxToolTipCheckMotion (TOOLTIPHANDLE handle, int x_root, int y_root, bool bAutoHide=true)
DEPRECATED ERRVALUE	MxToolTipHide (TOOLTIPHANDLE handle, UINT32 flags=0)
DEPRECATED bool	MxToolTipIsVisible (TOOLTIPHANDLE handle)
DEPRECATED ERRVALUE	MxToolTipShow (TOOLTIPHANDLE handle, const MIUNICODE *text, UINT32 flags=0)

---

Detailed Description

Deprecated:

Replaced by MGUI::CTRL_TOOLTIP

---

Define Documentation

#define TOOLTIPFLAG_NoEventHandler   0x00000002

Caller handles events and time-outs.

---

Typedef Documentation

typedef void* TOOLTIPHANDLE

---

Function Documentation

DEPRECATED ERRVALUE MxToolTipAdd	(	Widget	widget,
		const MIUNICODE *	string,
		TOOLTIPHANDLE *	tthandle = 0,
		UINT32	flags = 0
	)

Add a ToolTip to a Widget.

Deprecated:

Replaced by MGUI::CTRL_TOOLTIP

Parameters:

	widget	Widget to add ToolTip to, must have a fontlist
	string	String to add, NULL to use labelString from widget
	tthandle	ToolTip handle returned if needed
	flags	0 or TOOLTIPFLAG_NoEventHandler

DEPRECATED bool MxToolTipCheckMotion	(	TOOLTIPHANDLE	handle,
		const XEvent *	ev,
		bool	bAutoHide = true
	)

Check cursor motion to see if tooltip should be hidden.

Deprecated:

Replaced by MGUI::CTRL_TOOLTIP

This is only needed by code which does its own timer control to control and calls MxToolTipShow() itself. If bAutoHide is true (which it is by default if not specified) and the movement is enough that the tooltip should be hidden, it will it. If bAutoHide is false, this function won't hide it but will return true if you should hide it. Obviously, any event other than MotionNotify will return false.

Returns:

true if cursor was (or should be) hidden, false if not.

Parameters:

	handle	ToolTip handle
	ev	Event to check

DEPRECATED bool MxToolTipCheckMotion	(	TOOLTIPHANDLE	handle,
		int	x_root,
		int	y_root,
		bool	bAutoHide = true
	)

Check cursor motion to see if tooltip should be hidden.

Deprecated:

Replaced by MGUI::CTRL_TOOLTIP

This is only needed by code which does its own timer control to control and calls MxToolTipShow() itself. Pass the x_root and y_root from the MotionNotify callback as coordinates If bAutoHide is true (which it is by default if not specified) and the movement is enough that the tooltip should be hidden, it will it. If bAutoHide is false, this function won't hide it but will return true if you should hide it.

Returns:

true if cursor was (or should be) hidden, false if not.

Parameters:

	handle	ToolTip handle
	x_root	X coordinate of cursor (relative to root window)
	y_root	Y coordinate of cursor (relative to root window)

DEPRECATED ERRVALUE MxToolTipHide	(	TOOLTIPHANDLE	handle,
		UINT32	flags = 0
	)

Show tool tip with specified text.

Deprecated:

Replaced by MGUI::CTRL_TOOLTIP

Parameters:

handle

ToolTip handle

DEPRECATED bool MxToolTipIsVisible

(

TOOLTIPHANDLE

handle

)

Determine if tooltip is currently popped up.

Deprecated:

Replaced by MGUI::CTRL_TOOLTIP

Parameters:

handle

ToolTip handle

DEPRECATED ERRVALUE MxToolTipShow	(	TOOLTIPHANDLE	handle,
		const MIUNICODE *	text,
		UINT32	flags = 0
	)

Show tool tip with specified text.

Deprecated:

Replaced by MGUI::CTRL_TOOLTIP

Parameters:

	handle	ToolTip handle
	text	Text to show