Function: rectangular-region-mode

rectangular-region-mode is an interactive and natively compiled function defined in rectangular-region-mode.el.

Signature

(rectangular-region-mode &optional ARG)

Documentation

A mode for creating a rectangular region to edit

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

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

Key Bindings

This command is not in any keymaps.

Source Code

;; Defined in /nix/store/5q7a78ihkz25lf4xmxaa9m7b2ym63m36-emacs-packages-deps/share/emacs/site-lisp/elpa/multiple-cursors-20260419.931/rectangular-region-mode.el
;;;###autoload
(define-minor-mode rectangular-region-mode
  "A mode for creating a rectangular region to edit"
  :init-value nil
  :lighter " rr"
  :keymap rectangular-region-mode-map
  (if rectangular-region-mode
      (progn
        (add-hook 'after-change-functions #'rrm/switch-to-multiple-cursors t t)
        (add-hook 'post-command-hook #'rrm/repaint t t))
    (remove-hook 'after-change-functions #'rrm/switch-to-multiple-cursors t)
    (remove-hook 'post-command-hook #'rrm/repaint t)
    (set-marker rrm/anchor nil)))