view lisp/scroll-bar.el @ 1803:5752a95053f2

* xterm.c (x_window_to_scrollbar): Search frames' condemned_scrollbars list as well; input might arrive during redisplay. (x_scrollbar_report_motion): Don't forget to BLOCK_INPUT. (XTjudge_scrollbars): Clear the condemned scrollbar list before traversing it, so we don't try to process an event on a scrollbar we've killed.

;;; scrollbar.el -- window system-independent scrollbar support.

;;; Copyright (C) 1993 Free Software Foundation, Inc.

;; Maintainer: FSF
;; Keywords: hardware

;;; This file is part of GNU Emacs.

;;; GNU Emacs is free software; you can redistribute it and/or modify
;;; it under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 2, or (at your option)
;;; any later version.

;;; GNU Emacs is distributed in the hope that it will be useful,
;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.

;;; You should have received a copy of the GNU General Public License
;;; along with GNU Emacs; see the file COPYING.  If not, write to
;;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.


;;;; Utilities.

(defun scrollbar-scale (num-denom whole)
  "Given a pair (NUM . DENOM) and WHOLE, return (/ (* NUM WHOLE) DENOM).
This is handy for scaling a position on a scrollbar into real units,
like buffer positions.  If SCROLLBAR-POS is the (PORTION . WHOLE) pair
from a scrollbar event, then (scrollbar-scale SCROLLBAR-POS
\(buffer-size)) is the position in the current buffer corresponding to
that scrollbar position."
  ;; We multiply before we divide to maintain precision.
  ;; We use floating point because the product of a large buffer size
  ;; with a large scrollbar portion can easily overflow a lisp int.
  (truncate (/ (* (float (car num-denom)) whole) (cdr num-denom))))


;;;; Buffer navigation using the scrollbar.

(defun scrollbar-set-window-start (event)
  "Set the window start according to where the scrollbar is dragged.
EVENT should be a scrollbar click or drag event."
  (interactive "e")
  (let* ((end-position (nth (1- (length event)) event))
	 (window (nth 0 end-position))
	 (portion-whole (nth 2 end-position)))
    (save-excursion
      (set-buffer (window-buffer window))
      (save-excursion
	(goto-char (scrollbar-scale portion-whole (buffer-size)))
	(beginning-of-line)
	(set-window-start window (point))))))

(defun scrollbar-scroll-down (event)
  "Scroll the window's top line down to the location of the scrollbar click.
EVENT should be a scrollbar click."
  (interactive "e")
  (let ((old-selected-window (selected-window)))
    (unwind-protect
	(progn
	  (let* ((end-position (nth (1- (length event)) event))
		 (window (nth 0 end-position))
		 (portion-whole (nth 2 end-position)))
	    (select-window window)
	    (scroll-down
	     (scrollbar-scale portion-whole (1- (window-height))))))
      (select-window old-selected-window))))

(defun scrollbar-scroll-up (event)
  "Scroll the line next to the scrollbar click to the top of the window.
EVENT should be a scrollbar click."
  (interactive "e")
  (let ((old-selected-window (selected-window)))
    (unwind-protect
	(progn
	  (let* ((end-position (nth (1- (length event)) event))
		 (window (nth 0 end-position))
		 (portion-whole (nth 2 end-position)))
	    (select-window window)
	    (scroll-up
	     (scrollbar-scale portion-whole (1- (window-height))))))
      (select-window old-selected-window))))


;;;; Bindings.

;;; For now, we'll set things up to work like xterm.
(global-set-key [vertical-scrollbar mouse-1] 'scrollbar-scroll-up)
(global-set-key [vertical-scrollbar drag-mouse-1] 'scrollbar-scroll-up)

(global-set-key [vertical-scrollbar mouse-2] 'scrollbar-set-window-start)
(global-set-key [vertical-scrollbar drag-mouse-2] 'scrollbar-set-window-start)
      
(global-set-key [vertical-scrollbar mouse-3] 'scrollbar-scroll-down)
(global-set-key [vertical-scrollbar drag-mouse-3] 'scrollbar-scroll-down)


(provide 'scrollbar)

;;; scrollbar.el ends here