home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional Developers Kit 1992 November / Disc01 / Disc01.mdf / cppbeta / ibmcli / ihelphdr.hp_ / IHELPHDR.HPP
Encoding:
C/C++ Source or Header  |  1992-10-26  |  4.4 KB  |  100 lines
  1. #ifndef _IHELPHDR_
  2. #define _IHELPHDR_
  3. /*******************************************************************************
  4. * FILE NAME: ihelphdr.hpp                                                       *
  5. *                                                                              *
  6. * DESCRIPTION:                                                                 *
  7. *   Declaration of the class(es):                                              *
  8. *     IHelpHandler - This class deals with help events                         *
  9. *                                                                              *
  10. * COPYRIGHT:                                                                   *
  11. *   Licensed Materials - Property of IBM                                       *
  12. *   (C) Copyright IBM Corporation 1992, 1993                                   *
  13. *   All Rights Reserved                                                        *
  14. *   US Government Users Restricted Rights - Use, duplication, or disclosure    *
  15. *   restricted by GSA ADP Schedule Contract with IBM Corp.                     *
  16. *                                                                              *
  17. *$Log:   R:/IBMCLASS/IBASEAPP/VCS/IHELPHDR.HPV  $
  18. //
  19. //   Rev 1.1   26 Oct 1992 10:49:08   nunn
  20. //Kevin's changes for 10/26
  21.    
  22.       Rev 1.1   26 Oct 1992 00:00:01   kleong
  23.    Miscellaneous improvements.
  24. *******************************************************************************/
  25. #ifndef _IHANDLER_
  26.   #include <ihandler.hpp>
  27. #endif
  28.  
  29. // Forward declarations for other classes:
  30. class IHelpHandler;
  31. class ICommandEvent;
  32.  
  33. class IHelpHandler : public IHandler {
  34. /*******************************************************************************
  35. * The IHelpHandler class deals with help window events.                        *
  36. *                                                                              *
  37. * EXAMPLE:                                                                     *
  38. *   <sample code>                                                              *
  39. *******************************************************************************/
  40. typedef IHandler Inherited;
  41. protected:
  42.  
  43. /*---------------------------- EVENT HANDLING ----------------------------------
  44. | These function provide means of handling help events                         |
  45.     helpCommand     - Overrides this function to perform process
  46.                       when a tailored menu bar item is selected
  47.     hypertextSelect - Overrides this function to provide hypertext
  48.                       processing
  49.     controlSelect   - Overrides this function to perform action
  50.                       when help window control is selected
  51.     notifyOpen      - Overrides this function to perform action
  52.                       when component of help window is opened
  53.     showTutorial    - Overrides this function to start the
  54.                       application tutorial
  55.     showKeysHelp    - Overrides this function to display Keys Help
  56.                       panel
  57. ------------------------------------------------------------------------------*/
  58. virtual Boolean
  59.   helpCommand(ICommandEvent& cmdevt) {return false;}
  60. virtual Boolean
  61.   hypertextSelect(unsigned long linkId) {return false;}
  62.  
  63. static const unsigned long
  64.   previousButtonId,
  65.   searchButtonId,
  66.   printButtonId,
  67.   indexButtonId,
  68.   contentsButtonId,
  69.   backButtonId,
  70.   forwardButtonId,
  71.   tutorialButtonId;
  72.  
  73. virtual Boolean 
  74.   controlSelect(unsigned long controlResId) {return false;}
  75.  
  76. enum Notification 
  77.   { openCoverpage, openPage, swapPage, openIndex, openContents,
  78.     openHistory, openLibrary, openSearchHitList};
  79.  
  80. virtual Boolean 
  81.   notifyOpen(Notification n) {return false;}
  82.         //setResult(true) - IPF will not format the controls
  83.         //     or resize window otherwise process as normal
  84.  
  85. virtual Boolean 
  86.   showTutorial() {return false;}
  87. virtual Boolean 
  88.   showKeysHelp() {return false;}
  89.         // setResult keyHelpId
  90.  
  91. /*-------------------------------- OVERRIDES -----------------------------------
  92. | This class overrides the following inherited functions:                      |
  93. |   dispatchHandlerEvent -  Processes help error messages and dispatch
  94.                             help event handling functions
  95. ------------------------------------------------------------------------------*/
  96. virtual Boolean 
  97.   dispatchHandlerEvent(IEvent& evt);
  98. };
  99. #endif /* IHELPHDR */
  100.