Function: button--help-echo

button--help-echo is a byte-compiled function defined in button.el.gz.

Signature

(button--help-echo BUTTON)

Documentation

Evaluate BUTTON's help-echo property and return its value.

If the result is non-nil, pass it through substitute-command-keys before returning it, as is done for show-help-function.

Source Code

;; Defined in /usr/src/emacs/lisp/button.el.gz
(defun button--help-echo (button)
  "Evaluate BUTTON's `help-echo' property and return its value.
If the result is non-nil, pass it through `substitute-command-keys'
before returning it, as is done for `show-help-function'."
  (let* ((help (button-get button 'help-echo))
         (help (if (functionp help)
                   (funcall help
                            (selected-window)
                            (if (overlayp button) button (current-buffer))
                            (button-start button))
                 (eval help lexical-binding))))
    (and help (substitute-command-keys help))))