Home » Archimedes archive » Archimedes World » AW-1995-01-Disc2.adf » Disk2Jan95 » !AWJan95/Goodies/Event/Docs/Shell
!AWJan95/Goodies/Event/Docs/Shell
This website contains an archive of files for the Acorn Electron, BBC Micro, Acorn Archimedes, Commodore 16 and Commodore 64 computers, which Dominic Ford has rescued from his private collection of floppy disks and cassettes.
Some of these files were originally commercial releases in the 1980s and 1990s, but they are now widely available online. I assume that copyright over them is no longer being asserted. If you own the copyright and would like files to be removed, please contact me.
| Tape/disk: | Home » Archimedes archive » Archimedes World » AW-1995-01-Disc2.adf » Disk2Jan95 |
| Filename: | !AWJan95/Goodies/Event/Docs/Shell |
| Read OK: | ✔ |
| File size: | 0921 bytes |
| Load address: | 0000 |
| Exec address: | 0000 |
Duplicates
There is 1 duplicate copy of this file in the archive:
- Archimedes archive » Acorn Computing » 1994 08 subscription disc.adf » 9408s » Shareware/Event/Documents/!EShellDoc/TextHelp/Shell
- Archimedes archive » Archimedes World » AW-1995-01-Disc2.adf » Disk2Jan95 » !AWJan95/Goodies/Event/Docs/Shell
File contents
PROCshell_Init
Params =>
None
--------------------------------------------------------
PROCshell_ResourcesInit
Params =>
None
Loads window templates, sprites, menus and message files.
This PROC must be called early in the program, i.e before
the wimp poll loop starts.
--------------------------------------------------------
FNshell_WimpInit()
Params =>
int version number
str task name
Not used in EvntShell library - use FNshell_WimpInit_I
instead.
--------------------------------------------------------
FNshell_WimpInit_I()
Params =>
int version number
str task name
Also initialises Interface module.
--------------------------------------------------------
FNshell_GetAppName
Params =>
none
<=
str name of application (actually the
'leaf' name of the application
directory minus the '!')
--------------------------------------------------------
FNshell_GetAppDir
Params =>
none
<=
str full path name of the application
directory
--------------------------------------------------------
FNshell_GetAppDataDir
Params =>
none
<=
str full path name of the application
data file directory
--------------------------------------------------------
PROCshell_InitHelpSystem()
Params =>
str path name of help files
bool DieWithTask flag
Used to register a new help system with StrongHlp.
After making this call StrongHlp will add the help
system found in the given path to its icon bar menu.
DieWithTask Flag
When TRUE the help system will only be added to
the StrongHlp icon bar menu while the user
application is actually running. When FALSE it
is removed when the application quits.
--------------------------------------------------------
PROCshell_HelpWord()
Params =>
str word for which help is to be displayed
Used to send a help request to StrongHlp. If the word
is found in the help system the appropriate help text
will be displayed.
--------------------------------------------------------
FNshell_LibraryVersion
Params =>
none
<=
int library version * 100 i.e version 1.02
returns 102
-------------------------------------------------------- 00000000 50 52 4f 43 73 68 65 6c 6c 5f 49 6e 69 74 0a 50 |PROCshell_Init.P| 00000010 61 72 61 6d 73 20 3d 3e 20 20 0a 20 20 20 20 20 |arams => . | 00000020 20 20 20 20 4e 6f 6e 65 0a 0a 2d 2d 2d 2d 2d 2d | None..------| 00000030 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 00000060 2d 2d 0a 0a 50 52 4f 43 73 68 65 6c 6c 5f 52 65 |--..PROCshell_Re| 00000070 73 6f 75 72 63 65 73 49 6e 69 74 0a 50 61 72 61 |sourcesInit.Para| 00000080 6d 73 20 3d 3e 20 20 20 0a 20 20 20 20 20 20 20 |ms => . | 00000090 20 20 4e 6f 6e 65 0a 0a 4c 6f 61 64 73 20 77 69 | None..Loads wi| 000000a0 6e 64 6f 77 20 74 65 6d 70 6c 61 74 65 73 2c 20 |ndow templates, | 000000b0 73 70 72 69 74 65 73 2c 20 6d 65 6e 75 73 20 61 |sprites, menus a| 000000c0 6e 64 20 6d 65 73 73 61 67 65 20 66 69 6c 65 73 |nd message files| 000000d0 2e 0a 54 68 69 73 20 50 52 4f 43 20 6d 75 73 74 |..This PROC must| 000000e0 20 62 65 20 63 61 6c 6c 65 64 20 65 61 72 6c 79 | be called early| 000000f0 20 69 6e 20 74 68 65 20 70 72 6f 67 72 61 6d 2c | in the program,| 00000100 20 69 2e 65 20 62 65 66 6f 72 65 0a 74 68 65 20 | i.e before.the | 00000110 77 69 6d 70 20 70 6f 6c 6c 20 6c 6f 6f 70 20 73 |wimp poll loop s| 00000120 74 61 72 74 73 2e 0a 0a 2d 2d 2d 2d 2d 2d 2d 2d |tarts...--------| 00000130 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 00000160 0a 0a 46 4e 73 68 65 6c 6c 5f 57 69 6d 70 49 6e |..FNshell_WimpIn| 00000170 69 74 28 29 0a 50 61 72 61 6d 73 20 3d 3e 0a 20 |it().Params =>. | 00000180 20 20 20 20 20 20 20 20 69 6e 74 20 76 65 72 73 | int vers| 00000190 69 6f 6e 20 6e 75 6d 62 65 72 0a 20 20 20 20 20 |ion number. | 000001a0 20 20 20 20 73 74 72 20 74 61 73 6b 20 6e 61 6d | str task nam| 000001b0 65 0a 0a 4e 6f 74 20 75 73 65 64 20 69 6e 20 45 |e..Not used in E| 000001c0 76 6e 74 53 68 65 6c 6c 20 6c 69 62 72 61 72 79 |vntShell library| 000001d0 20 2d 20 75 73 65 20 46 4e 73 68 65 6c 6c 5f 57 | - use FNshell_W| 000001e0 69 6d 70 49 6e 69 74 5f 49 0a 69 6e 73 74 65 61 |impInit_I.instea| 000001f0 64 2e 0a 0a 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |d...------------| 00000200 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 00000220 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 0a 0a 46 4e |------------..FN| 00000230 73 68 65 6c 6c 5f 57 69 6d 70 49 6e 69 74 5f 49 |shell_WimpInit_I| 00000240 28 29 0a 50 61 72 61 6d 73 20 3d 3e 0a 20 20 20 |().Params =>. | 00000250 20 20 20 20 20 20 69 6e 74 20 76 65 72 73 69 6f | int versio| 00000260 6e 20 6e 75 6d 62 65 72 20 0a 20 20 20 20 20 20 |n number . | 00000270 20 20 20 73 74 72 20 74 61 73 6b 20 6e 61 6d 65 | str task name| 00000280 0a 0a 41 6c 73 6f 20 69 6e 69 74 69 61 6c 69 73 |..Also initialis| 00000290 65 73 20 49 6e 74 65 72 66 61 63 65 20 6d 6f 64 |es Interface mod| 000002a0 75 6c 65 2e 0a 0a 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |ule...----------| 000002b0 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 000002d0 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 0a 0a |--------------..| 000002e0 46 4e 73 68 65 6c 6c 5f 47 65 74 41 70 70 4e 61 |FNshell_GetAppNa| 000002f0 6d 65 0a 50 61 72 61 6d 73 20 3d 3e 0a 20 20 20 |me.Params =>. | 00000300 20 20 20 20 20 20 6e 6f 6e 65 0a 0a 20 20 20 20 | none.. | 00000310 20 20 20 3c 3d 0a 20 20 20 20 20 20 20 20 20 73 | <=. s| 00000320 74 72 20 6e 61 6d 65 20 6f 66 20 61 70 70 6c 69 |tr name of appli| 00000330 63 61 74 69 6f 6e 20 28 61 63 74 75 61 6c 6c 79 |cation (actually| 00000340 20 74 68 65 0a 20 20 20 20 20 20 20 20 20 20 20 | the. | 00000350 20 20 27 6c 65 61 66 27 20 6e 61 6d 65 20 6f 66 | 'leaf' name of| 00000360 20 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e | the application| 00000370 0a 20 20 20 20 20 20 20 20 20 20 20 20 20 64 69 |. di| 00000380 72 65 63 74 6f 72 79 20 6d 69 6e 75 73 20 74 68 |rectory minus th| 00000390 65 20 27 21 27 29 0a 0a 2d 2d 2d 2d 2d 2d 2d 2d |e '!')..--------| 000003a0 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 000003d0 0a 0a 46 4e 73 68 65 6c 6c 5f 47 65 74 41 70 70 |..FNshell_GetApp| 000003e0 44 69 72 0a 50 61 72 61 6d 73 20 3d 3e 0a 20 20 |Dir.Params =>. | 000003f0 20 20 20 20 20 20 20 6e 6f 6e 65 0a 0a 20 20 20 | none.. | 00000400 20 20 20 20 3c 3d 0a 20 20 20 20 20 20 20 20 20 | <=. | 00000410 73 74 72 20 66 75 6c 6c 20 70 61 74 68 20 6e 61 |str full path na| 00000420 6d 65 20 6f 66 20 74 68 65 20 61 70 70 6c 69 63 |me of the applic| 00000430 61 74 69 6f 6e 0a 20 20 20 20 20 20 20 20 20 20 |ation. | 00000440 20 20 20 64 69 72 65 63 74 6f 72 79 0a 0a 2d 2d | directory..--| 00000450 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 00000480 2d 2d 2d 2d 2d 2d 0a 0a 46 4e 73 68 65 6c 6c 5f |------..FNshell_| 00000490 47 65 74 41 70 70 44 61 74 61 44 69 72 0a 50 61 |GetAppDataDir.Pa| 000004a0 72 61 6d 73 20 3d 3e 0a 20 20 20 20 20 20 20 20 |rams =>. | 000004b0 20 6e 6f 6e 65 0a 0a 20 20 20 20 20 20 20 3c 3d | none.. <=| 000004c0 0a 20 20 20 20 20 20 20 20 20 73 74 72 20 66 75 |. str fu| 000004d0 6c 6c 20 70 61 74 68 20 6e 61 6d 65 20 6f 66 20 |ll path name of | 000004e0 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 0a |the application.| 000004f0 20 20 20 20 20 20 20 20 20 20 20 20 20 64 61 74 | dat| 00000500 61 20 66 69 6c 65 20 64 69 72 65 63 74 6f 72 79 |a file directory| 00000510 0a 0a 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |..--------------| 00000520 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 00000540 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 0a 0a 50 52 4f 43 |----------..PROC| 00000550 73 68 65 6c 6c 5f 49 6e 69 74 48 65 6c 70 53 79 |shell_InitHelpSy| 00000560 73 74 65 6d 28 29 0a 50 61 72 61 6d 73 20 3d 3e |stem().Params =>| 00000570 0a 20 20 20 20 20 20 20 20 20 73 74 72 20 20 70 |. str p| 00000580 61 74 68 20 6e 61 6d 65 20 6f 66 20 68 65 6c 70 |ath name of help| 00000590 20 66 69 6c 65 73 0a 20 20 20 20 20 20 20 20 20 | files. | 000005a0 62 6f 6f 6c 20 44 69 65 57 69 74 68 54 61 73 6b |bool DieWithTask| 000005b0 20 66 6c 61 67 0a 0a 55 73 65 64 20 74 6f 20 72 | flag..Used to r| 000005c0 65 67 69 73 74 65 72 20 61 20 6e 65 77 20 68 65 |egister a new he| 000005d0 6c 70 20 73 79 73 74 65 6d 20 77 69 74 68 20 53 |lp system with S| 000005e0 74 72 6f 6e 67 48 6c 70 2e 0a 41 66 74 65 72 20 |trongHlp..After | 000005f0 6d 61 6b 69 6e 67 20 74 68 69 73 20 63 61 6c 6c |making this call| 00000600 20 53 74 72 6f 6e 67 48 6c 70 20 77 69 6c 6c 20 | StrongHlp will | 00000610 61 64 64 20 74 68 65 20 68 65 6c 70 0a 73 79 73 |add the help.sys| 00000620 74 65 6d 20 66 6f 75 6e 64 20 69 6e 20 74 68 65 |tem found in the| 00000630 20 67 69 76 65 6e 20 70 61 74 68 20 74 6f 20 69 | given path to i| 00000640 74 73 20 69 63 6f 6e 20 62 61 72 20 6d 65 6e 75 |ts icon bar menu| 00000650 2e 0a 0a 44 69 65 57 69 74 68 54 61 73 6b 20 46 |...DieWithTask F| 00000660 6c 61 67 0a 57 68 65 6e 20 54 52 55 45 20 74 68 |lag.When TRUE th| 00000670 65 20 68 65 6c 70 20 73 79 73 74 65 6d 20 77 69 |e help system wi| 00000680 6c 6c 20 6f 6e 6c 79 20 62 65 20 61 64 64 65 64 |ll only be added| 00000690 20 74 6f 20 0a 74 68 65 20 53 74 72 6f 6e 67 48 | to .the StrongH| 000006a0 6c 70 20 69 63 6f 6e 20 62 61 72 20 6d 65 6e 75 |lp icon bar menu| 000006b0 20 77 68 69 6c 65 20 74 68 65 20 75 73 65 72 20 | while the user | 000006c0 0a 61 70 70 6c 69 63 61 74 69 6f 6e 20 69 73 20 |.application is | 000006d0 61 63 74 75 61 6c 6c 79 20 72 75 6e 6e 69 6e 67 |actually running| 000006e0 2e 20 57 68 65 6e 20 46 41 4c 53 45 20 69 74 0a |. When FALSE it.| 000006f0 69 73 20 72 65 6d 6f 76 65 64 20 77 68 65 6e 20 |is removed when | 00000700 74 68 65 20 61 70 70 6c 69 63 61 74 69 6f 6e 20 |the application | 00000710 71 75 69 74 73 2e 0a 0a 2d 2d 2d 2d 2d 2d 2d 2d |quits...--------| 00000720 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 00000750 0a 0a 50 52 4f 43 73 68 65 6c 6c 5f 48 65 6c 70 |..PROCshell_Help| 00000760 57 6f 72 64 28 29 0a 50 61 72 61 6d 73 20 3d 3e |Word().Params =>| 00000770 0a 20 20 20 20 20 20 20 20 20 73 74 72 20 77 6f |. str wo| 00000780 72 64 20 66 6f 72 20 77 68 69 63 68 20 68 65 6c |rd for which hel| 00000790 70 20 69 73 20 74 6f 20 62 65 20 64 69 73 70 6c |p is to be displ| 000007a0 61 79 65 64 0a 0a 55 73 65 64 20 74 6f 20 73 65 |ayed..Used to se| 000007b0 6e 64 20 61 20 68 65 6c 70 20 72 65 71 75 65 73 |nd a help reques| 000007c0 74 20 74 6f 20 53 74 72 6f 6e 67 48 6c 70 2e 20 |t to StrongHlp. | 000007d0 49 66 20 74 68 65 20 77 6f 72 64 0a 69 73 20 66 |If the word.is f| 000007e0 6f 75 6e 64 20 69 6e 20 74 68 65 20 68 65 6c 70 |ound in the help| 000007f0 20 73 79 73 74 65 6d 20 74 68 65 20 61 70 70 72 | system the appr| 00000800 6f 70 72 69 61 74 65 20 68 65 6c 70 20 74 65 78 |opriate help tex| 00000810 74 0a 77 69 6c 6c 20 62 65 20 64 69 73 70 6c 61 |t.will be displa| 00000820 79 65 64 2e 20 0a 0a 2d 2d 2d 2d 2d 2d 2d 2d 2d |yed. ..---------| 00000830 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 00000850 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 0a |---------------.| 00000860 0a 46 4e 73 68 65 6c 6c 5f 4c 69 62 72 61 72 79 |.FNshell_Library| 00000870 56 65 72 73 69 6f 6e 0a 50 61 72 61 6d 73 20 3d |Version.Params =| 00000880 3e 0a 20 20 20 20 20 20 20 20 20 6e 6f 6e 65 0a |>. none.| 00000890 0a 20 20 20 20 20 20 20 3c 3d 0a 20 20 20 20 20 |. <=. | 000008a0 20 20 20 20 69 6e 74 20 6c 69 62 72 61 72 79 20 | int library | 000008b0 76 65 72 73 69 6f 6e 20 2a 20 31 30 30 20 69 2e |version * 100 i.| 000008c0 65 20 76 65 72 73 69 6f 6e 20 31 2e 30 32 0a 20 |e version 1.02. | 000008d0 20 20 20 20 20 20 20 20 20 20 20 20 72 65 74 75 | retu| 000008e0 72 6e 73 20 31 30 32 0a 0a 2d 2d 2d 2d 2d 2d 2d |rns 102..-------| 000008f0 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d |----------------| * 00000920 2d |-| 00000921
.