Function: org-table-follow-field-mode

org-table-follow-field-mode is an interactive and byte-compiled function defined in org-table.el.gz.

Signature

(org-table-follow-field-mode &optional ARG)

Documentation

Minor mode to make the table field editor window follow the cursor.

When this mode is active, the field editor window will always show the current field. The mode exits automatically when the cursor leaves the table (but see org-table-exit-follow-field-mode-when-leaving-table).

This is a minor mode. If called interactively, toggle the Org-Table-Follow-Field 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 org-table-follow-field-mode(var)/org-table-follow-field-mode(fun).

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

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-table.el.gz
;;; Follow Field minor mode

(define-minor-mode org-table-follow-field-mode
  "Minor mode to make the table field editor window follow the cursor.
When this mode is active, the field editor window will always show the
current field.  The mode exits automatically when the cursor leaves the
table (but see `org-table-exit-follow-field-mode-when-leaving-table')."
  :lighter " TblFollow"
  (if org-table-follow-field-mode
      (add-hook 'post-command-hook 'org-table-follow-fields-with-editor
		'append 'local)
    (remove-hook 'post-command-hook 'org-table-follow-fields-with-editor 'local)
    (let* ((buf (get-buffer "*Org Table Edit Field*"))
	   (win (and buf (get-buffer-window buf))))
      (when win (delete-window win))
      (when buf
	(with-current-buffer buf
	  (move-marker org-field-marker nil))
	(kill-buffer buf)))))