annotate lisp/mwheel.el @ 265:8efd647ea9ca r20-5b31

Import from CVS: tag r20-5b31
author cvs
date Mon, 13 Aug 2007 10:25:37 +0200
parents 727739f917cb
children a4f53d9b3154
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
263
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
1 ;;; mwheel.el --- Mouse support for MS intelli-mouse type mice
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
2
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
3 ;; Copyright (C) 1998, Free Software Foundation, Inc.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
4 ;; Maintainer: William M. Perry <wmperry@cs.indiana.edu>
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
5 ;; Keywords: mouse
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
6
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
7 ;; This file is part of XEmacs.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
8
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
9 ;; XEmacs is free software; you can redistribute it and/or modify it
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
10 ;; under the terms of the GNU General Public License as published by
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
11 ;; the Free Software Foundation; either version 2, or (at your option)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
12 ;; any later version.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
13
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
14 ;; XEmacs is distributed in the hope that it will be useful, but
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
15 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
17 ;; General Public License for more details.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
18
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
19 ;; You should have received a copy of the GNU General Public License
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
20 ;; along with XEmacs; see the file COPYING. If not, write to the
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
22 ;; Boston, MA 02111-1307, USA.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
23
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
24 ;;; Synched up with: Not synched.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
25
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
26 ;;; Commentary:
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
27
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
28 ;; This code will enable the use of the infamous 'wheel' on the new
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
29 ;; crop of mice. Under XFree86 and the XSuSE X Servers, the wheel
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
30 ;; events are sent as button4/button5 events.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
31
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
32 ;; I for one would prefer some way of converting the button4/button5
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
33 ;; events into different event types, like 'mwheel-up' or
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
34 ;; 'mwheel-down', but I cannot find a way to do this very easily (or
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
35 ;; portably), so for now I just live with it.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
36
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
37 ;; To enable this code, simply put this at the top of your .emacs
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
38 ;; file:
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
39 ;;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
40 ;; (autoload 'mwheel-install "mwheel" "Enable mouse wheel support.")
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
41 ;; (mwheel-install)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
42
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
43 ;;; Code:
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
44
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
45 (require 'custom)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
46 (require 'cl)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
47
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
48 (defcustom mwheel-scroll-amount '(5 . 1)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
49 "Amount to scroll windows by when spinning the mouse wheel.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
50 This is actually a cons cell, where the first item is the amount to scroll
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
51 on a normal wheel event, and the second is the amount to scroll when the
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
52 wheel is moved with the shift key depressed.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
53
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
54 Each item should be the number of lines to scroll, or `nil' for near
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
55 full screen.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
56 A near full screen is `next-screen-context-lines' less than a full screen."
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
57 :group 'mouse
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
58 :type '(cons
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
59 (choice :tag "Normal"
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
60 (const :tag "Full screen" :value nil)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
61 (integer :tag "Specific # of lines"))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
62 (choice :tag "Shifted"
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
63 (const :tag "Full screen" :value nil)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
64 (integer :tag "Specific # of lines"))))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
65
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
66 (defcustom mwheel-follow-mouse nil
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
67 "Whether the mouse wheel should scroll the window that the mouse is over.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
68 This can be slightly disconcerting, but some people may prefer it."
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
69 :group 'mouse
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
70 :type 'boolean)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
71
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
72 (if (not (fboundp 'event-button))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
73 (defun mwheel-event-button (event)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
74 (let ((x (symbol-name (event-basic-type event))))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
75 (if (not (string-match "^mouse-\\([0-9]+\\)" x))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
76 (error "Not a button event: %S" event))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
77 (string-to-int (substring x (match-beginning 1) (match-end 1)))))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
78 (fset 'mwheel-event-button 'event-button))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
79
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
80 (if (not (fboundp 'event-window))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
81 (defun mwheel-event-window (event)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
82 (posn-window (event-start event)))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
83 (fset 'mwheel-event-window 'event-window))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
84
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
85 (defun mwheel-scroll (event)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
86 (interactive "e")
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
87 (let ((curwin (if mwheel-follow-mouse
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
88 (prog1
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
89 (selected-window)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
90 (select-window (mwheel-event-window event)))))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
91 (amt (if (memq 'shift (event-modifiers event))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
92 (cdr mwheel-scroll-amount)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
93 (car mwheel-scroll-amount))))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
94 (case (mwheel-event-button event)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
95 (4 (scroll-down amt))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
96 (5 (scroll-up amt))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
97 (otherwise (error "Bad binding in mwheel-scroll")))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
98 (if curwin (select-window curwin))))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
99
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
100 ;;;###autoload
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
101 (defun mwheel-install ()
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
102 "Enable mouse wheel support."
265
8efd647ea9ca Import from CVS: tag r20-5b31
cvs
parents: 263
diff changeset
103 (let ((keys '([(mouse-4)] [(shift mouse-4)] [(mouse-5)] [(shift mouse-5)])))
263
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
104 ;; This condition-case is here because Emacs 19 will throw an error
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
105 ;; if you try to define a key that it does not know about. I for one
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
106 ;; prefer to just unconditionally do a mwheel-install in my .emacs, so
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
107 ;; that if the wheeled-mouse is there, it just works, and this way it
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
108 ;; doesn't yell at me if I'm on my laptop or another machine, etc.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
109 (condition-case ()
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
110 (while keys
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
111 (define-key global-map (car keys) 'mwheel-scroll)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
112 (setq keys (cdr keys)))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
113 (error nil))))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
114
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
115 (provide 'mwheel)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
116
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
117 ;;; mwheel.el ends here