home *** CD-ROM | disk | FTP | other *** search
/ Really Useful CD 1 / ReallyUsefulCD1.iso / extras / progutils / _helpgen / support / messages
Encoding:
Text File  |  1991-12-02  |  1.5 KB  |  70 lines
  1. These notes (and they are just notes) detail the format of the messages
  2. supported by context sensitive HelpReader help texts. You may not understand
  3. them. If so, write to me.
  4.  
  5. However, unless you are writing a library for a language not supported yet,
  6. you probably will not need to use these notes.
  7.  
  8.  
  9. C3A80
  10. I'm here!
  11. data+0 task handle
  12. data+4 magic number
  13. data+8 name of helptext
  14.  
  15. Tells application that a help text has been loaded. If the name is the name
  16. you are listening for, store the task handle and the magic number.
  17.  
  18.  
  19. C3A81
  20. Are you there?
  21.  
  22. When broadcast, all HelpReader tasks will re-broadcast their C3A80 message.
  23.  
  24.  
  25. C3A82
  26. I'm closing down now
  27. data+0 task handle
  28. data+8 name of helptext
  29.  
  30. Broadcast when a HelpReader task quits.
  31.  
  32.  
  33. C3A83
  34. Please could you move the text
  35. data+0 which one to move to
  36. data+4 magic number
  37.  
  38. Asks the HelpReader task to move the text. Numbers to move to are allocated
  39. by HelpGen when text is compiled.
  40.  
  41.  
  42. C3A84
  43. Please bring the helptext to the front
  44. data+4 magic number
  45.  
  46. Guess
  47.  
  48.  
  49. How to use them
  50. ~~~~~~~~~~~~~~~
  51. When task starts up
  52.  Broadcast C3A81
  53.  
  54. While it is running
  55.  Listen for C3A80. When recived, set task handle and magic number
  56.  
  57. When C3A82 or Message_TaskCloseDown (400C4) recived for current HelpText
  58.  Blank task handle and magic number. Broadcast C3A81
  59.  
  60. When application quits
  61.  Don't do anything
  62.  
  63. When you want to move the text
  64.  Send C3A83 to task. Do not broadcast.
  65.  
  66. When you want to load the helptext (i.e. Help option in menu)
  67.  Check to see if you know a HelpText is present. If so, send C3A84 to it,
  68.  otherwise load it.
  69.  
  70.