;;; mwheel.el --- Mouse support for MS intelli-mouse type mice
-;; Copyright (C) 1998, 2000, 2001 Free Software Foundation, Inc.
+;; Copyright (C) 1998,2000,2001,2002 Free Software Foundation, Inc.
;; Maintainer: William M. Perry <wmperry@gnu.org>
;; Keywords: mouse
;; 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)))
+ (let ((active mouse-wheel-mode))
+ ;; Deactivate before changing the setting.
+ (when active (mouse-wheel-mode -1))
+ (set-default var button)
+ (when active (mouse-wheel-mode 1))))
(defcustom mouse-wheel-down-button 4
- "Mouse button number for scrolling down."
+ "Obsolete. Use `mouse-wheel-down-event'.")
+(defcustom mouse-wheel-down-event
+ ;; In the latest versions of XEmacs, we could just use mouse-%s as well.
+ (intern (format (if (featurep 'xemacs) "button%s" "mouse-%s")
+ mouse-wheel-down-button))
+ "Event used for scrolling down."
:group 'mouse
- :type 'integer
+ :type 'symbol
:set 'mouse-wheel-change-button)
(defcustom mouse-wheel-up-button 5
- "Mouse button number for scrolling up."
+ "Obsolete. Use `mouse-wheel-up-event'.")
+(defcustom mouse-wheel-up-event
+ ;; In the latest versions of XEmacs, we could just use mouse-%s as well.
+ (intern (format (if (featurep 'xemacs) "button%s" "mouse-%s")
+ mouse-wheel-up-button))
+ "Event used for scrolling down."
:group 'mouse
- :type 'integer
+ :type 'symbol
: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 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. 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."
+This is an alist mapping the modifier key to the amount to scroll when
+the wheel is moved with the modifier key depressed.
+Elements of the list have the form (MODIFIERS . AMOUNT) or just AMOUNT if
+MODIFIERS is nil.
+
+AMOUNT should be the number of lines to scroll, or `nil' for near full
+screen. It can also be a floating point number, specifying the fraction of
+a full screen 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")
- (float :tag "Fraction of window"))
+ (float :tag "Fraction of window")
+ (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"))))
(repeat
(cons
- (repeat (choice :tag "modifier" (const alt) (const control) (const hyper)
+ (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)
(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."
+a \"near full screen\" scroll or when the mouse wheel sends key instead
+of button events."
:group 'mouse
:type 'boolean)
-(defcustom mouse-wheel-follow-mouse nil
+(defcustom mouse-wheel-follow-mouse t
"Whether the mouse wheel should scroll the window that the mouse is over.
-This can be slightly disconcerting, but some people may prefer it."
+This can be slightly disconcerting, but some people prefer it."
:group 'mouse
:type 'boolean)
(if (not (fboundp 'event-button))
(defun mwheel-event-button (event)
- (let ((x (symbol-name (event-basic-type event))))
+ (let ((x (event-basic-type event)))
;; Map mouse-wheel events to appropriate buttons
- (if (string-equal "mouse-wheel" x)
+ (if (eq 'mouse-wheel x)
(let ((amount (car (cdr (cdr (cdr event))))))
(if (< amount 0)
- mouse-wheel-up-button
- mouse-wheel-down-button))
- (if (not (string-match "^mouse-\\([0-9]+\\)" x))
- (error "Not a button event: %S" event)
- (string-to-int (substring x (match-beginning 1) (match-end 1)))))))
- (fset 'mwheel-event-button 'event-button))
+ mouse-wheel-up-event
+ mouse-wheel-down-event))
+ x)))
+ (fset 'mwheel-event-button 'event-button))
(if (not (fboundp 'event-window))
(defun mwheel-event-window (event)
(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")
+ (interactive (list last-input-event))
(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
- (if mods
- (cdr (assoc mods (cdr mouse-wheel-scroll-amount)))
- (car mouse-wheel-scroll-amount))))
+ (amt (assoc mods mouse-wheel-scroll-amount)))
+ ;; Extract the actual amount or find the element that has no modifiers.
+ (if amt (setq amt (cdr amt))
+ (let ((list-elt mouse-wheel-scroll-amount))
+ (while (consp (setq amt (pop list-elt))))))
(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, ...).
+ ;; So by adding things up we get a squaring up (1, 3, 6, 10, 15, ...).
(setq amt (* amt (event-click-count event))))
(unwind-protect
(let ((button (mwheel-event-button event)))
- (cond ((= button mouse-wheel-down-button) (scroll-down amt))
- ((= button mouse-wheel-up-button) (scroll-up amt))
+ (cond ((eq button mouse-wheel-down-event) (scroll-down amt))
+ ((eq button mouse-wheel-up-event) (scroll-up amt))
(t (error "Bad binding in mwheel-scroll"))))
(if curwin (select-window curwin)))))
Returns non-nil if the new state is enabled."
:global t
:group 'mouse
- ;; In the latest versions of XEmacs, we could just use
- ;; (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* ((prefix (if (featurep 'xemacs) "button%d" "mouse-%d"))
- (dn (intern (format prefix mouse-wheel-down-button)))
- (up (intern (format prefix mouse-wheel-up-button)))
+ (let* ((dn mouse-wheel-down-event)
+ (up mouse-wheel-up-event)
(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)))))
+ (nconc (mapcar (lambda (amt) `[(,@(if (consp amt) (car amt)) ,up)])
+ mouse-wheel-scroll-amount)
+ (mapcar (lambda (amt) `[(,@(if (consp amt) (car amt)) ,dn)])
+ 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
;;;###autoload
(defun mwheel-install (&optional uninstall)
"Enable mouse wheel support."
- (mouse-wheel-mode t))
+ (mouse-wheel-mode (if uninstall -1 1)))
(provide 'mwheel)
HCoop / bpt / emacs.git / blobdiff