Function: cursor-face-highlight-mode

cursor-face-highlight-mode is an interactive and byte-compiled function defined in simple.el.gz.

Signature

(cursor-face-highlight-mode &optional ARG)

Documentation

When enabled, highlight text that has cursor-face property near point.

This is a minor mode. If called interactively, toggle the Cursor-Face-Highlight 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 cursor-face-highlight-mode(var)/cursor-face-highlight-mode(fun).

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

View in manual

Probably introduced at or before Emacs version 29.1.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/simple.el.gz
(define-minor-mode cursor-face-highlight-mode
  "When enabled, highlight text that has `cursor-face' property near point."
  :global nil
  (if cursor-face-highlight-mode
      (add-hook 'pre-redisplay-functions
                #'redisplay--update-cursor-face-highlight nil t)
    (remove-hook 'pre-redisplay-functions
                 #'redisplay--update-cursor-face-highlight t)))