diff options
Diffstat (limited to 'etc/NEWS')
-rw-r--r-- | etc/NEWS | 15 |
1 files changed, 11 insertions, 4 deletions
@@ -2863,10 +2863,17 @@ that have a `help-echo' property. If the value of the `help-echo' property is a function, that function is called with three arguments WINDOW, OBJECT and POSITION. WINDOW is -the window in which the help was found, OBJECT is the buffer or string -which had the `help-echo' property. POSITION is the position within -OBJECT under the mouse pointer. The function should return a help -string or nil for none. +the window in which the help was found. + +If OBJECT is a buffer, POS is the position in the buffer where the +`help-echo' text property was found. + +If OBJECT is an overlay, that overlay has a `help-echo' property, and +POS is the position in the overlay's buffer under the mouse. + +If OBJECT is a string (an overlay string or a string displayed with +the `display' property). POS is the position in that string under the +mouse. If the value of the `help-echo' property is neither a function nor a string, it is evaluated to obtain a help string. |