home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / toolba.zip / AMHLPHDR.HPP < prev    next >
Text File  |  1994-09-05  |  2KB  |  51 lines
  1. /************************************************************************
  2. * AMHlpHdr.hpp - micro-help request message class header                *
  3. * --------------------------------------------------------------------- *
  4. * Override IHandler class in order to provide support for a micro-help  *
  5. * request message to be sent from a control to the frame window.  This  *
  6. * message has a user-defined id with two parameters.  The first para-   *
  7. * meter is the control id, and the second is a pointer to the control   *
  8. * window.                                                               *
  9. * --------------------------------------------------------------------- *
  10. * Overridden methods:                                                   *
  11. *                                                                       *
  12. * Boolean dispatchHandlerEvent - process messages to the window being   *
  13. *                                handled.  The method is overridded in  *
  14. *                                order to intercept the micro-help      *
  15. *                                message specifically.                  *
  16. *                                                                       *
  17. * New methods: -------------------------------------------------------- *
  18. *                                                                       *
  19. * void setMessageId -            set the message id for the micro-help  *
  20. *                                request.  This number is added to      *
  21. *                                WM_USER to avoid interference with PM. *
  22. *                                                                       *
  23. * Protected methods: -------------------------------------------------- *
  24. *                                                                       *
  25. * Boolean microHelp -            process micro-help request message     *
  26. *                                from control.                          *
  27. *                                                                       *
  28. ************************************************************************/
  29.  
  30. #ifndef _AMHLPHDR_HPP
  31. #define _AMHLPHDR_HPP
  32.  
  33. #include <ihandler.hpp>
  34.  
  35. class AMicroHelpHandler : public IHandler
  36. {
  37. public:
  38.    Boolean dispatchHandlerEvent( IEvent &evt );
  39.  
  40.    void setMessageId( unsigned long id );
  41.  
  42. protected:
  43.    virtual Boolean microHelp( IEvent &evt );
  44.  
  45. private:
  46.    unsigned long messageId;
  47. };
  48.  
  49. #endif /* _AMHLPHDR_HPP_ not defined */
  50.  
  51.