annotate lisp/events.el @ 321:19dcec799385 r21-0-58

Import from CVS: tag r21-0-58
author cvs
date Mon, 13 Aug 2007 10:46:44 +0200
parents 41ff10fd062f
children cc15677e0335
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
209
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
1 ;;; events.el --- event functions for XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
2
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
3 ;; Copyright (C) 1997 Free Software Foundation, Inc.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
4 ;; Copyright (C) 1996-7 Sun Microsystems, Inc.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
5 ;; Copyright (C) 1996 Ben Wing.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
6
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
7 ;; Maintainer: Martin Buchholz
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
8 ;; Keywords: internal, event, dumped
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
9
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
10 ;; This file is part of XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
11
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
12 ;; XEmacs is free software; you can redistribute it and/or modify it
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
13 ;; under the terms of the GNU General Public License as published by
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
14 ;; the Free Software Foundation; either version 2, or (at your option)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
15 ;; any later version.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
16
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
17 ;; XEmacs is distributed in the hope that it will be useful, but
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
20 ;; General Public License for more details.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
21
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
22 ;; You should have received a copy of the GNU General Public License
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
23 ;; along with XEmacs; see the file COPYING. If not, write to the
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
24 ;; Free Software Foundation, 59 Temple Place - Suite 330,
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
25 ;; Boston, MA 02111-1307, USA.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
26
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
27 ;;; Synched up with: Not in FSF.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
28
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
29 ;;; Commentary:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
30
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
31 ;; This file is dumped with XEmacs.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
32
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
33 ;;; Code:
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
34
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
35
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
36 (defun event-console (event)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
37 "Return the console that EVENT occurred on.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
38 This will be nil for some types of events (e.g. eval events)."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
39 (cdfw-console (event-channel event)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
40
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
41 (defun event-device (event)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
42 "Return the device that EVENT occurred on.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
43 This will be nil for some types of events (e.g. keyboard and eval events)."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
44 (dfw-device (event-channel event)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
45
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
46 (defun event-frame (event)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
47 "Return the frame that EVENT occurred on.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
48 This will be nil for some types of events (e.g. keyboard and eval events)."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
49 (fw-frame (event-channel event)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
50
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
51 (defun event-buffer (event)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
52 "Return the buffer of the window over which mouse event EVENT occurred.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
53 Return nil unless both (mouse-event-p EVENT) and
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
54 (event-over-text-area-p EVENT) are non-nil."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
55 (let ((window (event-window event)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
56 (and (windowp window) (window-buffer window))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
57
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
58 (defalias 'allocate-event 'make-event)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
59
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
60
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
61 (defun key-press-event-p (object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
62 "Return t if OBJECT is a key-press event."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
63 (and (event-live-p object) (eq 'key-press (event-type object))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
64
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
65 (defun button-press-event-p (object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
66 "Return t if OBJECT is a mouse button-press event."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
67 (and (event-live-p object) (eq 'button-press (event-type object))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
68
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
69 (defun button-release-event-p (object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
70 "Return t if OBJECT is a mouse button-release event."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
71 (and (event-live-p object) (eq 'button-release (event-type object))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
72
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
73 (defun button-event-p (object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
74 "Return t if OBJECT is a mouse button-press or button-release event."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
75 (and (event-live-p object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
76 (memq (event-type object) '(button-press button-release))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
77 t))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
78
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
79 (defun motion-event-p (object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
80 "Return t if OBJECT is a mouse motion event."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
81 (and (event-live-p object) (eq 'motion (event-type object))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
82
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
83 (defun mouse-event-p (object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
84 "Return t if OBJECT is a mouse button-press, button-release or motion event."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
85 (and (event-live-p object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
86 (memq (event-type object) '(button-press button-release motion))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
87 t))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
88
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
89 (defun process-event-p (object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
90 "Return t if OBJECT is a process-output event."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
91 (and (event-live-p object) (eq 'process (event-type object))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
92
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
93 (defun timeout-event-p (object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
94 "Return t if OBJECT is a timeout event."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
95 (and (event-live-p object) (eq 'timeout (event-type object))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
96
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
97 (defun eval-event-p (object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
98 "Return t if OBJECT is an eval event."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
99 (and (event-live-p object) (eq 'eval (event-type object))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
100
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
101 (defun misc-user-event-p (object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
102 "Return t if OBJECT is a misc-user event.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
103 A misc-user event is a user event that is not a keypress or mouse click;
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
104 normally this means a menu selection or scrollbar action."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
105 (and (event-live-p object) (eq 'misc-user (event-type object))))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
106
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
107 ;; You could just as easily use event-glyph but we include this for
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
108 ;; consistency.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
109
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
110 (defun event-over-glyph-p (object)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
111 "Return t if OBJECT is a mouse event occurring over a glyph.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
112 Mouse events are events of type button-press, button-release or motion."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
113 (and (event-live-p object) (event-glyph object) t))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
114
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
115 (defun keyboard-translate (&rest pairs)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
116 "Translate character or keysym FROM to TO at a low level.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
117 Multiple FROM-TO pairs may be specified.
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
118
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
119 See `keyboard-translate-table' for more information."
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
120 (while pairs
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
121 (puthash (pop pairs) (pop pairs) keyboard-translate-table)))
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
122
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
123 (put 'tab 'ascii-character ?\t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
124 (put 'linefeed 'ascii-character ?\n)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
125 (put 'clear 'ascii-character 12)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
126 (put 'return 'ascii-character ?\r)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
127 (put 'escape 'ascii-character ?\e)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
128 (put 'space 'ascii-character ? )
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
129
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
130 ;; Do the same voodoo for the keypad keys. I used to bind these to keyboard
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
131 ;; macros (for instance, kp-0 was bound to "0") so that they would track the
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
132 ;; bindings of the corresponding keys by default, but that made the display
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
133 ;; of M-x describe-bindings much harder to read, so now we'll just bind them
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
134 ;; to self-insert by default. Not a big difference...
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
135
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
136 (put 'kp-0 'ascii-character ?0)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
137 (put 'kp-1 'ascii-character ?1)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
138 (put 'kp-2 'ascii-character ?2)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
139 (put 'kp-3 'ascii-character ?3)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
140 (put 'kp-4 'ascii-character ?4)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
141 (put 'kp-5 'ascii-character ?5)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
142 (put 'kp-6 'ascii-character ?6)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
143 (put 'kp-7 'ascii-character ?7)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
144 (put 'kp-8 'ascii-character ?8)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
145 (put 'kp-9 'ascii-character ?9)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
146
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
147 (put 'kp-space 'ascii-character ? )
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
148 (put 'kp-tab 'ascii-character ?\t)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
149 (put 'kp-enter 'ascii-character ?\r)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
150 (put 'kp-equal 'ascii-character ?=)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
151 (put 'kp-multiply 'ascii-character ?*)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
152 (put 'kp-add 'ascii-character ?+)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
153 (put 'kp-separator 'ascii-character ?,)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
154 (put 'kp-subtract 'ascii-character ?-)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
155 (put 'kp-decimal 'ascii-character ?.)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
156 (put 'kp-divide 'ascii-character ?/)
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
157
41ff10fd062f Import from CVS: tag r20-4b3
cvs
parents:
diff changeset
158 ;;; events.el ends here