Variable: outline-minor-mode-cycle-filter

outline-minor-mode-cycle-filter is a customizable variable defined in outline.el.gz.

Value

nil

Documentation

Control where on a heading the visibility-cycling commands are bound to keys.

This option controls, in Outline minor mode, where on a heading typing the key sequences bound to visibility-cycling commands like outline-cycle and outline-cycle-buffer will invoke those commands. By default, you can invoke these commands by typing \TAB and \S-TAB anywhere on a heading line, but customizing this option can make those bindings be in effect only at specific positions on the heading, like only at the line's beginning or line's end. This allows these keys to be bound to their usual commands, as determined by the major mode, elsewhere on the heading lines. This option is only in effect when outline-minor-mode-cycle is non-nil.

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

Source Code

;; Defined in /usr/src/emacs/lisp/outline.el.gz
(defcustom outline-minor-mode-cycle-filter nil
  "Control where on a heading the visibility-cycling commands are bound to keys.
This option controls, in Outline minor mode, where on a heading typing
the key sequences bound to visibility-cycling commands like `outline-cycle'
and `outline-cycle-buffer' will invoke those commands.  By default, you can
invoke these commands by typing \\`TAB' and \\`S-TAB' anywhere on a heading line,
but customizing this option can make those bindings be in effect only at
specific positions on the heading, like only at the line's beginning or
line's end.  This allows these keys to be bound to their usual commands,
as determined by the major mode, elsewhere on the heading lines.
This option is only in effect when `outline-minor-mode-cycle' is non-nil."
  :type '(choice (const :tag "Everywhere" nil)
                 (const :tag "At line beginning" bolp)
                 (const :tag "Not at line beginning"
                        (lambda () (not (bolp))))
                 (const :tag "At line end" eolp)
                 (function :tag "Custom filter function"))
  :version "28.1")