home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 1 / ARM_CLUB_CD.iso / contents / apps / program / d / eventshel1 / Docs / StrongHelp < prev    next >
Encoding:
Text File  |  1994-01-19  |  1.6 KB  |  56 lines
  1. PROCshell_InitHelpSystem()
  2. Params =>
  3.          str  path name of help files
  4.          bool DieWithTask flag
  5.  
  6. Used to register a new help system with StrongHlp.
  7. After making this call StrongHlp will add the help
  8. system found in the given path to its icon bar menu.
  9.  
  10. If StrongHlp cannot be found then the initialisation
  11. command is stored and sent when StrongHlp is started.
  12.  
  13. -DieWithTask Flag
  14. When TRUE the help system will only be added to 
  15. the StrongHlp icon bar menu while the user 
  16. application is actually running. When FALSE it
  17. remains available when the application quits.
  18.  
  19.  
  20. -----------------------------------------------------------------
  21.  
  22. PROCshell_HelpWord()
  23. Params =>
  24.          str word for which help is to be displayed
  25.  
  26. Used to send a help request to StrongHlp. If the word
  27. is found in the help system the appropriate help text
  28. will be displayed.
  29.  
  30. StrongHlp will be started if it is not already
  31. running and StrongHelp$Dir has been defined. If
  32. StrongHlp cannot be found then an error will be
  33. generated.
  34.  
  35. -----------------------------------------------------------------
  36.  
  37. FNshell_StrongHlpIsAvailable
  38. Params =>
  39.          None
  40.        <=
  41.          bool TRUE if StrongHelp$Dir is defined,
  42.               otherwise FALSE
  43.               
  44. Used to check that StrongHlp is installed
  45. on the system. This call can be used to shade
  46. a 'Help' menu item if StrongHlp has not been seen
  47. by the Filer, or if it is not available.
  48.  
  49. Example code...
  50.  
  51. Shade menu item with the handle HlpItem% if StrongHlp
  52. is not available:
  53.  
  54. PROCshell_MenuShade(HlpItem%,(FNshell_StrongHlpIsAvailable=0))
  55.   
  56. -----------------------------------------------------------------