Main Page | Modules | Directories | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

ToolTip functions


Defines

#define TOOLTIPFLAG_NoEventHandler   0x00000002
#define TOOLTIPFLAG_UserDataHandle   0x00000001

Typedefs

typedef void * TOOLTIPHANDLE

Enumerations

enum  TOOLTIPDELAY { TOOLTIPDELAY_Short = 0, TOOLTIPDELAY_Medium = 1, TOOLTIPDELAY_Long = 2, TOOLTIPDELAY_Max }

Functions

DEPRECATED ERRVALUE MxToolTipAdd (Widget widget, const UNICODE *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 void MxToolTipDisable (TOOLTIPHANDLE handle)
DEPRECATED void MxToolTipEnable (TOOLTIPHANDLE handle)
DEPRECATED TOOLTIPHANDLE MxToolTipGetHandleFromUserData (Widget widget)
DEPRECATED void MxToolTipGetPosition (TOOLTIPHANDLE handle, LPOINT2D &pos)
DEPRECATED ERRVALUE MxToolTipHide (TOOLTIPHANDLE handle, UINT32 flags=0)
DEPRECATED bool MxToolTipIsVisible (TOOLTIPHANDLE handle)
DEPRECATED ERRVALUE MxToolTipRename (TOOLTIPHANDLE handle, const UNICODE *text, UINT32 flags=0)
DEPRECATED void MxToolTipSetDelay (TOOLTIPHANDLE handle, int delay)
DEPRECATED void MxToolTipSetDelay (TOOLTIPHANDLE handle, TOOLTIPDELAY delay)
DEPRECATED ERRVALUE MxToolTipShow (TOOLTIPHANDLE handle, const UNICODE *text, UINT32 flags=0)

Detailed Description

Deprecated:
Replaced by MGUI::CTRL_TOOLTIP

Define Documentation

#define TOOLTIPFLAG_NoEventHandler   0x00000002
 

Caller handles events and time-outs.

Definition at line 5159 of file xdefns.h.

#define TOOLTIPFLAG_UserDataHandle   0x00000001
 

Set handle in NamedUserData.

Definition at line 5158 of file xdefns.h.

Typedef Documentation

typedef void* TOOLTIPHANDLE
 

Definition at line 5149 of file xdefns.h.

Enumeration Type Documentation

enum TOOLTIPDELAY
 

Enumeration values:
TOOLTIPDELAY_Short 
TOOLTIPDELAY_Medium 
TOOLTIPDELAY_Long 
TOOLTIPDELAY_Max 

Definition at line 5151 of file xdefns.h.

Function Documentation

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

Add a ToolTip to a Widget.

Deprecated:
Replaced by MGUI::CTRL_TOOLTIP
Flags:
  • TOOLTIPFLAG_UserDataHandle Save ToolTip handle in "Named" userdata attached to widget.
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_UserDataHandle 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 void MxToolTipDisable (  TOOLTIPHANDLE  handle  ) 
 

Disable ToolTip.

Deprecated:
Replaced by MGUI::CTRL_TOOLTIP This increments the "disabled" count so multiple disables require an equal number of MxToolTipEnable() calls to actually reenable the ToolTip.
Parameters:
handle  ToolTip handle

DEPRECATED void MxToolTipEnable (  TOOLTIPHANDLE  handle  ) 
 

Enable ToolTip.

Deprecated:
Replaced by MGUI::CTRL_TOOLTIP
Parameters:
handle  ToolTip handle

DEPRECATED TOOLTIPHANDLE MxToolTipGetHandleFromUserData (  Widget  widget  ) 
 

Get ToolTip handle from NamedUserData.

Deprecated:
Replaced by MGUI::CTRL_TOOLTIP
Returns:
ToolTip handle You must have specified the TOOLTIPFLAG_UserDataHandle flag in MxToolTipAdd() to use this function.

DEPRECATED void MxToolTipGetPosition (  TOOLTIPHANDLE  handle,
LPOINT2D &  pos
) 
 

Return the last position the tooltip was popped up.

Deprecated:
Replaced by MGUI::CTRL_TOOLTIP Coordinates returned are relative to the root window.
Parameters:
handle  ToolTip handle
pos  Position returned

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 MxToolTipRename (  TOOLTIPHANDLE  handle,
const UNICODE *  text,
UINT32  flags = 0
) 
 

Change string displayed for a specified ToolTip.

Deprecated:
Replaced by MGUI::CTRL_TOOLTIP
Parameters:
handle  ToolTip handle

DEPRECATED void MxToolTipSetDelay (  TOOLTIPHANDLE  handle,
int  delay
) 
 

Set ToolTip popup delay in milliseconds.

Deprecated:
Replaced by MGUI::CTRL_TOOLTIP
Parameters:
handle  ToolTip handle
delay  Delay in milliseconds

DEPRECATED void MxToolTipSetDelay (  TOOLTIPHANDLE  handle,
TOOLTIPDELAY  delay
) 
 

Set ToolTip popup delay.

Deprecated:
Replaced by MGUI::CTRL_TOOLTIP
Parameters:
handle  ToolTip handle

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

Show tool tip with specified text.

Deprecated:
Replaced by MGUI::CTRL_TOOLTIP
Parameters:
handle  ToolTip handle
text  Text to show

Generated on Tue Dec 14 13:20:30 2004 for TNTsdk by  doxygen 1.3.8-20040913