;;; mwheel.el --- Mouse support for MS intelli-mouse type mice
-;; Copyright (C) 1998, Free Software Foundation, Inc.
+;; Copyright (C) 1998, 2000, 2001 Free Software Foundation, Inc.
;; Maintainer: William M. Perry <wmperry@gnu.org>
;; Keywords: mouse
(require 'custom)
-(defcustom mwheel-scroll-amount '(5 . 1)
+;; Setter function for mouse-button user-options. Switch Mouse Wheel
+;; mode off and on again so that the old button is unbound and
+;; new button is bound to mwheel-scroll.
+
+(defun mouse-wheel-change-button (var button)
+ (set-default var button)
+ (when mouse-wheel-mode
+ (mouse-wheel-mode 0)
+ (mouse-wheel-mode 1)))
+
+(defcustom mouse-wheel-down-button 4
+ "Mouse button number for scrolling down."
+ :group 'mouse
+ :type 'integer
+ :set 'mouse-wheel-change-button)
+
+(defcustom mouse-wheel-up-button 5
+ "Mouse button number for scrolling up."
+ :group 'mouse
+ :type 'integer
+ :set 'mouse-wheel-change-button)
+
+(defcustom mouse-wheel-scroll-amount '(5 ((shift) . 1) ((control) . nil))
"Amount to scroll windows by when spinning the mouse wheel.
This is actually a cons cell, where the first item is the amount to scroll
-on a normal wheel event, and the second is the amount to scroll when the
-wheel is moved with the shift key depressed.
+on a normal wheel event, and the rest is an alist mapping the modifier key
+to the amount to scroll when the wheel is moved with the modifier key depressed.
Each item should be the number of lines to scroll, or `nil' for near
-full screen.
+full screen. It can also be a floating point number, specifying
+the fraction of the window to scroll.
A near full screen is `next-screen-context-lines' less than a full screen."
:group 'mouse
:type '(cons
(choice :tag "Normal"
(const :tag "Full screen" :value nil)
- (integer :tag "Specific # of lines"))
- (choice :tag "Shifted"
- (const :tag "Full screen" :value nil)
- (integer :tag "Specific # of lines"))))
+ (integer :tag "Specific # of lines")
+ (float :tag "Fraction of window"))
+ (repeat
+ (cons
+ (repeat (choice :tag "modifier" (const alt) (const control) (const hyper)
+ (const meta) (const shift) (const super)))
+ (choice :tag "scroll amount"
+ (const :tag "Full screen" :value nil)
+ (integer :tag "Specific # of lines")
+ (float :tag "Fraction of window"))))))
+
+(defcustom mouse-wheel-progessive-speed t
+ "If non-nil, the faster the user moves the wheel, the faster the scrolling.
+Note that this has no effect when `mouse-wheel-scroll-amount' specifies
+a \"near full screen\" scroll."
+ :group 'mouse
+ :type 'boolean)
-(defcustom mwheel-follow-mouse nil
+(defcustom mouse-wheel-follow-mouse nil
"Whether the mouse wheel should scroll the window that the mouse is over.
This can be slightly disconcerting, but some people may prefer it."
:group 'mouse
(fset 'mwheel-event-window 'event-window))
(defun mwheel-scroll (event)
+ "Scroll up or down according to the EVENT.
+This should only be bound to mouse buttons 4 and 5."
(interactive "e")
- (let ((curwin (if mwheel-follow-mouse
- (prog1
- (selected-window)
- (select-window (mwheel-event-window event)))))
- (amt (if (memq 'shift (event-modifiers event))
- (cdr mwheel-scroll-amount)
- (car mwheel-scroll-amount))))
+ (let* ((curwin (if mouse-wheel-follow-mouse
+ (prog1
+ (selected-window)
+ (select-window (mwheel-event-window event)))))
+ (mods
+ (delq 'click (delq 'double (delq 'triple (event-modifiers event)))))
+ (amt
+ (or (and mods
+ (cdr (assoc mods (cdr mouse-wheel-scroll-amount))))
+ (car mouse-wheel-scroll-amount))))
+ (if (floatp amt) (setq amt (1+ (truncate (* amt (window-height))))))
+ (when (and mouse-wheel-progessive-speed (numberp amt))
+ ;; When the double-mouse-N comes in, a mouse-N has been executed already,
+ ;; So by adding things up we get a squaring up (1, 3, 6, 10, 16, ...).
+ (setq amt (* amt (event-click-count event))))
(unwind-protect
(let ((button (mwheel-event-button event)))
- (cond ((= button 4) (scroll-down amt))
- ((= button 5) (scroll-up amt))
+ (cond ((= button mouse-wheel-down-button) (scroll-down amt))
+ ((= button mouse-wheel-up-button) (scroll-up amt))
(t (error "Bad binding in mwheel-scroll"))))
(if curwin (select-window curwin)))))
-;;; Note this definition must be at the end of the file, because
-;;; `define-minor-mode' actually calls the mode-function if the
-;;; associated variable is non-nil, which requires that all needed
-;;; functions be already defined.
;;;###autoload
(define-minor-mode mouse-wheel-mode
"Toggle mouse wheel support.
;; (S-)*mouse-[45], since those are aliases for the button
;; equivalents in XEmacs, but I want this to work in as many
;; versions of XEmacs as it can.
- (let* ((mwheel-running-xemacs (string-match "XEmacs" (emacs-version)))
- (keys (if mwheel-running-xemacs
- '(button4 [(shift button4)] button5 [(shift button5)])
- '([mouse-4] [S-mouse-4] [mouse-5] [S-mouse-5]))))
+ (let* ((prefix (if (featurep 'xemacs) "button%d" "mouse-%d"))
+ (dn (intern (format prefix mouse-wheel-down-button)))
+ (up (intern (format prefix mouse-wheel-up-button)))
+ (keys
+ (nconc (list (vector dn) (vector up))
+ (mapcar (lambda (amt) `[(,@(car amt) ,up)])
+ (cdr mouse-wheel-scroll-amount))
+ (mapcar (lambda (amt) `[(,@(car amt) ,dn)])
+ (cdr mouse-wheel-scroll-amount)))))
;; This condition-case is here because Emacs 19 will throw an error
;; if you try to define a key that it does not know about. I for one
;; prefer to just unconditionally do a mwheel-install in my .emacs, so
"Enable mouse wheel support."
(mouse-wheel-mode t))
-
(provide 'mwheel)
;;; mwheel.el ends here
HCoop / bpt / emacs.git / blobdiff