showToolTip()

The function shows a user-defined tooltip at the current mouse position. By default, the tooltip is shown until the mouse is moved.

Synopsis

int showToolTip(string text, [mapping] options);

Parameters

Parameter Description
text The tooltip text that is shown.
options Mapping ["timeout"] defines a timeout in milliseconds for how long a tooltip should be shown. By default, the tooltip is shown until the mouse is moved.

Return value

The function returns 0 if it was successfully executed.

Error

void main
{
  mapping m;
  m["timeout"] = 5000; //Timeout in milli-secs
  showToolTip("MY\nTOOLTIP",m);
}

Assignment

Miscellaneous functions

Availability

UI