home *** CD-ROM | disk | FTP | other *** search
/ Power GUI Programming with VisualAge C++ / powergui.iso / trialva / ibmcppw / include / ihelpevt.hpp < prev    next >
Encoding:
C/C++ Source or Header  |  1996-02-22  |  4.8 KB  |  153 lines
  1. #ifndef _IHELPEVT_
  2. #define _IHELPEVT_
  3. /*******************************************************************************
  4. * FILE NAME: ihelpevt.hpp                                                      *
  5. *                                                                              *
  6. * DESCRIPTION:                                                                 *
  7. *   This file contains the declaration(s) of the class(es):                    *
  8. *     IHelpMenuBarEvent                                                        *
  9. *     IHelpErrorEvent                                                          *
  10. *     IHelpHypertextEvent (obsolete and replaced by IHelpHyperlinkEvent)       *
  11. *     IHelpHyperlinkEvent                                                      *
  12. *     IHelpSubitemNotFoundEvent                                                *
  13. *     IHelpTutorialEvent                                                       *
  14. *     IHelpNotifyEvent                                                         *
  15. *                                                                              *
  16. * COPYRIGHT:                                                                   *
  17. *   IBM Open Class Library                                                     *
  18. *   (C) Copyright International Business Machines Corporation 1992, 1996       *
  19. *   Licensed Material - Program-Property of IBM - All Rights Reserved.         *
  20. *   US Government Users Restricted Rights - Use, duplication, or disclosure    *
  21. *   restricted by GSA ADP Schedule Contract with IBM Corp.                     *
  22. *                                                                              *
  23. *******************************************************************************/
  24. #include <ievent.hpp>
  25.  
  26. #pragma pack(4)
  27.  
  28. class IHelpMenuBarEvent : public IEvent {
  29. typedef IEvent
  30.   Inherited;
  31. public:
  32. /*------------------------------- Constructors -------------------------------*/
  33.   IHelpMenuBarEvent ( const IEvent& event );
  34. virtual
  35.  ~IHelpMenuBarEvent ( );
  36.  
  37. /*----------------------------- Menu Information -----------------------------*/
  38. unsigned long
  39.   commandId ( ) const;
  40. }; // IHelpMenuBarEvent
  41.  
  42.  
  43. class IHelpErrorEvent : public IEvent {
  44. typedef IEvent
  45.   Inherited;
  46. public:
  47. /*------------------------------- Constructors -------------------------------*/
  48.   IHelpErrorEvent ( const IEvent& event );
  49. virtual
  50.  ~IHelpErrorEvent ( );
  51.  
  52. /*-------------------------------- Error Type --------------------------------*/
  53. enum ErrorType {
  54.   loadingDLL,
  55.   noWindow,
  56.   invalidAppHandle,
  57.   invalidInstanceHandle,
  58.   noHelpInstance,
  59.   invalidQueryHandle,
  60.   noHelpTable,
  61.   invalidId,
  62.   noIndex,
  63.   noContent,
  64.   openHelpFile,
  65.   readHelpFile,
  66.   closeHelpFile,
  67.   invalidHelpFile,
  68.   notEnoughMemory,
  69.   unableFreeMemory,
  70.   invalidHelpWindow,
  71.   unopenDatabase,
  72.   fontNotFound,
  73.   unknown
  74. }; // ErrorType
  75.  
  76. ErrorType
  77.   error ( ) const;
  78. }; // IHelpErrorEvent
  79.  
  80.  
  81. class IHelpHyperlinkEvent : public IEvent {
  82. typedef IEvent
  83.   Inherited;
  84. public:
  85. /*------------------------------- Constructors -------------------------------*/
  86.   IHelpHyperlinkEvent ( const IEvent& event );
  87. virtual
  88.  ~IHelpHyperlinkEvent ( );
  89.  
  90. /*----------------------------- Link Information -----------------------------*/
  91. unsigned long
  92.   id ( ) const;
  93. }; // IHelpHyperlinkEvent
  94.  
  95.  
  96. class IHelpSubitemNotFoundEvent : public IEvent {
  97. typedef IEvent
  98.   Inherited;
  99. public:
  100. /*------------------------------- Constructors -------------------------------*/
  101.   IHelpSubitemNotFoundEvent ( const IEvent& event );
  102. virtual
  103.  ~IHelpSubitemNotFoundEvent ( );
  104.  
  105. /*-------------------------------- Help Item ---------------------------------*/
  106. Boolean
  107.   isWindow   ( ) const,
  108.   isFrame    ( ) const,
  109.   isMenu     ( ) const;
  110.  
  111. unsigned long
  112.   topicId    ( ) const,
  113.   subtopicId ( ) const;
  114. }; // IHelpSubitemNotFoundEvent
  115.  
  116.  
  117. class IHelpTutorialEvent : public IEvent {
  118. typedef IEvent
  119.   Inherited;
  120. public:
  121. /*------------------------------- Constructors -------------------------------*/
  122.   IHelpTutorialEvent ( const IEvent& event );
  123. virtual
  124.  ~IHelpTutorialEvent ( );
  125.  
  126. /*--------------------------------- Tutorial ---------------------------------*/
  127. IString
  128.   tutorialName        ( )  const;
  129. }; // IHelpTutorialEvent
  130.  
  131.  
  132. class IHelpNotifyEvent : public IEvent {
  133. typedef IEvent
  134.   Inherited;
  135. public:
  136. /*------------------------------- Constructors -------------------------------*/
  137.   IHelpNotifyEvent ( const IEvent& event );
  138. virtual
  139.  ~IHelpNotifyEvent ( );
  140.  
  141. /*------------------------------- Help Window --------------------------------*/
  142. IWindowHandle
  143.   windowHandle ( ) const;
  144.  
  145. /*----------------------------- Selected Control -----------------------------*/
  146. unsigned long
  147.   controlId ( ) const;
  148. }; // IHelpNotifyEvent
  149.  
  150. #pragma pack()
  151.  
  152. #endif // _IHELPEVT_
  153.