sponsor Vim development Vim logo Vim Book Ad

CursorLineCurrentWindow : Only highlight the screen line of the cursor in the currently active window.

 script karma  Rating 26/15, Downloaded by 1242  Comments, bugs, improvements  Vim wiki

created by
Ingo Karkat
 
script type
utility
 
description
DESCRIPTION
The 'cursorline' setting makes it easy to locate the cursor position. However,
when there are split windows, each one shows its cursor line, and the only
indication of the currently active window is the different 'statusline'
highlighting (with hl-StatusLine vs. hl-StatusLineNC).

This plugin avoids the clutter of multiple highlighted screen lines with split
windows by disabling the 'cursorline', 'cursorcolumn', and/or 'wincolor'
settings for all but the current window. Unlike a simplistic solution with a
few autocmds, this plugin still allows for exceptions like disabling the
cursorline for a particular window or making it permanent for (another)
window.

SEE ALSO
- The RelativeNumberCurrentWindow plugin (vimscript #4461) enables the
  'relativenumber' setting only for the current window.

RELATED WORKS
The basic idea is outlined in the Vim Tips Wiki:
    http://vim.wikia.com/wiki/Highlight_current_line
- cursorline_current.vim (vimscript #5740) enables cursorline only in the
  current window and when not in insert mode.

USAGE
Globally enable 'cursorline', 'cursorcolumn' and/or 'wincolor' in your
vimrc; e.g.
    :set cursorline cursorcolumn
After sourcing this plugin, the option(s) will only be active for the current
window. So with multiple split windows, only one of them, the one where the
cursor is in, will have 'cursorline' and 'cursorcolumn' enabled.

Disable cursorline for the current window via:
    :setlocal nocursorline
This will persist even after moving away and back to the window.

Disable cursorline globally via:
    :set nocursorline
As soon as you enter a window, its line highlighting will vanish.

For some kind of files it is helpful to keep the line highlighting active,
e.g. to serve as a ruler. You can keep the highlighting for a particular
window by setting a window-local variable:
    :let w:persistent_cursorline = 1
 
install details
INSTALLATION
The code is hosted in a Git repo at
    https://github.com/inkarkat/vim-CursorLineCurrentWindow
You can use your favorite plugin manager, or "git clone" into a directory used
for Vim packages. Releases are on the "stable" branch, the latest unstable
development snapshot on "master".

This script is also packaged as a vimball. If you have the "gunzip"
decompressor in your PATH, simply edit the *.vmb.gz package in Vim; otherwise,
decompress the archive first, e.g. using WinZip. Inside Vim, install by
sourcing the vimball or via the :UseVimball command.
    vim CursorLineCurrentWindow*.vmb.gz
    :so %
To uninstall, use the :RmVimball command.

DEPENDENCIES
- Requires Vim 7.0 or higher.

CONFIGURATION
For a permanent configuration, put the following commands into your vimrc:

By default, the plugin will localize any of 'cursorline', 'cursorcolumn', or
'wincolor' options, provided they are set during startup. To cover options
that may be set on demand or to drop a set option, the List of option names
can be overridden:
    let g:CursorLineCurrentWindow_OptionNames = ['cursorline']
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
CursorLineCurrentWindow-2.00.vmb.gz 2.00 2020-02-10 7.0 Ingo Karkat - ENH: Generalize to also handle 'cursorcolumn' and non-flag window options like (new in Vim 8.1.1391) 'wincolor'.
CursorLineCurrentWindow.vba.gz 1.00 2012-08-18 7.0 Ingo Karkat Initial upload
ip used for rating: 34.204.183.113

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
OSDN.net Logo