1993-03-17 16:56:02 +00:00
|
|
|
|
;;; scroll-bar.el --- window system-independent scroll bar support.
|
1993-01-14 14:52:32 +00:00
|
|
|
|
|
1995-04-07 02:21:52 +00:00
|
|
|
|
;;; Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc.
|
1993-01-14 14:52:32 +00:00
|
|
|
|
|
|
|
|
|
;; 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.
|
|
|
|
|
|
1993-03-17 17:17:05 +00:00
|
|
|
|
;;; Code:
|
|
|
|
|
|
1993-03-22 16:53:22 +00:00
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
|
|
;; Window-system-independent bindings of mouse clicks on the scroll bar.
|
|
|
|
|
;; Presently emulates the scroll-bar behavior of xterm.
|
|
|
|
|
;;; Code:
|
|
|
|
|
|
1993-01-26 01:58:16 +00:00
|
|
|
|
(require 'mouse)
|
|
|
|
|
|
1993-01-14 14:52:32 +00:00
|
|
|
|
|
|
|
|
|
;;;; Utilities.
|
|
|
|
|
|
1994-04-30 07:23:15 +00:00
|
|
|
|
(defun scroll-bar-event-ratio (event)
|
|
|
|
|
"Given a scroll bar event EVENT, return the scroll bar position as a ratio.
|
|
|
|
|
The value is a cons cell (PORTION . WHOLE) containing two integers
|
|
|
|
|
whose ratio gives the event's vertical position in the scroll bar, with 0
|
|
|
|
|
referring to the top and 1 to the bottom."
|
|
|
|
|
(nth 2 event))
|
|
|
|
|
|
1993-03-02 07:29:47 +00:00
|
|
|
|
(defun scroll-bar-scale (num-denom whole)
|
1993-01-14 14:52:32 +00:00
|
|
|
|
"Given a pair (NUM . DENOM) and WHOLE, return (/ (* NUM WHOLE) DENOM).
|
1993-03-02 07:29:47 +00:00
|
|
|
|
This is handy for scaling a position on a scroll bar into real units,
|
|
|
|
|
like buffer positions. If SCROLL-BAR-POS is the (PORTION . WHOLE) pair
|
|
|
|
|
from a scroll bar event, then (scroll-bar-scale SCROLL-BAR-POS
|
1993-01-14 14:52:32 +00:00
|
|
|
|
\(buffer-size)) is the position in the current buffer corresponding to
|
1993-03-02 07:29:47 +00:00
|
|
|
|
that scroll bar position."
|
1993-01-14 14:52:32 +00:00
|
|
|
|
;; We multiply before we divide to maintain precision.
|
|
|
|
|
;; We use floating point because the product of a large buffer size
|
1993-03-02 07:29:47 +00:00
|
|
|
|
;; with a large scroll bar portion can easily overflow a lisp int.
|
1993-01-14 14:52:32 +00:00
|
|
|
|
(truncate (/ (* (float (car num-denom)) whole) (cdr num-denom))))
|
|
|
|
|
|
|
|
|
|
|
1993-02-25 00:38:55 +00:00
|
|
|
|
;;;; Helpful functions for enabling and disabling scroll bars.
|
|
|
|
|
|
|
|
|
|
(defun scroll-bar-mode (flag)
|
|
|
|
|
"Toggle display of vertical scroll bars on each frame.
|
|
|
|
|
This command applies to all frames that exist and frames to be
|
|
|
|
|
created in the future.
|
|
|
|
|
With a numeric argument, if the argument is negative,
|
|
|
|
|
turn off scroll bars; otherwise, turn on scroll bars."
|
|
|
|
|
(interactive "P")
|
1993-08-06 21:03:45 +00:00
|
|
|
|
(if flag (setq flag (prefix-numeric-value flag)))
|
1993-06-10 12:18:36 +00:00
|
|
|
|
|
|
|
|
|
;; Obtain the current setting by looking at default-frame-alist.
|
|
|
|
|
(let ((scroll-bar-mode
|
|
|
|
|
(let ((assq (assq 'vertical-scroll-bars default-frame-alist)))
|
|
|
|
|
(if assq (cdr assq) t))))
|
|
|
|
|
|
|
|
|
|
;; Tweedle it according to the argument.
|
|
|
|
|
(setq scroll-bar-mode (if (null flag) (not scroll-bar-mode)
|
|
|
|
|
(or (not (numberp flag)) (>= flag 0))))
|
|
|
|
|
|
|
|
|
|
;; Apply it to default-frame-alist.
|
|
|
|
|
(mapcar
|
|
|
|
|
(function
|
|
|
|
|
(lambda (param-name)
|
|
|
|
|
(let ((parameter (assq param-name default-frame-alist)))
|
|
|
|
|
(if (consp parameter)
|
|
|
|
|
(setcdr parameter scroll-bar-mode)
|
|
|
|
|
(setq default-frame-alist
|
|
|
|
|
(cons (cons param-name scroll-bar-mode)
|
|
|
|
|
default-frame-alist))))))
|
|
|
|
|
'(vertical-scroll-bars horizontal-scroll-bars))
|
|
|
|
|
|
|
|
|
|
;; Apply it to existing frames.
|
|
|
|
|
(let ((frames (frame-list)))
|
|
|
|
|
(while frames
|
|
|
|
|
(modify-frame-parameters
|
|
|
|
|
(car frames)
|
|
|
|
|
(list (cons 'vertical-scroll-bars scroll-bar-mode)
|
|
|
|
|
(cons 'horizontal-scroll-bars scroll-bar-mode)))
|
|
|
|
|
(setq frames (cdr frames))))))
|
1993-02-25 00:38:55 +00:00
|
|
|
|
|
1993-03-02 07:29:47 +00:00
|
|
|
|
;;;; Buffer navigation using the scroll bar.
|
1993-01-14 14:52:32 +00:00
|
|
|
|
|
1993-05-08 23:49:17 +00:00
|
|
|
|
;;; This was used for up-events on button 2, but no longer.
|
1993-03-02 07:29:47 +00:00
|
|
|
|
(defun scroll-bar-set-window-start (event)
|
|
|
|
|
"Set the window start according to where the scroll bar is dragged.
|
|
|
|
|
EVENT should be a scroll bar click or drag event."
|
1993-01-14 14:52:32 +00:00
|
|
|
|
(interactive "e")
|
1993-01-26 01:58:16 +00:00
|
|
|
|
(let* ((end-position (event-end event))
|
1993-01-14 14:52:32 +00:00
|
|
|
|
(window (nth 0 end-position))
|
|
|
|
|
(portion-whole (nth 2 end-position)))
|
|
|
|
|
(save-excursion
|
|
|
|
|
(set-buffer (window-buffer window))
|
|
|
|
|
(save-excursion
|
1993-06-09 09:44:24 +00:00
|
|
|
|
(goto-char (+ (point-min)
|
|
|
|
|
(scroll-bar-scale portion-whole
|
|
|
|
|
(- (point-max) (point-min)))))
|
1993-01-14 14:52:32 +00:00
|
|
|
|
(beginning-of-line)
|
|
|
|
|
(set-window-start window (point))))))
|
|
|
|
|
|
1993-05-08 23:49:17 +00:00
|
|
|
|
;; Scroll the window to the proper position for EVENT.
|
|
|
|
|
(defun scroll-bar-drag-1 (event)
|
|
|
|
|
(let* ((start-position (event-start event))
|
|
|
|
|
(window (nth 0 start-position))
|
|
|
|
|
(portion-whole (nth 2 start-position)))
|
|
|
|
|
(save-excursion
|
|
|
|
|
(set-buffer (window-buffer window))
|
1993-06-05 20:58:47 +00:00
|
|
|
|
;; Calculate position relative to the accessible part of the buffer.
|
|
|
|
|
(goto-char (+ (point-min)
|
|
|
|
|
(scroll-bar-scale portion-whole
|
|
|
|
|
(- (point-max) (point-min)))))
|
1993-05-08 23:49:17 +00:00
|
|
|
|
(beginning-of-line)
|
|
|
|
|
(set-window-start window (point)))))
|
|
|
|
|
|
|
|
|
|
(defun scroll-bar-drag (event)
|
|
|
|
|
"Scroll the window by dragging the scroll bar slider.
|
|
|
|
|
If you click outside the slider, the window scrolls to bring the slider there."
|
|
|
|
|
(interactive "e")
|
1995-03-28 17:42:27 +00:00
|
|
|
|
(let* (done
|
|
|
|
|
(echo-keystrokes 0))
|
1995-01-26 07:17:31 +00:00
|
|
|
|
(or point-before-scroll
|
|
|
|
|
(setq point-before-scroll (point)))
|
1993-05-08 23:49:17 +00:00
|
|
|
|
(scroll-bar-drag-1 event)
|
1995-01-26 07:17:31 +00:00
|
|
|
|
(let (point-before-scroll)
|
|
|
|
|
(track-mouse
|
|
|
|
|
(while (not done)
|
|
|
|
|
(setq event (read-event))
|
|
|
|
|
(if (eq (car-safe event) 'mouse-movement)
|
|
|
|
|
(setq event (read-event)))
|
|
|
|
|
(cond ((eq (car-safe event) 'scroll-bar-movement)
|
|
|
|
|
(scroll-bar-drag-1 event))
|
|
|
|
|
(t
|
|
|
|
|
;; Exit when we get the drag event; ignore that event.
|
|
|
|
|
(setq done t))))))))
|
1993-05-08 23:49:17 +00:00
|
|
|
|
|
1993-03-02 07:29:47 +00:00
|
|
|
|
(defun scroll-bar-scroll-down (event)
|
|
|
|
|
"Scroll the window's top line down to the location of the scroll bar click.
|
|
|
|
|
EVENT should be a scroll bar click."
|
1993-01-14 14:52:32 +00:00
|
|
|
|
(interactive "e")
|
|
|
|
|
(let ((old-selected-window (selected-window)))
|
|
|
|
|
(unwind-protect
|
|
|
|
|
(progn
|
1993-01-26 01:58:16 +00:00
|
|
|
|
(let* ((end-position (event-end event))
|
1993-01-14 14:52:32 +00:00
|
|
|
|
(window (nth 0 end-position))
|
|
|
|
|
(portion-whole (nth 2 end-position)))
|
1995-01-26 07:17:31 +00:00
|
|
|
|
(let (point-before-scroll)
|
|
|
|
|
(select-window window))
|
|
|
|
|
(or point-before-scroll
|
|
|
|
|
(setq point-before-scroll (point)))
|
|
|
|
|
(let (point-before-scroll)
|
|
|
|
|
(scroll-down
|
|
|
|
|
(scroll-bar-scale portion-whole (1- (window-height)))))))
|
1993-01-14 14:52:32 +00:00
|
|
|
|
(select-window old-selected-window))))
|
|
|
|
|
|
1993-03-02 07:29:47 +00:00
|
|
|
|
(defun scroll-bar-scroll-up (event)
|
|
|
|
|
"Scroll the line next to the scroll bar click to the top of the window.
|
|
|
|
|
EVENT should be a scroll bar click."
|
1993-01-14 14:52:32 +00:00
|
|
|
|
(interactive "e")
|
|
|
|
|
(let ((old-selected-window (selected-window)))
|
|
|
|
|
(unwind-protect
|
|
|
|
|
(progn
|
1993-01-26 01:58:16 +00:00
|
|
|
|
(let* ((end-position (event-end event))
|
1993-01-14 14:52:32 +00:00
|
|
|
|
(window (nth 0 end-position))
|
|
|
|
|
(portion-whole (nth 2 end-position)))
|
1995-01-26 07:17:31 +00:00
|
|
|
|
(let (point-before-scroll)
|
|
|
|
|
(select-window window))
|
|
|
|
|
(or point-before-scroll
|
|
|
|
|
(setq point-before-scroll (point)))
|
|
|
|
|
(let (point-before-scroll)
|
|
|
|
|
(scroll-up
|
|
|
|
|
(scroll-bar-scale portion-whole (1- (window-height)))))))
|
1993-01-14 14:52:32 +00:00
|
|
|
|
(select-window old-selected-window))))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Bindings.
|
|
|
|
|
|
|
|
|
|
;;; For now, we'll set things up to work like xterm.
|
1993-03-02 07:29:47 +00:00
|
|
|
|
(global-set-key [vertical-scroll-bar mouse-1] 'scroll-bar-scroll-up)
|
|
|
|
|
(global-set-key [vertical-scroll-bar drag-mouse-1] 'scroll-bar-scroll-up)
|
1993-01-14 14:52:32 +00:00
|
|
|
|
|
1993-05-08 23:49:17 +00:00
|
|
|
|
(global-set-key [vertical-scroll-bar down-mouse-2] 'scroll-bar-drag)
|
|
|
|
|
|
1993-03-02 07:29:47 +00:00
|
|
|
|
(global-set-key [vertical-scroll-bar mouse-3] 'scroll-bar-scroll-down)
|
|
|
|
|
(global-set-key [vertical-scroll-bar drag-mouse-3] 'scroll-bar-scroll-down)
|
1993-01-14 14:52:32 +00:00
|
|
|
|
|
|
|
|
|
|
1993-03-02 02:11:18 +00:00
|
|
|
|
(provide 'scroll-bar)
|
1993-01-14 14:52:32 +00:00
|
|
|
|
|
1993-03-02 07:29:47 +00:00
|
|
|
|
;;; scroll-bar.el ends here
|