author | Claus Gittinger <cg@exept.de> |
Fri, 18 Feb 2000 15:35:03 +0100 | |
changeset 1354 | 0c7e6c83b440 |
parent 1310 | 6ea1bca9654c |
child 1388 | b5ba6f0d434f |
permissions | -rw-r--r-- |
1124 | 1 |
" |
2 |
COPYRIGHT (c) 1997 by eXept Software AG |
|
3 |
All Rights Reserved |
|
4 |
||
5 |
This software is furnished under a license and may be used |
|
6 |
only in accordance with the terms of that license and with the |
|
7 |
inclusion of the above copyright notice. This software may not |
|
8 |
be provided or otherwise made available to, or used by, any |
|
9 |
other person. No title to or ownership of the software is |
|
10 |
hereby transferred. |
|
11 |
" |
|
12 |
||
13 |
||
14 |
||
15 |
||
16 |
||
17 |
Object subclass:#KeyboardProcessor |
|
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
18 |
instanceVariableNames:'returnIsOKInDialog escapeIsCancelInDialog menuBar |
1251 | 19 |
autoAcceptListeners globalAccelerators' |
1124 | 20 |
classVariableNames:'' |
21 |
poolDictionaries:'' |
|
22 |
category:'Interface-Support-UI' |
|
23 |
! |
|
24 |
||
25 |
!KeyboardProcessor class methodsFor:'documentation'! |
|
26 |
||
27 |
copyright |
|
28 |
" |
|
29 |
COPYRIGHT (c) 1997 by eXept Software AG |
|
30 |
All Rights Reserved |
|
31 |
||
32 |
This software is furnished under a license and may be used |
|
33 |
only in accordance with the terms of that license and with the |
|
34 |
inclusion of the above copyright notice. This software may not |
|
35 |
be provided or otherwise made available to, or used by, any |
|
36 |
other person. No title to or ownership of the software is |
|
37 |
hereby transferred. |
|
38 |
" |
|
39 |
||
40 |
||
41 |
||
42 |
||
43 |
! |
|
44 |
||
45 |
documentation |
|
46 |
" |
|
47 |
ST80 compatibility (mimicry) class. |
|
48 |
||
49 |
The class is not completed yet and certainly not bug free. |
|
50 |
||
51 |
Notice: |
|
52 |
this class was implemented using protocol information |
|
53 |
from alpha testers, literature and by reading public domain code |
|
54 |
- it may not be complete or compatible to |
|
55 |
the corresponding ST-80 class. |
|
56 |
If you encounter any incompatibilities, please forward a note |
|
57 |
describing the incompatibility verbal (i.e. no code) to the ST/X team. |
|
58 |
||
1160 | 59 |
KeyboardProcessor is going to take over the focus control |
60 |
mechanism (which are currently located in the windowGroup). |
|
61 |
Currently, it keeps track of inputFields, and allows for |
|
62 |
a global accept to be forced. |
|
63 |
This is especially useful with dialogs, where a global accept |
|
64 |
should be performed on all inputFields, when the OK button |
|
65 |
is pressed. |
|
66 |
||
1124 | 67 |
[author:] |
1160 | 68 |
Claus Gittinger |
1124 | 69 |
" |
70 |
||
71 |
||
72 |
||
73 |
||
74 |
! ! |
|
75 |
||
1310 | 76 |
!KeyboardProcessor methodsFor:'Compatibility ST80'! |
1124 | 77 |
|
78 |
keyboardConsumers |
|
79 |
^ #() |
|
80 |
||
81 |
"Created: 6.3.1997 / 15:16:32 / cg" |
|
82 |
! |
|
83 |
||
84 |
removeKeyboardReceiver:aController |
|
85 |
||
86 |
"Created: / 31.10.1997 / 01:56:54 / cg" |
|
87 |
! |
|
88 |
||
89 |
sendKeyboardTo:aController |
|
90 |
||
91 |
"Created: / 31.10.1997 / 01:57:15 / cg" |
|
92 |
! |
|
93 |
||
94 |
setActive:aWidget |
|
95 |
||
96 |
"Created: 3.3.1997 / 18:31:09 / cg" |
|
97 |
! ! |
|
98 |
||
99 |
!KeyboardProcessor methodsFor:'accessing'! |
|
100 |
||
1251 | 101 |
addAccelerator:aKey action:aSelectorOrBlock |
102 |
"add a global accelerator - these are handled even if no corresponding |
|
103 |
menu shortcut is defined" |
|
104 |
||
105 |
globalAccelerators isNil ifTrue:[ |
|
106 |
globalAccelerators := Dictionary new |
|
107 |
]. |
|
108 |
globalAccelerators at:aKey put:aSelectorOrBlock |
|
109 |
! |
|
110 |
||
1124 | 111 |
escapeIsCancelInDialog:aBoolean |
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
112 |
"set the escapeIsCancel flag. |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
113 |
If off, Escape is NOT handled as cancel (however, the default is true)" |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
114 |
|
1124 | 115 |
escapeIsCancelInDialog := aBoolean |
116 |
! |
|
117 |
||
118 |
menuBar |
|
119 |
"return the value of the instance variable 'menuBar' (automatically generated)" |
|
120 |
||
121 |
^ menuBar! |
|
122 |
||
123 |
menuBar:something |
|
124 |
"set the value of the instance variable 'menuBar' (automatically generated)" |
|
125 |
||
126 |
menuBar := something.! |
|
127 |
||
128 |
returnIsOKInDialog:aBoolean |
|
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
129 |
"set the returnIsOK flag. |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
130 |
If off, Return is NOT handled as accept (however, the default is true)" |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
131 |
|
1124 | 132 |
returnIsOKInDialog := aBoolean |
133 |
||
134 |
! ! |
|
135 |
||
136 |
!KeyboardProcessor methodsFor:'event handling'! |
|
137 |
||
1135 | 138 |
processEvent:event forModalView:modalTopOrNil |
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
139 |
"process a key-event; return true, if handled & eaten; false if not. |
1251 | 140 |
Here, first, we look for a globalAccelerator, |
141 |
then for Return and Escape in modal applications, |
|
142 |
(which lead to Accept & Cancel resp.) |
|
143 |
Finally, menu-shortcuts are handled." |
|
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
144 |
|
1251 | 145 |
|key topView app view action| |
1124 | 146 |
|
147 |
view := event view. |
|
148 |
||
149 |
event isKeyPressEvent ifTrue:[ |
|
150 |
key := event key. |
|
1135 | 151 |
topView := modalTopOrNil ? view topView. |
1124 | 152 |
app := topView application. |
153 |
||
1251 | 154 |
"/ how about global accelerators ? |
155 |
(globalAccelerators notNil |
|
156 |
and:[(action := globalAccelerators at:key ifAbsent:nil) notNil]) |
|
157 |
ifTrue:[ |
|
158 |
action isSymbol ifTrue:[ |
|
159 |
action numArgs == 1 ifTrue:[ |
|
160 |
app perform:action with:event |
|
161 |
] ifFalse:[ |
|
162 |
app perform:action |
|
163 |
]. |
|
164 |
] ifFalse:[ |
|
165 |
action numArgs == 1 ifTrue:[ |
|
166 |
action value:event |
|
167 |
] ifFalse:[ |
|
168 |
action value |
|
169 |
] |
|
170 |
]. |
|
171 |
^ true |
|
172 |
]. |
|
173 |
||
1124 | 174 |
topView isModal ifTrue:[ |
1146 | 175 |
topView windowGroup explicitFocusView isNil ifTrue:[ |
1134
758151d73aac
only do autoAccept, if there is no focus view.
Claus Gittinger <cg@exept.de>
parents:
1133
diff
changeset
|
176 |
(returnIsOKInDialog and:[key == #Return]) ifTrue:[ |
758151d73aac
only do autoAccept, if there is no focus view.
Claus Gittinger <cg@exept.de>
parents:
1133
diff
changeset
|
177 |
self requestGlobalAutoAccept ifFalse:[^ true]. |
758151d73aac
only do autoAccept, if there is no focus view.
Claus Gittinger <cg@exept.de>
parents:
1133
diff
changeset
|
178 |
app doAccept. |
758151d73aac
only do autoAccept, if there is no focus view.
Claus Gittinger <cg@exept.de>
parents:
1133
diff
changeset
|
179 |
^ true |
758151d73aac
only do autoAccept, if there is no focus view.
Claus Gittinger <cg@exept.de>
parents:
1133
diff
changeset
|
180 |
]. |
1124 | 181 |
]. |
1134
758151d73aac
only do autoAccept, if there is no focus view.
Claus Gittinger <cg@exept.de>
parents:
1133
diff
changeset
|
182 |
|
1124 | 183 |
(escapeIsCancelInDialog and:[key == #Escape]) ifTrue:[ |
184 |
app doCancel. |
|
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
185 |
^ true |
1124 | 186 |
]. |
187 |
]. |
|
188 |
||
189 |
"/ how about menu-shortkeys ? |
|
190 |
(menuBar notNil and:[(menuBar processShortcutKeyEventInMenuBar:event)]) ifTrue:[ |
|
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
191 |
^ true |
1124 | 192 |
] |
193 |
]. |
|
194 |
||
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
195 |
^ false |
1124 | 196 |
|
197 |
"/ let view dispatch it. |
|
198 |
||
199 |
||
200 |
||
201 |
! |
|
202 |
||
203 |
requestForWindowClose |
|
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
204 |
"about to close the window." |
1124 | 205 |
|
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
206 |
^ true |
1124 | 207 |
! |
208 |
||
209 |
requestGlobalAutoAccept |
|
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
210 |
"about to close the window via return ok accept. |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
211 |
Ask all acceptListeners to accept their value and return true, if all of those fields |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
212 |
did." |
1124 | 213 |
|
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
214 |
autoAcceptListeners notNil ifTrue:[ |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
215 |
autoAcceptListeners do:[:aListener | |
1133 | 216 |
(aListener requestAutoAccept) ifFalse:[^ false]. |
217 |
]. |
|
218 |
^ true |
|
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
219 |
]. |
1133 | 220 |
^ false |
1124 | 221 |
|
222 |
! ! |
|
223 |
||
1128
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
224 |
!KeyboardProcessor methodsFor:'setup'! |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
225 |
|
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
226 |
addAutoAcceptListener:aListener |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
227 |
"add a aListener to my autoAcceptListeners. |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
228 |
Typically, inputFields add themself, to be notified (via requestForAutoAccept) |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
229 |
when the dialog is about to be closed with returnIsOK or accept. |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
230 |
(of course, other listeners are also invited ;-)" |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
231 |
|
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
232 |
autoAcceptListeners isNil ifTrue:[ |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
233 |
autoAcceptListeners := IdentitySet new. |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
234 |
]. |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
235 |
autoAcceptListeners add:aListener |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
236 |
! ! |
7810bca304e3
added autoAccept (editFields in dialogs)
Claus Gittinger <cg@exept.de>
parents:
1124
diff
changeset
|
237 |
|
1124 | 238 |
!KeyboardProcessor class methodsFor:'documentation'! |
239 |
||
240 |
version |
|
1310 | 241 |
^ '$Header: /cvs/stx/stx/libview2/KeyboardProcessor.st,v 1.10 2000-01-17 11:28:50 cg Exp $' |
1124 | 242 |
! ! |