home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / ocl150a.zip / OCL / Source / OHelp.cpp < prev    next >
C/C++ Source or Header  |  1996-08-12  |  4KB  |  147 lines
  1. // OCL - OS/2 Class Library
  2. // (c) Cubus 1995
  3. // All Rights Reserved
  4. // OHelp.cpp
  5.  
  6. // help for PM applications
  7.  
  8. /*
  9.  * Redistribution and use in source and binary forms, with or without
  10.  * modification, are permitted provided that the following conditions
  11.  * are met:
  12.  * 1. Redistributions of source code must retain the above copyright
  13.  *    notice, this list of conditions and the following disclaimer.
  14.  * 2. Neither the name Cubus nor the name Team OCL may be used to
  15.  *    endorse or promote products derived from this software
  16.  *    without specific prior written permission.
  17.  * 3. See OCL.INF for a detailed copyright notice.
  18.  *
  19.  *              THIS SOFTWARE IS PROVIDED ``AS IS'' AND
  20.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29.  * SUCH DAMAGE.
  30.  */
  31.  
  32.  
  33. // $Header: W:/Projects/OCL/Source/rcs/OHelp.cpp 1.50 1996/08/11 23:49:17 B.STEIN Release $
  34.  
  35. #define __OCL_SOURCE__
  36.  
  37. #define OINCL_OSTRING
  38. #define OINCL_BASE
  39.  
  40. #include <ocl.hpp>
  41. #include <OHelp.hpp>
  42.  
  43.  
  44. OHelp::OHelp(const ULONG mainTable, const ULONG errorID)
  45.   : table(mainTable), 
  46.     errid(errorID), 
  47.     isHlpAvail(FALSE) 
  48.   {}
  49.  
  50.  
  51. OHelp::~OHelp() 
  52. {
  53.  terminateHelp(); 
  54. }
  55.  
  56.  
  57. PSZ OHelp::isOfType() const
  58. { 
  59.  return("OHelp"); 
  60. }
  61.  
  62.  
  63. OHelp& OHelp::terminateHelp()
  64. {
  65.  if (helpInstance)
  66.    WinDestroyHelpInstance(helpInstance);
  67.  return(*this);
  68. }
  69.  
  70.  
  71. OHelp& OHelp::initializeHelp(PSZ helpLibrary,
  72.                              PSZ title,
  73.                              const HWND associated)
  74. {
  75.  HELPINIT        HelpInit;
  76.  
  77.  if ((isHlpAvail) &&
  78.      (associated == assoc))
  79.     return(*this);
  80.  else
  81.     assoc = associated;
  82.  
  83.  HelpInit.cb                       = sizeof(HELPINIT);
  84.  HelpInit.ulReturnCode             = 0;
  85.  HelpInit.pszTutorialName          = (PSZ)NULL;
  86.  HelpInit.phtHelpTable             = (PHELPTABLE)MAKEULONG(table, 0xFFFF);
  87.  HelpInit.hmodHelpTableModule      = NULLHANDLE;
  88.  HelpInit.hmodAccelActionBarModule = NULLHANDLE;
  89.  HelpInit.idAccelTable             = 0;
  90.  HelpInit.idActionBar              = 0;
  91.  HelpInit.pszHelpWindowTitle       = title;
  92.  HelpInit.pszHelpLibraryName       = helpLibrary;
  93.  HelpInit.fShowPanelId             = 0;
  94.  
  95.  helpInstance = WinCreateHelpInstance(OApp::current().anchor(), &HelpInit);
  96.  
  97.  if ((!helpInstance) || (HelpInit.ulReturnCode))
  98.    throw OPMException(OCL::error(180), HelpInit.ulReturnCode);
  99.  
  100.  isHlpAvail = (BOOL) WinAssociateHelpInstance(helpInstance, associated);
  101.  
  102.  if(!isHlpAvail)
  103.    throw OPMException(OCL::error(181), 0);
  104.  
  105.  return(*this);
  106. }
  107.  
  108.  
  109.  
  110. OHelp& OHelp::helpRequest(const ULONG id)
  111. {
  112.  if(!isHlpAvail)
  113.    throw OPMException(OCL::error(182), 0);
  114.  
  115.  switch(id)
  116.    {
  117.     case help:
  118.       WinSendMsg(helpInstance, HM_DISPLAY_HELP, NULL, NULL);
  119.       break;
  120.  
  121.     case general:
  122.       WinSendMsg(helpInstance, HM_GENERAL_HELP, NULL, NULL);
  123.       break;
  124.  
  125.     case keys:
  126.       WinSendMsg(helpInstance, HM_KEYS_HELP, NULL, NULL);
  127.       break;
  128.  
  129.     case index:
  130.       WinSendMsg(helpInstance, HM_HELP_INDEX, NULL, NULL);
  131.       break;
  132.  
  133.     case contents:
  134.       WinSendMsg(helpInstance, HM_HELP_CONTENTS, NULL, NULL);
  135.       break;
  136.  
  137.     default:
  138.       WinSendMsg(helpInstance, HM_DISPLAY_HELP, MPFROMSHORT(id), HM_RESOURCEID);
  139.       break;
  140.    }
  141.  
  142.  return(*this);
  143. }
  144.  
  145.  
  146. // end of source
  147.