Function: button-mode

button-mode is an interactive and byte-compiled function defined in button.el.gz.

Signature

(button-mode &optional ARG)

Documentation

A minor mode for navigating to buttons with the TAB key.

Disabling the mode will remove all buttons in the current buffer.

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

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

<backtab> backward-button
C-M-i backward-button
TAB forward-button

View in manual

Probably introduced at or before Emacs version 28.1.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/button.el.gz
(define-minor-mode button-mode
  "A minor mode for navigating to buttons with the TAB key.

Disabling the mode will remove all buttons in the current buffer."
  :keymap button-buffer-map
  (when (not button-mode)
    (save-excursion
      (save-restriction
        (widen)
        (unbuttonize-region (point-min) (point-max))))))