Function: outline-minor-mode

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

Signature

(outline-minor-mode &optional ARG)

Documentation

Toggle Outline minor mode.

This is a minor mode. If called interactively, toggle the Outline minor 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 outline-minor-mode(var)/outline-minor-mode(fun).

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

See the command outline-mode for more information on this mode.

Probably introduced at or before Emacs version 19.20.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/outline.el.gz
;;;###autoload
(define-minor-mode outline-minor-mode
  "Toggle Outline minor mode.

See the command `outline-mode' for more information on this mode."
  :lighter " Outl"
  :keymap (list (cons [menu-bar] outline-minor-mode-menu-bar-map)
		(cons outline-minor-mode-prefix outline-mode-prefix-map))
  (if outline-minor-mode
      (progn
        (when (or outline-minor-mode-cycle outline-minor-mode-highlight)
          (if (and global-font-lock-mode (font-lock-specified-p major-mode))
              (progn
                (font-lock-add-keywords nil outline-font-lock-keywords t)
                (font-lock-flush))
            (outline-minor-mode-highlight-buffer)))
	;; Turn off this mode if we change major modes.
	(add-hook 'change-major-mode-hook
		  (lambda () (outline-minor-mode -1))
		  nil t)
        (setq-local line-move-ignore-invisible t)
	;; Cause use of ellipses for invisible text.
	(add-to-invisibility-spec '(outline . t)))
    (when (or outline-minor-mode-cycle outline-minor-mode-highlight)
      (if font-lock-fontified
          (font-lock-remove-keywords nil outline-font-lock-keywords))
      (remove-overlays nil nil 'outline-overlay t)
      (font-lock-flush))
    (setq line-move-ignore-invisible nil)
    ;; Cause use of ellipses for invisible text.
    (remove-from-invisibility-spec '(outline . t))
    ;; When turning off outline mode, get rid of any outline hiding.
    (outline-show-all)))