Function: tab-line-mode

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

Signature

(tab-line-mode &optional ARG)

Documentation

Toggle display of tab line in the windows displaying the current buffer.

When this mode is enabled, each window displays a tab line on its top screen line. The tab line is a row of tabs -- buttons which you can click to have the window display the buffer whose name is shown on the button. Clicking on the "x" icon of the button removes the button (but does not kill the corresponding buffer). In addition, the tab line shows a "+" button which adds a new button, so you could have one more buffer shown on the tab line.

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

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

Probably introduced at or before Emacs version 31.1.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/tab-line.el.gz
;;;###autoload
(define-minor-mode tab-line-mode
  "Toggle display of tab line in the windows displaying the current buffer.

When this mode is enabled, each window displays a tab line on its
top screen line.  The tab line is a row of tabs -- buttons which
you can click to have the window display the buffer whose name is
shown on the button.  Clicking on the \"x\" icon of the button
removes the button (but does not kill the corresponding buffer).
In addition, the tab line shows a \"+\" button which adds a new
button, so you could have one more buffer shown on the tab line."
  :lighter nil
  (let ((default-value '(:eval (tab-line-format))))
    ;; Preserve the existing tab-line set outside of this mode
    (if (or (null tab-line-format)
            (equal tab-line-format default-value))
        (if tab-line-mode
            (setq tab-line-format default-value)
          (setq tab-line-format nil))
      (message "tab-line-format set outside of tab-line-mode, currently `%S'"
               tab-line-format))))