show-help-string-under-mouse

Arguments: object

Returns whether the help-string of a window, widget, or hotspot is automatically displayed in an available status bar (if any) when the mouse cursor moves over the object. The value may be set at creation time by passing the show-help-string-under-mouse initarg, or any time later by calling (setf show-help-string-under-mouse). The default value is nil.

When nil, this property has no effect.

When true, then whenever the mouse cursor is moved over the object, the object's help-string is displayed in a status bar if a suitable common-status-bar or status-bar is found. When the mouse cursor moves off of the object, a blank status bar message is displayed to erase the help string.

A status bar is found by first looking for one on the window itself when object is a window, or else by looking on the parent window of the widget or hotspot. If that window does not have a status bar, then successive ancestor windows are checked until a status bar is found. If no status bar is found, then nothing is done.

This behavior is implemented with mouse-in and mouse-out methods that call window-message.

This property is not implemented on html-widget, where it does not appear feasible.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.