Function: elide-head-mode

elide-head-mode is an autoloaded, interactive and byte-compiled function defined in elide-head.el.gz.

Signature

(elide-head-mode &optional ARG)

Documentation

Toggle eliding (hiding) header material in the current buffer.

When Elide Header mode is enabled, headers are hidden according to elide-head-headers-to-hide.

This is suitable as an entry on find-file-hook or appropriate mode hooks.

This is a minor mode. If called interactively, toggle the Elide-Head mode mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

To check whether the minor mode is enabled in the current buffer, evaluate the variable elide-head-mode(var)/elide-head-mode(fun).

The mode's hook is called both when the mode is enabled and when it is disabled.

Probably introduced at or before Emacs version 29.1.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/elide-head.el.gz
;;;###autoload
(define-minor-mode elide-head-mode
  "Toggle eliding (hiding) header material in the current buffer.

When Elide Header mode is enabled, headers are hidden according
to `elide-head-headers-to-hide'.

This is suitable as an entry on `find-file-hook' or appropriate
mode hooks."
  :group 'elide-head
  (if elide-head-mode
      (progn
        (elide-head--hide)
        (add-hook 'change-major-mode-hook 'elide-head--delete-overlay nil 'local))
    (elide-head--show)
    (remove-hook 'change-major-mode-hook 'elide-head--delete-overlay 'local)))