Function: org-table-header-line-mode

org-table-header-line-mode is an autoloaded, interactive and byte-compiled function defined in org-table.el.gz.

Signature

(org-table-header-line-mode &optional ARG)

Documentation

Display the first row of the table at point in the header line.

This is a minor mode. If called interactively, toggle the Org-Table-Header-Line 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 org-table-header-line-mode(var)/org-table-header-line-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
;;;###autoload
(define-minor-mode org-table-header-line-mode
  "Display the first row of the table at point in the header line."
  :lighter " TblHeader"
  (unless (eq major-mode 'org-mode)
    (user-error "Cannot turn org table header mode outside org-mode buffers"))
  (if org-table-header-line-mode
      (add-hook 'post-command-hook #'org-table-header-set-header nil t)
    (when (overlayp org-table-header-overlay)
      (delete-overlay org-table-header-overlay)
      (setq org-table-header-overlay nil))
    (remove-hook 'post-command-hook #'org-table-header-set-header t)))