diff options
| -rw-r--r-- | src/keyboard.c | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/src/keyboard.c b/src/keyboard.c index f1a131a6f4e..07b2f991c38 100644 --- a/src/keyboard.c +++ b/src/keyboard.c | |||
| @@ -2258,12 +2258,16 @@ make_ctrl_char (c) | |||
| 2258 | return c; | 2258 | return c; |
| 2259 | } | 2259 | } |
| 2260 | 2260 | ||
| 2261 | /* Display help echo in the echo area. | 2261 | /* Display the help-echo property of the character after the mouse pointer. |
| 2262 | Either show it in the echo area, or call show-help-function to display | ||
| 2263 | it by other means (maybe in a tooltip). | ||
| 2262 | 2264 | ||
| 2263 | HELP a string means display that string, HELP nil means clear the | 2265 | If HELP is nil, that means clear the previous help echo. |
| 2264 | help echo. If HELP is a function, call it with OBJECT and POS as | 2266 | |
| 2265 | arguments; the function should return a help string or nil for | 2267 | If HELP is a string, display that string. If HELP is a function, |
| 2266 | none. For all other types of HELP evaluate it to obtain a string. | 2268 | call it with OBJECT and POS as arguments; the function should |
| 2269 | return a help string or nil for none. For all other types of HELP, | ||
| 2270 | evaluate it to obtain a string. | ||
| 2267 | 2271 | ||
| 2268 | WINDOW is the window in which the help was generated, if any. | 2272 | WINDOW is the window in which the help was generated, if any. |
| 2269 | It is nil if not in a window. | 2273 | It is nil if not in a window. |