Variable: outline-search-function

outline-search-function is a buffer-local variable defined in outline.el.gz.

Documentation

Function to search the next outline heading.

The function is called with four optional arguments: BOUND, MOVE, BACKWARD, LOOKING-AT. The first two arguments BOUND and MOVE are almost the same as the BOUND and NOERROR arguments of re-search-forward, with the difference that MOVE accepts only a boolean, either nil or non-nil. When the argument BACKWARD is non-nil, the search should search backward like re-search-backward does. In case of a successful search, the function should return non-nil, move point, and set match-data appropriately. When the argument LOOKING-AT is non-nil, it should imitate the function looking-at.

View in manual

Source Code

;; Defined in /usr/src/emacs/lisp/outline.el.gz
;;;###autoload(put 'outline-heading-end-regexp 'safe-local-variable 'stringp)

(defvar outline-search-function nil
  "Function to search the next outline heading.
The function is called with four optional arguments: BOUND, MOVE, BACKWARD,
LOOKING-AT.  The first two arguments BOUND and MOVE are almost the same as
the BOUND and NOERROR arguments of `re-search-forward', with the difference
that MOVE accepts only a boolean, either nil or non-nil.  When the argument
BACKWARD is non-nil, the search should search backward like
`re-search-backward' does.  In case of a successful search, the
function should return non-nil, move point, and set match-data
appropriately.  When the argument LOOKING-AT is non-nil, it should
imitate the function `looking-at'.")