show-tooltip

Arguments: widget

This generic function is called internally to show the tooltip of a control. This function is not normally called by an application, but wrapper methods may be added to act when a tooltip is invoked after the mouse pauses over a control. This may be useful, for example, for displaying some other form of help (such as a status-bar message) after the mouse has paused over a control.

Note that this generic function is called even if the show-tooltips configuration option has been turned off. This allows showing some custom form of help for a control without using tooltips, which may be handy if tooltips are considered more annoying than a status-bar message, for example.

See also hide-tooltip and tooltip-delay.

Example

Here is an example method that could be added to cause dialog-item help-strings to be displayed in the status-bars of their parent windows (or other ancestor windows) whenever the mouse cursor pauses over any dialog-item. See help-string.

(defmethod show-tooltip :after ((widget dialog-item))
  (let* ((help-string (help-string widget)))
    (when help-string
      (window-message (parent widget) "~a" help-string))))

Copyright (c) 1998-2019, Franz Inc. Oakland, CA., USA. All rights reserved.
This page has had moderate revisions compared to the 9.0 page.
Created 2019.8.20.