Variable: mode-line-default-help-echo

mode-line-default-help-echo is a customizable variable defined in bindings.el.gz.

Value

mode-line-default-help-echo

Documentation

Default help text for the mode line.

If the value is a string, it specifies the tooltip or echo area message to display when the mouse is moved over the mode line. If the value is a function, call that function with one argument
- the window whose mode line to display. If the text at the
mouse position has a help-echo text property, that overrides this variable.

This variable was added, or its default value changed, in Emacs 27.1.

Probably introduced at or before Emacs version 24.3.

Source Code

;; Defined in /usr/src/emacs/lisp/bindings.el.gz
(defcustom mode-line-default-help-echo #'mode-line-default-help-echo
  "Default help text for the mode line.
If the value is a string, it specifies the tooltip or echo area
message to display when the mouse is moved over the mode line.
If the value is a function, call that function with one argument
- the window whose mode line to display.  If the text at the
mouse position has a `help-echo' text property, that overrides
this variable."
  :type '(choice
          (const :tag "No help" :value nil)
          function
          (string :value "mouse-1: Select (drag to resize)\n\
mouse-2: Make current window occupy the whole frame\n\
mouse-3: Remove current window from display"))
  :version "27.1"
  :group 'mode-line)