author | fm |
Fri, 15 Sep 2006 16:30:57 +0200 | |
changeset 2221 | 52803ae96560 |
parent 2130 | 31edece2051b |
child 2371 | 4ab6c8c7bc03 |
permissions | -rw-r--r-- |
59 | 1 |
" |
2 |
COPYRIGHT (c) 1995 by Claus Gittinger |
|
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 |
||
1502 | 14 |
"{ Package: 'stx:libview2' }" |
15 |
||
59 | 16 |
EventListener subclass:#ActiveHelp |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
17 |
instanceVariableNames:'lastHelpText listeningForAll applicationsOrTopViewsWithHelp' |
1892 | 18 |
classVariableNames:'' |
216 | 19 |
poolDictionaries:'' |
20 |
category:'Interface-Help' |
|
59 | 21 |
! |
22 |
||
1892 | 23 |
ActiveHelp class instanceVariableNames:'DelayTime ShowTime TheOneAndOnlyHelpListener' |
24 |
||
25 |
" |
|
26 |
No other class instance variables are inherited by this class. |
|
27 |
" |
|
28 |
! |
|
29 |
||
338
071f92621e3b
oops - catching the terminateSignal is no good idea
Claus Gittinger <cg@exept.de>
parents:
330
diff
changeset
|
30 |
!ActiveHelp class methodsFor:'documentation'! |
59 | 31 |
|
138 | 32 |
copyright |
33 |
" |
|
34 |
COPYRIGHT (c) 1995 by Claus Gittinger |
|
35 |
All Rights Reserved |
|
36 |
||
37 |
This software is furnished under a license and may be used |
|
38 |
only in accordance with the terms of that license and with the |
|
39 |
inclusion of the above copyright notice. This software may not |
|
40 |
be provided or otherwise made available to, or used by, any |
|
41 |
other person. No title to or ownership of the software is |
|
42 |
hereby transferred. |
|
43 |
" |
|
44 |
||
59 | 45 |
! |
46 |
||
47 |
documentation |
|
48 |
" |
|
98 | 49 |
The active help listener. |
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
50 |
|
98 | 51 |
The one and only instance of myself intercepts incoming mouse & keyboard |
52 |
events for the display device, being especially interested in view-enter/ |
|
636 | 53 |
leave events. When such an event arrives, it asks the corresponding view |
98 | 54 |
or its model for a help message and display it via an ActiveHelpView. |
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
55 |
(actually, the view is first asked if it would like to display it itself |
636 | 56 |
- for example, in some information-view). |
57 |
||
58 |
The query for the helpText is repeated along the views superView chain, |
|
59 |
until any model or view returns a nonNil answer for the #helpTextFor:at |
|
60 |
or #helpTextFor message. |
|
100 | 61 |
|
98 | 62 |
All I need for automatic help is some model/view/applicationModel along |
63 |
the superview chain of the entered component, which responds to the |
|
64 |
#helpTextFor: message with a non-nil (string-) answer. |
|
65 |
I close down the help view after a while, if a key is pressed or the mouse |
|
66 |
moved to another view. |
|
100 | 67 |
|
68 |
Who should provide the helpText: |
|
69 |
||
221 | 70 |
the best place is the application object (an instance of ApplicationModel) |
71 |
or the topView, if its a derived class of StandardSystemView. |
|
72 |
This should know about its components and return the string |
|
73 |
when asked via #helpTextFor:aComponent. |
|
330
d7ce98930ad3
Rename Launcher-->OldLauncher, NewLauncher-->Launcher.
Stefan Vogel <sv@exept.de>
parents:
297
diff
changeset
|
74 |
See examples in FileBrowser, Launcher etc. |
100 | 75 |
|
76 |
Be aware, that for applicationModels, there must be a link from the |
|
77 |
topView to this applicationModel |
|
78 |
(set via: aTopView application:anApplicationModel) |
|
79 |
otherwise, the helpManager has no means of finding the application which |
|
80 |
corresponds to a view. |
|
81 |
||
82 |
Who should display the helpText: |
|
83 |
||
221 | 84 |
by default, the helpListener opens a little popup view, which displays the |
85 |
returned help message. However, a nice trick which can be used by applications |
|
86 |
is to create an infoLabel as a subview of the topFrame (a la windows) |
|
87 |
and display the text right in the #helpTextFor: method. To cheat the |
|
88 |
help listener, this method should then return nil, to keep it silent. |
|
89 |
||
90 |
||
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
91 |
Usage: |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
92 |
If help is to be shown for all views (as enabled by the launchers help menu), |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
93 |
use 'ActiveHelp start' and 'ActiveHelp stop'. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
94 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
95 |
Individual apps may enable/disable active help for themself by: |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
96 |
'ActiveHelp startFor:app' or 'ActiveHelp stopFor:app', passing either |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
97 |
the topView or the topViews application as argument. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
98 |
This is usually done by applications which want to show contextHelp in |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
99 |
some infoView. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
100 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
101 |
|
221 | 102 |
[author:] |
103 |
Claus Gittinger |
|
104 |
||
233 | 105 |
[start with:] |
106 |
ActiveHelp start |
|
107 |
ActiveHelp stop |
|
108 |
||
221 | 109 |
[See also:] |
233 | 110 |
ActiveHelpView |
111 |
WindowGroup WindowEvent |
|
112 |
ApplicationModel StandardSystemView |
|
100 | 113 |
" |
114 |
! |
|
115 |
||
116 |
examples |
|
117 |
" |
|
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
118 |
Active Help for a single view |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
119 |
or app (whatever the global settings are): |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
120 |
Can be initiated by an app when its opened. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
121 |
[exBegin] |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
122 |
|app top myAppClass| |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
123 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
124 |
Class withoutUpdatingChangesDo:[ |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
125 |
myAppClass := ApplicationModel |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
126 |
subclass:#'Demos::DemoApp' |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
127 |
instanceVariableNames:'' |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
128 |
classVariableNames:'' |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
129 |
poolDictionaries:'' |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
130 |
category:'demos'. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
131 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
132 |
myAppClass |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
133 |
compile:'helpTextFor:aView Transcript showCR:''hello''. ^ ''this is some helpText'''. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
134 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
135 |
]. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
136 |
app := myAppClass new. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
137 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
138 |
top := StandardSystemView new. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
139 |
top extent:300@100. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
140 |
top application:app. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
141 |
top open. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
142 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
143 |
ActiveHelp startFor:app. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
144 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
145 |
Class withoutUpdatingChangesDo:[ |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
146 |
myAppClass removeFromSystem |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
147 |
] |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
148 |
[exEnd] |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
149 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
150 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
151 |
Active Help (for all views): |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
152 |
|
233 | 153 |
(make certain that activeHelp is turned on ... |
154 |
... otherwise, you will see nothing) |
|
100 | 155 |
|
156 |
the following example uses a Plug as a model replacement. |
|
157 |
In concrete application, you would create a method to implement the helpText |
|
158 |
query message. |
|
227 | 159 |
[exBegin] |
160 |
|app top button1 button2| |
|
100 | 161 |
|
227 | 162 |
app := Plug new. |
163 |
app respondTo:#helpTextFor: |
|
164 |
with:[:view | |
|
165 |
view == button1 ifTrue:[ |
|
166 |
'this is button1' |
|
167 |
] ifFalse:[ |
|
168 |
view == button2 ifTrue:[ |
|
169 |
'some help for button2' |
|
170 |
] ifFalse:[ |
|
171 |
nil |
|
172 |
] |
|
173 |
] |
|
174 |
]. |
|
100 | 175 |
|
227 | 176 |
top := StandardSystemView new. |
177 |
top extent:300@100. |
|
178 |
button1 := Button label:'b1' in:top. |
|
179 |
button1 origin:0.0@0.0 corner:0.5@30. |
|
180 |
button2 := Button label:'b2' in:top. |
|
181 |
button2 origin:0.5@0.0 corner:1.0@30. |
|
182 |
top model:app. '<-- normally this would be: top application:app'. |
|
183 |
top open |
|
184 |
[exEnd] |
|
100 | 185 |
|
233 | 186 |
(make certain that activeHelp is turned on ... |
187 |
... otherwise, you will see nothing) |
|
188 |
||
227 | 189 |
alternatively, display of the helpMessage in a local, private view: |
190 |
[exBegin] |
|
191 |
|app top button1 button2 infoView| |
|
100 | 192 |
|
227 | 193 |
app := Plug new. |
194 |
app respondTo:#helpTextFor: |
|
195 |
with:[:view | infoView label:'info ...'. |
|
196 |
view == button1 ifTrue:[ |
|
197 |
infoView label:'this is button1' |
|
198 |
]. |
|
199 |
view == button2 ifTrue:[ |
|
200 |
infoView label:'some help for button2' |
|
201 |
]. |
|
202 |
nil |
|
203 |
]. |
|
100 | 204 |
|
227 | 205 |
top := StandardSystemView new. |
206 |
top extent:300@100. |
|
207 |
button1 := Button label:'b1' in:top. |
|
208 |
button1 origin:0.0@0.0 corner:0.5@30. |
|
209 |
button2 := Button label:'b2' in:top. |
|
210 |
button2 origin:0.5@0.0 corner:1.0@30. |
|
211 |
infoView := Label label:'info ...' in:top. |
|
212 |
infoView level:-1; origin:0.0@1.0 corner:1.0@1.0. |
|
213 |
infoView topInset:(infoView preferredExtent y negated - 3); |
|
214 |
leftInset:3; |
|
215 |
rightInset:3; |
|
216 |
bottomInset:3; |
|
217 |
adjust:#left. |
|
218 |
top model:app. '<-- normally this would be: top application:app'. |
|
219 |
top open |
|
220 |
[exEnd] |
|
59 | 221 |
" |
222 |
! ! |
|
223 |
||
338
071f92621e3b
oops - catching the terminateSignal is no good idea
Claus Gittinger <cg@exept.de>
parents:
330
diff
changeset
|
224 |
!ActiveHelp class methodsFor:'initialization'! |
59 | 225 |
|
226 |
initialize |
|
233 | 227 |
"set default delay & help-display times" |
228 |
||
1657 | 229 |
ShowTime := 10. |
230 |
DelayTime := 0.4. |
|
92 | 231 |
|
232 |
" |
|
233 |
ActiveHelp initialize |
|
234 |
" |
|
233 | 235 |
|
236 |
"Modified: 27.4.1996 / 15:07:27 / cg" |
|
59 | 237 |
! ! |
238 |
||
633 | 239 |
!ActiveHelp class methodsFor:'queries'! |
100 | 240 |
|
632
844b1aaf3eeb
provide access to the current activeHelp instance
Claus Gittinger <cg@exept.de>
parents:
602
diff
changeset
|
241 |
currentHelpListener |
844b1aaf3eeb
provide access to the current activeHelp instance
Claus Gittinger <cg@exept.de>
parents:
602
diff
changeset
|
242 |
"return the activeHelp listener if activeHelp is turned on, nil otherwise" |
844b1aaf3eeb
provide access to the current activeHelp instance
Claus Gittinger <cg@exept.de>
parents:
602
diff
changeset
|
243 |
|
844b1aaf3eeb
provide access to the current activeHelp instance
Claus Gittinger <cg@exept.de>
parents:
602
diff
changeset
|
244 |
^ TheOneAndOnlyHelpListener |
844b1aaf3eeb
provide access to the current activeHelp instance
Claus Gittinger <cg@exept.de>
parents:
602
diff
changeset
|
245 |
|
844b1aaf3eeb
provide access to the current activeHelp instance
Claus Gittinger <cg@exept.de>
parents:
602
diff
changeset
|
246 |
"Created: 28.6.1997 / 13:59:44 / cg" |
844b1aaf3eeb
provide access to the current activeHelp instance
Claus Gittinger <cg@exept.de>
parents:
602
diff
changeset
|
247 |
! |
844b1aaf3eeb
provide access to the current activeHelp instance
Claus Gittinger <cg@exept.de>
parents:
602
diff
changeset
|
248 |
|
1892 | 249 |
delayTime |
250 |
^ DelayTime |
|
251 |
! |
|
252 |
||
233 | 253 |
isActive |
254 |
"return true, if activeHelp is turned on" |
|
255 |
||
138 | 256 |
^ TheOneAndOnlyHelpListener notNil |
233 | 257 |
|
258 |
"Modified: 27.4.1996 / 15:07:57 / cg" |
|
1892 | 259 |
! |
260 |
||
261 |
showTime |
|
262 |
^ ShowTime |
|
633 | 263 |
! ! |
264 |
||
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
265 |
!ActiveHelp class methodsFor:'start & stop'! |
59 | 266 |
|
267 |
start |
|
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
268 |
"start activeHelp for all apps" |
233 | 269 |
|
59 | 270 |
TheOneAndOnlyHelpListener isNil ifTrue:[ |
233 | 271 |
TheOneAndOnlyHelpListener := self new. |
59 | 272 |
]. |
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
273 |
TheOneAndOnlyHelpListener listenForAll |
59 | 274 |
|
275 |
" |
|
276 |
ActiveHelp start |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
277 |
FlyByHelp start |
59 | 278 |
" |
233 | 279 |
|
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
280 |
"Modified: / 26.10.1997 / 23:16:54 / cg" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
281 |
! |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
282 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
283 |
startFor:anApplicationOrTopView |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
284 |
"start activeHelp for a single app" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
285 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
286 |
TheOneAndOnlyHelpListener isNil ifTrue:[ |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
287 |
TheOneAndOnlyHelpListener := self new. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
288 |
]. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
289 |
TheOneAndOnlyHelpListener listenFor:anApplicationOrTopView |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
290 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
291 |
"Modified: / 26.10.1997 / 23:17:05 / cg" |
59 | 292 |
! |
293 |
||
294 |
stop |
|
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
295 |
"stop activeHelp for all (except for individual apps)" |
233 | 296 |
|
59 | 297 |
TheOneAndOnlyHelpListener notNil ifTrue:[ |
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
298 |
TheOneAndOnlyHelpListener unlistenAll. |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
299 |
TheOneAndOnlyHelpListener := nil. |
59 | 300 |
]. |
301 |
||
302 |
" |
|
303 |
ActiveHelp stop |
|
1543 | 304 |
FlyByHelp stop |
59 | 305 |
" |
233 | 306 |
|
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
307 |
"Modified: / 26.10.1997 / 23:18:58 / cg" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
308 |
! |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
309 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
310 |
stopFor:anAppOrTopView |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
311 |
"stop activeHelp for a single app" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
312 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
313 |
TheOneAndOnlyHelpListener notNil ifTrue:[ |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
314 |
TheOneAndOnlyHelpListener unlistenFor:anAppOrTopView. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
315 |
]. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
316 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
317 |
"Modified: / 26.10.1997 / 23:12:55 / cg" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
318 |
"Created: / 26.10.1997 / 23:18:41 / cg" |
138 | 319 |
! ! |
320 |
||
338
071f92621e3b
oops - catching the terminateSignal is no good idea
Claus Gittinger <cg@exept.de>
parents:
330
diff
changeset
|
321 |
!ActiveHelp class methodsFor:'times'! |
138 | 322 |
|
323 |
delayTime:numberOfSeconds |
|
324 |
"set the delay (the time, the cursor has to be in the view |
|
325 |
before help is shown). The default is 2 seconds." |
|
326 |
||
327 |
DelayTime := numberOfSeconds |
|
328 |
||
329 |
" |
|
330 |
ActiveHelp delayTime:0.5 |
|
331 |
ActiveHelp delayTime:2 |
|
332 |
ActiveHelp delayTime:10 |
|
333 |
" |
|
59 | 334 |
! |
335 |
||
138 | 336 |
showTime:numberOfSeconds |
337 |
"set the number of seconds, a help messages is to be shown. |
|
338 |
The default is 15 seconds." |
|
339 |
||
340 |
ShowTime := numberOfSeconds |
|
341 |
||
342 |
" |
|
343 |
ActiveHelp showTime:10 |
|
344 |
ActiveHelp showTime:99999 |
|
345 |
ActiveHelp showTime:30 |
|
346 |
" |
|
347 |
! ! |
|
348 |
||
349 |
!ActiveHelp methodsFor:'listening'! |
|
350 |
||
1011
53514f2c18a7
also ask for helpTextAt:, when a motionEvent arrives.
Claus Gittinger <cg@exept.de>
parents:
728
diff
changeset
|
351 |
buttonMotion:state x:x y:y view:aView |
1657 | 352 |
"handle motion events - prepare to show help" |
233 | 353 |
|
1948
33eb423a6fd3
only act when no mouse-button is pressed
Claus Gittinger <cg@exept.de>
parents:
1909
diff
changeset
|
354 |
state == 0 ifTrue:[ |
33eb423a6fd3
only act when no mouse-button is pressed
Claus Gittinger <cg@exept.de>
parents:
1909
diff
changeset
|
355 |
self handleMouseIn:aView x:x y:y. |
33eb423a6fd3
only act when no mouse-button is pressed
Claus Gittinger <cg@exept.de>
parents:
1909
diff
changeset
|
356 |
]. |
138 | 357 |
^ false |
358 |
! |
|
359 |
||
360 |
buttonPress:state x:x y:y view:view |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
361 |
"unconditionally hide the help view" |
233 | 362 |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
363 |
self hideHelpIgnoringErrors. |
138 | 364 |
^ false |
233 | 365 |
|
1011
53514f2c18a7
also ask for helpTextAt:, when a motionEvent arrives.
Claus Gittinger <cg@exept.de>
parents:
728
diff
changeset
|
366 |
"Modified: / 28.7.1998 / 02:52:00 / cg" |
138 | 367 |
! |
368 |
||
1591 | 369 |
keyPress:key x:x y:y view:view |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
370 |
"unconditionally hide the help view" |
233 | 371 |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
372 |
self hideHelpIgnoringErrors. |
138 | 373 |
^ false |
233 | 374 |
|
375 |
"Modified: 27.4.1996 / 15:09:57 / cg" |
|
138 | 376 |
! |
377 |
||
378 |
pointerEnter:state x:x y:y view:aView |
|
1657 | 379 |
"handle pointer entering a view; prepare to show help" |
233 | 380 |
|
1948
33eb423a6fd3
only act when no mouse-button is pressed
Claus Gittinger <cg@exept.de>
parents:
1909
diff
changeset
|
381 |
state == 0 ifTrue:[ |
33eb423a6fd3
only act when no mouse-button is pressed
Claus Gittinger <cg@exept.de>
parents:
1909
diff
changeset
|
382 |
self handleMouseIn:aView x:x y:y. |
33eb423a6fd3
only act when no mouse-button is pressed
Claus Gittinger <cg@exept.de>
parents:
1909
diff
changeset
|
383 |
]. |
1657 | 384 |
^ false |
138 | 385 |
! |
386 |
||
387 |
pointerLeave:state view:view |
|
233 | 388 |
"handle pointer leaving a view; hide help text" |
389 |
||
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
390 |
self hideHelpIgnoringErrors. |
138 | 391 |
^ false |
59 | 392 |
! ! |
393 |
||
394 |
!ActiveHelp methodsFor:'private'! |
|
395 |
||
2130 | 396 |
helpTextFor:aView at:aDevicePointOrNil |
233 | 397 |
"retrieve helptext for aView as a string; |
100 | 398 |
walk along the views superView chain, |
399 |
asking models and views encountered while walking. |
|
400 |
The first one who understands and returns a nonNil answer to the |
|
233 | 401 |
#helpTextFor:at: or #helpTextFor: message ends this search and the |
100 | 402 |
returned string is returned." |
403 |
||
2130 | 404 |
|model app1 app2 text v sv topView domainPointOrNil| |
59 | 405 |
|
2130 | 406 |
aView transformation notNil ifTrue:[ |
407 |
domainPointOrNil := aView transformation applyInverseTo:aDevicePointOrNil. |
|
408 |
] ifFalse:[ |
|
409 |
domainPointOrNil := aDevicePointOrNil. |
|
410 |
]. |
|
411 |
||
412 |
text := self helpTextFromView:aView at:domainPointOrNil. |
|
2076 | 413 |
text notNil ifTrue:[ ^ text ]. |
414 |
||
1549
1b5274878f87
care for oldStyle views (StdSysViews)
Claus Gittinger <cg@exept.de>
parents:
1543
diff
changeset
|
415 |
((aView respondsTo:#application) |
1b5274878f87
care for oldStyle views (StdSysViews)
Claus Gittinger <cg@exept.de>
parents:
1543
diff
changeset
|
416 |
and:[ (app1 := aView application) notNil ]) ifTrue:[ |
2130 | 417 |
text := self helpTextFromModel:app1 view:aView at:domainPointOrNil. |
1549
1b5274878f87
care for oldStyle views (StdSysViews)
Claus Gittinger <cg@exept.de>
parents:
1543
diff
changeset
|
418 |
text notNil ifTrue:[ ^ text ]. |
1b5274878f87
care for oldStyle views (StdSysViews)
Claus Gittinger <cg@exept.de>
parents:
1543
diff
changeset
|
419 |
] ifFalse:[ |
1b5274878f87
care for oldStyle views (StdSysViews)
Claus Gittinger <cg@exept.de>
parents:
1543
diff
changeset
|
420 |
"/ old style (i.e. StandardSystemView ...) |
1b5274878f87
care for oldStyle views (StdSysViews)
Claus Gittinger <cg@exept.de>
parents:
1543
diff
changeset
|
421 |
topView := aView topView. |
1b5274878f87
care for oldStyle views (StdSysViews)
Claus Gittinger <cg@exept.de>
parents:
1543
diff
changeset
|
422 |
(topView notNil and:[topView ~~ aView]) ifTrue:[ |
2130 | 423 |
text := self helpTextFromModel:topView view:aView at:domainPointOrNil. |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
424 |
text notNil ifTrue:[ ^ text ]. |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
425 |
] |
59 | 426 |
]. |
1549
1b5274878f87
care for oldStyle views (StdSysViews)
Claus Gittinger <cg@exept.de>
parents:
1543
diff
changeset
|
427 |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
428 |
(model := aView model) notNil ifTrue:[ |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
429 |
model ~~ app1 ifTrue:[ |
2130 | 430 |
text := self helpTextFromModel:model view:aView at:domainPointOrNil. |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
431 |
text notNil ifTrue:[ ^ text ]. |
1502 | 432 |
]. |
1011
53514f2c18a7
also ask for helpTextAt:, when a motionEvent arrives.
Claus Gittinger <cg@exept.de>
parents:
728
diff
changeset
|
433 |
]. |
2130 | 434 |
text := self helpTextFromView:aView at:domainPointOrNil. |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
435 |
text notNil ifTrue:[ ^ text ]. |
59 | 436 |
|
437 |
"walk up the chain - maybe someone knows about its subview ..." |
|
438 |
v := aView. |
|
1502 | 439 |
[ |
440 |
(sv := v container) notNil |
|
441 |
] whileTrue:[ |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
442 |
(model := sv model) notNil ifTrue:[ |
2130 | 443 |
text := self helpTextFromModel:model view:aView at:domainPointOrNil. |
1502 | 444 |
text notNil ifTrue:[ ^ text ]. |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
445 |
]. |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
446 |
text := self helpTextFromView:sv at:nil. |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
447 |
text notNil ifTrue:[ ^ text ]. |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
448 |
v := sv |
602 | 449 |
]. |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
450 |
|
100 | 451 |
(v notNil and:[v respondsTo:#application]) ifTrue:[ |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
452 |
(app2 := v application) notNil ifTrue:[ |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
453 |
(app2 ~~ app1) ifTrue:[ |
2130 | 454 |
text := self helpTextFromModel:app2 view:aView at:domainPointOrNil. |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
455 |
text notNil ifTrue:[ ^ text ]. |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
456 |
] |
233 | 457 |
] |
100 | 458 |
]. |
459 |
(v notNil and:[v respondsTo:#model]) ifTrue:[ |
|
233 | 460 |
(model := v model) notNil ifTrue:[ |
2130 | 461 |
text := self helpTextFromModel:model view:aView at:domainPointOrNil. |
1502 | 462 |
text notNil ifTrue:[ ^ text ]. |
233 | 463 |
] |
100 | 464 |
]. |
59 | 465 |
^ nil |
100 | 466 |
|
728 | 467 |
"Modified: / 31.8.1995 / 20:38:00 / claus" |
1011
53514f2c18a7
also ask for helpTextAt:, when a motionEvent arrives.
Claus Gittinger <cg@exept.de>
parents:
728
diff
changeset
|
468 |
"Modified: / 28.7.1998 / 01:47:27 / cg" |
100 | 469 |
! |
470 |
||
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
471 |
helpTextFromModel:aModel view:aView at:aPointOrNil |
1502 | 472 |
"helper: ask aModel for its helpText." |
473 |
||
1996 | 474 |
|text text2| |
1502 | 475 |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
476 |
aPointOrNil notNil ifTrue:[ |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
477 |
(aModel respondsTo:#helpTextFor:at:) ifTrue:[ |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
478 |
text := aModel helpTextFor:aView at:aPointOrNil. |
2076 | 479 |
text notNil ifTrue:[^ text]. |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
480 |
]. |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
481 |
]. |
2076 | 482 |
(aModel respondsTo:#helpTextFor:) ifTrue:[ |
483 |
text := aModel helpTextFor:aView. |
|
484 |
text notNil ifTrue:[ |
|
485 |
text2 := self helpTextFromView:aView at:aPointOrNil. |
|
486 |
text2 notNil ifTrue:[ ^ text2 ]. |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
487 |
]. |
1502 | 488 |
]. |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
489 |
^ text |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
490 |
! |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
491 |
|
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
492 |
helpTextFromView:aView at:aPointOrNil |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
493 |
"helper: ask aView for its helpText." |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
494 |
|
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
495 |
|text| |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
496 |
|
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
497 |
aPointOrNil notNil ifTrue:[ |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
498 |
(aView respondsTo:#helpTextAt:) ifTrue:[ |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
499 |
text := aView helpTextAt:aPointOrNil. |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
500 |
]. |
1502 | 501 |
]. |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
502 |
text isNil ifTrue:[ |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
503 |
(aView respondsTo:#helpText) ifTrue:[ |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
504 |
text := aView helpText. |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
505 |
]. |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
506 |
]. |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
507 |
^ text. |
1502 | 508 |
! |
509 |
||
138 | 510 |
hideIfPointerLeft:aView |
233 | 511 |
"hide help, if the pointer is not in aView" |
138 | 512 |
! |
513 |
||
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
514 |
interestedIn:aView |
1033
3a56ba930052
care for nil view passed to #interestedIn.
Claus Gittinger <cg@exept.de>
parents:
1019
diff
changeset
|
515 |
"return true, if I am interested in aView (either listeningForAll, |
3a56ba930052
care for nil view passed to #interestedIn.
Claus Gittinger <cg@exept.de>
parents:
1019
diff
changeset
|
516 |
or in my list of apps)" |
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
517 |
|
1106 | 518 |
|app aViewsTopView| |
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
519 |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
520 |
aView isNil ifTrue:[^ false]. |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
521 |
|
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
522 |
listeningForAll == true ifTrue:[^ true]. |
1957 | 523 |
applicationsOrTopViewsWithHelp isEmptyOrNil ifTrue:[^ false]. |
1033
3a56ba930052
care for nil view passed to #interestedIn.
Claus Gittinger <cg@exept.de>
parents:
1019
diff
changeset
|
524 |
|
1106 | 525 |
aViewsTopView := aView topView. |
526 |
(applicationsOrTopViewsWithHelp includesIdentical:aViewsTopView) ifTrue:[^ true]. |
|
527 |
app := aViewsTopView application. |
|
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
528 |
app notNil ifTrue:[ |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
529 |
(applicationsOrTopViewsWithHelp includesIdentical:app) ifTrue:[^ true] |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
530 |
]. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
531 |
^ false |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
532 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
533 |
"Created: / 26.10.1997 / 23:28:52 / cg" |
1033
3a56ba930052
care for nil view passed to #interestedIn.
Claus Gittinger <cg@exept.de>
parents:
1019
diff
changeset
|
534 |
"Modified: / 8.8.1998 / 13:36:19 / cg" |
59 | 535 |
! ! |
536 |
||
1768 | 537 |
!ActiveHelp methodsFor:'show & hide help'! |
59 | 538 |
|
1657 | 539 |
handleMouseIn:aView x:x y:y |
540 |
"handle motion events - if the mousepointer left the |
|
541 |
previous helped view, hide the help" |
|
542 |
||
1713
bc8a1d16e60f
Convert Object>>errorSignal -> Error
Stefan Vogel <sv@exept.de>
parents:
1657
diff
changeset
|
543 |
Error handle:[:ex | |
1657 | 544 |
ex description infoPrintCR. |
545 |
ex suspendedContext fullPrintAll. |
|
546 |
ex return |
|
547 |
] do:[ |
|
1909
a667507d3e0b
help via event-queue (helpTextFor: invoked by wgroup-process)
Claus Gittinger <cg@exept.de>
parents:
1892
diff
changeset
|
548 |
|sensor| |
a667507d3e0b
help via event-queue (helpTextFor: invoked by wgroup-process)
Claus Gittinger <cg@exept.de>
parents:
1892
diff
changeset
|
549 |
|
1657 | 550 |
(self interestedIn:aView) ifTrue:[ |
551 |
self stopHelpDisplayProcess. |
|
552 |
self hideIfPointerLeft:aView. |
|
1909
a667507d3e0b
help via event-queue (helpTextFor: invoked by wgroup-process)
Claus Gittinger <cg@exept.de>
parents:
1892
diff
changeset
|
553 |
|
a667507d3e0b
help via event-queue (helpTextFor: invoked by wgroup-process)
Claus Gittinger <cg@exept.de>
parents:
1892
diff
changeset
|
554 |
(self interestedIn:aView) ifFalse:[ |
a667507d3e0b
help via event-queue (helpTextFor: invoked by wgroup-process)
Claus Gittinger <cg@exept.de>
parents:
1892
diff
changeset
|
555 |
^ self |
a667507d3e0b
help via event-queue (helpTextFor: invoked by wgroup-process)
Claus Gittinger <cg@exept.de>
parents:
1892
diff
changeset
|
556 |
]. |
a667507d3e0b
help via event-queue (helpTextFor: invoked by wgroup-process)
Claus Gittinger <cg@exept.de>
parents:
1892
diff
changeset
|
557 |
|
2130 | 558 |
"/ if there is a sensor, let the view do it itself (in its process) |
559 |
sensor := aView sensor. |
|
560 |
sensor notNil ifTrue:[ |
|
561 |
sensor flushEventsFor:self withType:#initiateHelpFor:at:. |
|
562 |
sensor |
|
563 |
pushUserEvent:#initiateHelpFor:at: for:self |
|
564 |
withArguments:(Array with:aView with:(x @ y)). |
|
565 |
] ifFalse:[ |
|
566 |
self initiateHelpFor:aView at:(x @ y). |
|
567 |
] |
|
1657 | 568 |
]. |
569 |
]. |
|
570 |
! |
|
571 |
||
59 | 572 |
hideHelp |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
573 |
"hide the help text - nothing done here" |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
574 |
! |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
575 |
|
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
576 |
hideHelpIgnoringErrors |
233 | 577 |
"hide the help text" |
578 |
||
1713
bc8a1d16e60f
Convert Object>>errorSignal -> Error
Stefan Vogel <sv@exept.de>
parents:
1657
diff
changeset
|
579 |
Error handle:[:ex | |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
580 |
ex description infoPrintCR. |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
581 |
ex return |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
582 |
] do:[ |
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
583 |
self hideHelp. |
59 | 584 |
]. |
585 |
! |
|
586 |
||
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
587 |
initiateHelpFor:aView at:aPointOrNil |
634 | 588 |
"ask aView for helpText, passing x/y coordinates; |
589 |
start a timeout process to display this helpText after some delay; |
|
590 |
Normally used internally, but can also be used by widgets to force |
|
591 |
re-negotiation of the displayed helpText |
|
592 |
(for example in a menu, when the selection changes)" |
|
593 |
||
1657 | 594 |
self initiateHelpFor:aView at:aPointOrNil now:false |
637
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
595 |
|
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
596 |
"Modified: 28.6.1997 / 14:45:57 / cg" |
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
597 |
! |
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
598 |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
599 |
initiateHelpFor:aView at:aPointOrNil now:showItNow |
637
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
600 |
"ask aView for helpText, passing x/y coordinates; |
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
601 |
start a timeout process to display this helpText after some delay; |
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
602 |
Normally used internally, but can also be used by widgets to force |
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
603 |
re-negotiation of the displayed helpText |
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
604 |
(for example in a menu, when the selection changes)" |
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
605 |
|
696 | 606 |
|text top app| |
634 | 607 |
|
1143 | 608 |
(self interestedIn:aView) ifFalse:[ |
609 |
^ self |
|
610 |
]. |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
611 |
|
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
612 |
text := self helpTextFor:aView at:aPointOrNil. |
637
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
613 |
lastHelpText = text ifTrue:[ |
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
614 |
^ self |
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
615 |
]. |
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
616 |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
617 |
"/ let application show the help |
728 | 618 |
"/ (i.e. in its own information area) |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
619 |
"/ nil-text is also passed down, to give it a chance |
728 | 620 |
"/ to clean its infoDisplay. |
637
8be64da7d932
views own help display is done immediately.
Claus Gittinger <cg@exept.de>
parents:
636
diff
changeset
|
621 |
|
728 | 622 |
top := aView topView. |
623 |
(app := aView application) notNil ifTrue:[ |
|
1019
862f095da4ac
#showHelp:for: renamed to #showActiveHelp:for:
Claus Gittinger <cg@exept.de>
parents:
1011
diff
changeset
|
624 |
(app showActiveHelp:text for:aView) ifTrue:[ |
728 | 625 |
lastHelpText := text. |
632
844b1aaf3eeb
provide access to the current activeHelp instance
Claus Gittinger <cg@exept.de>
parents:
602
diff
changeset
|
626 |
] |
844b1aaf3eeb
provide access to the current activeHelp instance
Claus Gittinger <cg@exept.de>
parents:
602
diff
changeset
|
627 |
]. |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
628 |
! |
59 | 629 |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
630 |
stopHelpDisplayProcess |
59 | 631 |
! ! |
632 |
||
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
633 |
!ActiveHelp methodsFor:'start & stop'! |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
634 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
635 |
listenFor:anAppOrTopView |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
636 |
"start listening" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
637 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
638 |
applicationsOrTopViewsWithHelp isNil ifTrue:[ |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
639 |
applicationsOrTopViewsWithHelp := WeakIdentitySet new. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
640 |
]. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
641 |
applicationsOrTopViewsWithHelp add:anAppOrTopView. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
642 |
super listen. |
639 | 643 |
|
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
644 |
"Created: / 26.10.1997 / 23:20:47 / cg" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
645 |
"Modified: / 26.10.1997 / 23:21:10 / cg" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
646 |
! |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
647 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
648 |
listenForAll |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
649 |
"start listening" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
650 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
651 |
listeningForAll := true. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
652 |
super listen. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
653 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
654 |
"Modified: / 28.6.1997 / 15:07:02 / cg" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
655 |
"Created: / 26.10.1997 / 23:19:30 / cg" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
656 |
! |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
657 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
658 |
unlistenAll |
639 | 659 |
"stop listening" |
660 |
||
661 |
self hideHelp. |
|
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
662 |
|
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
663 |
listeningForAll := false. |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
664 |
applicationsOrTopViewsWithHelp size == 0 ifTrue:[ |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
665 |
self unlisten. |
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
666 |
] |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
667 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
668 |
"Created: / 26.10.1997 / 23:14:17 / cg" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
669 |
"Modified: / 26.10.1997 / 23:23:04 / cg" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
670 |
! |
639 | 671 |
|
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
672 |
unlistenFor:anApp |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
673 |
"stop listening for an app" |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
674 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
675 |
self hideHelp. |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
676 |
|
1543 | 677 |
applicationsOrTopViewsWithHelp isNil ifFalse:[ |
678 |
applicationsOrTopViewsWithHelp remove:anApp ifAbsent:nil. |
|
679 |
]. |
|
726 | 680 |
listeningForAll == true ifFalse:[ |
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
681 |
applicationsOrTopViewsWithHelp size == 0 ifTrue:[ |
1535
a9fcabccabb3
separated into flyByHelp and activeHelp
Claus Gittinger <cg@exept.de>
parents:
1502
diff
changeset
|
682 |
self unlisten. |
719
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
683 |
] |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
684 |
] |
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
685 |
|
17fba5c2a167
allow applications to start activeHelp for
Claus Gittinger <cg@exept.de>
parents:
696
diff
changeset
|
686 |
"Created: / 26.10.1997 / 23:22:42 / cg" |
726 | 687 |
"Modified: / 29.10.1997 / 15:48:34 / cg" |
639 | 688 |
! ! |
689 |
||
338
071f92621e3b
oops - catching the terminateSignal is no good idea
Claus Gittinger <cg@exept.de>
parents:
330
diff
changeset
|
690 |
!ActiveHelp class methodsFor:'documentation'! |
138 | 691 |
|
692 |
version |
|
2130 | 693 |
^ '$Header: /cvs/stx/stx/libview2/ActiveHelp.st,v 1.58 2006-03-20 13:53:19 cg Exp $' |
138 | 694 |
! ! |
1657 | 695 |
|
59 | 696 |
ActiveHelp initialize! |