Variable: global-hl-line-sticky-flag

global-hl-line-sticky-flag is a customizable variable defined in hl-line.el.gz.

Value

nil

Documentation

Non-nil means the Global HL-Line mode highlight appears in all windows.

Otherwise Global Hl-Line mode will highlight only in the selected window.

The value t affects only the case when the current buffer is displayed in several windows - then the current line of the selected window is indicated in non-selected windows.

If the value is all, the Global HL-Line mode affects all windows. This means that even when point moves in a non-selected window that displays another buffer, the new position will be updated to highlight the current line of other buffers.

If the value is window, then instead of highlighting the line with buffer's point, the Global HL-Line mode highlights the line with window's point that might differ from the buffer's point when the buffer is displayed in multiple windows.

Setting this variable takes effect the next time you use the command global-hl-line-mode(var)/global-hl-line-mode(fun) to turn Global Hl-Line mode on.

This variable was added, or its default value changed, in Emacs 24.1.

Probably introduced at or before Emacs version 31.1.

Source Code

;; Defined in /usr/src/emacs/lisp/hl-line.el.gz
(defcustom global-hl-line-sticky-flag nil
  "Non-nil means the Global HL-Line mode highlight appears in all windows.
Otherwise Global Hl-Line mode will highlight only in the selected
window.

The value t affects only the case when the current buffer is displayed
in several windows - then the current line of the selected window
is indicated in non-selected windows.

If the value is `all', the Global HL-Line mode affects all windows.
This means that even when point moves in a non-selected window
that displays another buffer, the new position will be updated
to highlight the current line of other buffers.

If the value is `window', then instead of highlighting the line
with buffer's point, the Global HL-Line mode highlights the line
with window's point that might differ from the buffer's point
when the buffer is displayed in multiple windows.

Setting this variable takes effect the next time you use
the command `global-hl-line-mode' to turn Global Hl-Line mode on."
  :type '(choice (const :tag "Disable" nil)
                 (const :tag "Enable for buffer in multiple windows" t)
                 (const :tag "Enable and update in all windows" all)
                 (const :tag "Highlight window-point lines" window))
  :version "24.1"
  :group 'hl-line)