home *** CD-ROM | disk | FTP | other *** search
/ Inside Multimedia 1995 July / IMM0795.ISO / share / os2 / pmfract / src / smplhelp.hlp < prev    next >
Text File  |  1994-01-24  |  2KB  |  47 lines
  1. SMPLHELP.DLL
  2.  
  3. (Simple Help)
  4.  
  5. This is a simple scrolling window for displaying some kind
  6. of help text.
  7. Poke at it and it will act like any other window.
  8. Scroll the text to see more, using either the keyboard
  9. or the mouse on the scrollbar.
  10.  
  11. To return to the original Help text, select
  12. "Last Help" from the Help menu item, or press F9.
  13. This function lets you switch between this and the
  14. application help, or between two help texts from the application.
  15.  
  16. ----------------------------------
  17.  
  18. SMPLHELP.C -- a Simple Help Displayer system
  19.  
  20. This DLL system is used to display a simple help window
  21. to go along with a main application window of choice.
  22.  
  23. Interface is through three functions, only one of which
  24. is required to be called:
  25.  
  26.    SimpleHelpInit (HAB hab);    // optional one-time initialization
  27.    SimpleHelpExit (void);       // optional clean-up call
  28.    SimpleHelp (HAB hab, HWND hwndUser, PSZ achUser,    // Required call to display
  29.       HMODULE hmodUser, USHORT idType, USHORT idName); // a given text resource.
  30.  
  31. Help text is stored as user resources in the callers EXE file.
  32. The type and ID of these user resources is passed to SimpleHelp,
  33. which causes the help window to be created if it does not
  34. exist and the described text to be displayed.
  35.  
  36. SimpleHelp is the primary interface to the Simple Help System.
  37. It is assumed to be called from a user Client Window Proc.
  38. We do what is necessary to get us up and the focus of attention,
  39. and ready to display the requested help text.
  40. On return from this function, the Simple Help window is an independent
  41. top-level window in the same thread as the original caller.
  42.  
  43. We can be recalled to change the help text even if we are already
  44. open.  This allows a user routine to have possibly multiple submenu
  45. entries in his "Help" menu, and the text displayed here can be
  46. switched by the Help menu in the original window.
  47.