home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / ocl150a.zip / OCL / Include / OHelp.hpp < prev    next >
C/C++ Source or Header  |  1996-08-12  |  3KB  |  89 lines
  1. // OCL - OS/2 Class Library
  2. // (c) Cubus 1995
  3. // All Rights Reserved
  4. // OHelp.hpp
  5.  
  6. /*
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  * 1. Redistributions of source code must retain the above copyright
  11.  *    notice, this list of conditions and the following disclaimer.
  12.  * 2. Neither the name Cubus nor the name Team OCL may be used to
  13.  *    endorse or promote products derived from this software
  14.  *    without specific prior written permission.
  15.  * 3. See OCL.INF for a detailed copyright notice.
  16.  *
  17.  *              THIS SOFTWARE IS PROVIDED ``AS IS'' AND
  18.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27.  * SUCH DAMAGE.
  28.  */
  29.  
  30. // $Header: W:/Projects/OCL/Include/rcs/OHelp.hpp 1.50 1996/08/11 23:47:14 B.STEIN Release $
  31.  
  32. #ifndef OHELP_INCLUDED
  33.   #define OHELP_INCLUDED
  34.  
  35.  
  36.  
  37. #ifndef OPMEXCEPTION_INCLUDED
  38.   #include <OPMException.hpp>
  39. #endif
  40.  
  41.  
  42.  
  43. typedef class OHelp *pOHelp;
  44.  
  45.  
  46. class __CPP_EXPORT__ OHelp
  47.   : public OCLObject
  48. {
  49.  protected: 
  50.     ULONG      table;
  51.     ULONG      errid;
  52.     HWND       helpInstance;
  53.     HWND       assoc;
  54.  
  55.  public:
  56.     BOOL       isHlpAvail;
  57.  
  58.  enum
  59.     {
  60.       help     = 0,
  61.       general  = HM_GENERAL_HELP,
  62.       keys     = HM_KEYS_HELP,
  63.       index    = HM_HELP_INDEX,
  64.       contents = HM_HELP_CONTENTS
  65.     };
  66.  
  67.     OHelp              (const ULONG mainTable, 
  68.                         const ULONG errorID);
  69.                         // errorID is a stringtable ID containing the error message
  70.                         // beeing displayed if no help is available
  71.     virtual
  72.        ~OHelp          ();
  73.  
  74.     virtual
  75.        PSZ isOfType    () const;
  76.  
  77.     OHelp
  78.        &initializeHelp (PSZ helpLibrary,
  79.                         PSZ title,
  80.                         const HWND associated),
  81.        &terminateHelp  (),
  82.        &helpRequest    (const ULONG id);
  83. };
  84.  
  85. #endif // OHELP_INCLUDED
  86.  
  87.  
  88. // end of source
  89.