home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsd / evntshell / Docs / Shell < prev    next >
Encoding:
Text File  |  1994-10-29  |  2.8 KB  |  124 lines
  1. PROCshell_Init
  2. Params =>  
  3.          None
  4.  
  5. --------------------------------------------------------
  6.  
  7. PROCshell_ResourcesInit
  8. Params =>   
  9.          None
  10.  
  11. Loads window templates, sprites, menus and message files.
  12. This PROC must be called early in the program, i.e before
  13. the wimp poll loop starts.
  14.  
  15. --------------------------------------------------------
  16.  
  17. FNshell_WimpInit()
  18. Params =>
  19.          int version number
  20.          str task name
  21.  
  22. Not used in EvntShell library - use FNshell_WimpInit_I
  23. instead.
  24.  
  25. --------------------------------------------------------
  26.  
  27. FNshell_WimpInit_I()
  28. Params =>
  29.          int version number 
  30.          str task name
  31.  
  32. Also initialises Interface module.
  33.  
  34. --------------------------------------------------------
  35.  
  36. FNshell_GetAppName
  37. Params =>
  38.          none
  39.  
  40.        <=
  41.          str name of application (actually the
  42.              'leaf' name of the application
  43.              directory minus the '!')
  44.  
  45. --------------------------------------------------------
  46.  
  47. FNshell_GetAppDir
  48. Params =>
  49.          none
  50.  
  51.        <=
  52.          str full path name of the application
  53.              directory
  54.  
  55. --------------------------------------------------------
  56.  
  57. FNshell_GetAppDataDir
  58. Params =>
  59.          none
  60.  
  61.        <=
  62.          str full path name of the application
  63.              data file directory
  64.  
  65. --------------------------------------------------------
  66.  
  67. PROCshell_InitHelpSystem()
  68. Params =>
  69.          str  path name of help files
  70.          bool DieWithTask flag
  71.  
  72. Used to register a new help system with StrongHlp.
  73. After making this call StrongHlp will add the help
  74. system found in the given path to its icon bar menu.
  75.  
  76. DieWithTask Flag
  77. When TRUE the help system will only be added to 
  78. the StrongHlp icon bar menu while the user 
  79. application is actually running. When FALSE it
  80. is removed when the application quits.
  81.  
  82. --------------------------------------------------------
  83.  
  84. PROCshell_HelpWord()
  85. Params =>
  86.          str word for which help is to be displayed
  87.  
  88. Used to send a help request to StrongHlp. If the word
  89. is found in the help system the appropriate help text
  90. will be displayed. 
  91.  
  92. --------------------------------------------------------
  93.  
  94. FNshell_LibraryVersion
  95. Params =>
  96.          none
  97.  
  98.        <=
  99.          int library version * 100 i.e version 1.02
  100.              returns 102
  101.  
  102. --------------------------------------------------------
  103.  
  104. FNshell_InstallLib()
  105. Params =>
  106.          str pathname of library file
  107.  
  108.        <=
  109.          int junk
  110.  
  111. Installs the specified library file and calls
  112. an initialisation function which must be called
  113. FN_shell_<Lib file leaf name>Init
  114.  
  115. Example Code (InstallLib)
  116. To install the extension library 'CalLib'
  117. void% = FNshell_InstallLib( "<EvntShell$Path>Extensions.
  118.         CalLib"
  119.  
  120. The routine FN_shell_CalLibInit will be called after the
  121. library is installed (handy for declaring variables
  122. used by the library routines)
  123.  
  124. --------------------------------------------------------