]> code.delx.au - gnu-emacs/blobdiff - lisp/hl-line.el
Simplify url handling in rcirc-mode
[gnu-emacs] / lisp / hl-line.el
index 7900cde488545e23712b98409f4d07e0dccb5988..846f5f95187eb580622e20278140102b25f6c0c4 100644 (file)
@@ -1,12 +1,11 @@
 ;;; hl-line.el --- highlight the current line
 
-;; Copyright (C) 1998, 2000, 2001, 2002, 2003, 2004,
-;;   2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
+;; Copyright (C) 1998, 2000-2011  Free Software Foundation, Inc.
 
 ;; Author:  Dave Love <fx@gnu.org>
 ;; Maintainer: FSF
 ;; Created: 1998-09-13
-;; Keywords: faces, frames, emulation
+;; Keywords: faces, frames, emulations
 
 ;; This file is part of GNU Emacs.
 
@@ -72,7 +71,7 @@
 (defgroup hl-line nil
   "Highlight the current line."
   :version "21.1"
-  :group 'editing)
+  :group 'convenience)
 
 (defface hl-line
   '((t :inherit highlight))
           (overlay-put global-hl-line-overlay 'face hl-line-face))))
 
 (defcustom hl-line-sticky-flag t
-  "Non-nil means highlight the current line in all windows.
+  "Non-nil means the HL-Line mode highlight appears in all windows.
 Otherwise Hl-Line mode will highlight only in the selected
 window.  Setting this variable takes effect the next time you use
-the command `hl-line-mode' to turn Hl-Line mode on."
+the command `hl-line-mode' to turn Hl-Line mode on.
+
+This variable has no effect in Global Highlight Line mode.
+For that, use `global-hl-line-sticky-flag'."
   :type 'boolean
   :version "22.1"
   :group 'hl-line)
 
+(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.  Setting this variable takes effect the next time you use
+the command `global-hl-line-mode' to turn Global Hl-Line mode on."
+  :type 'boolean
+  :version "24.1"
+  :group 'hl-line)
+
 (defvar hl-line-range-function nil
   "If non-nil, function to call to return highlight range.
 The function of no args should return a cons cell; its car value
@@ -163,6 +174,10 @@ addition to `hl-line-highlight' on `post-command-hook'."
   "Global minor mode to highlight the line about point in the current window.
 With ARG, turn Global-Hl-Line mode on if ARG is positive, off otherwise.
 
+If `global-hl-line-sticky-flag' is non-nil, Global Hl-Line mode
+highlights the line about the current buffer's point in all
+windows.
+
 Global-Hl-Line mode uses the functions `global-hl-line-unhighlight' and
 `global-hl-line-highlight' on `pre-command-hook' and `post-command-hook'."
   :global t
@@ -176,13 +191,15 @@ Global-Hl-Line mode uses the functions `global-hl-line-unhighlight' and
     (remove-hook 'post-command-hook #'global-hl-line-highlight)))
 
 (defun global-hl-line-highlight ()
-  "Active the Global-Hl-Line overlay on the current line in the current window."
+  "Highlight the current line in the current window."
   (when global-hl-line-mode    ; Might be changed outside the mode function.
     (unless (window-minibuffer-p (selected-window))
       (unless global-hl-line-overlay
         (setq global-hl-line-overlay (make-overlay 1 1)) ; to be moved
         (overlay-put global-hl-line-overlay 'face hl-line-face))
-      (overlay-put global-hl-line-overlay 'window (selected-window))
+      (overlay-put global-hl-line-overlay 'window
+                  (unless global-hl-line-sticky-flag
+                    (selected-window)))
       (hl-line-move global-hl-line-overlay))))
 
 (defun global-hl-line-unhighlight ()
@@ -219,5 +236,4 @@ the line including the point by OVERLAY."
 
 (provide 'hl-line)
 
-;; arch-tag: ac806940-0876-4959-8c89-947563ee2833
 ;;; hl-line.el ends here