Function: xref-mouse-mode

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

Signature

(xref-mouse-mode &optional ARG)

Documentation

Minor mode to bind Xref commands invoked using the mouse.

See global-xref-mouse-mode(var)/global-xref-mouse-mode(fun) if you want to enable this minor mode in all buffers.

This is a minor mode. If called interactively, toggle the Xref-Mouse 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 xref-mouse-mode(var)/xref-mouse-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 31.1.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/xref.el.gz
;;;###autoload
(define-minor-mode xref-mouse-mode
  "Minor mode to bind Xref commands invoked using the mouse.
See `global-xref-mouse-mode' if you want to enable this minor mode in
all buffers."
  :version "31.1")