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