home *** CD-ROM | disk | FTP | other *** search
/ cd-rom express 12 / CDRE12.ISO / Utilities / Kyn / VB5Code.ZIP / ContxtID.BAS < prev    next >
Encoding:
BASIC Source File  |  2001-10-07  |  8.4 KB  |  191 lines
  1. Attribute VB_Name = "ContextIDs"
  2. Option Explicit
  3. '=====================================================================
  4. '                  Copyright 1993-1996 by Teletech Systems, Inc. All rights reserved
  5. '
  6. '
  7. 'This source code may not be distributed in part or as a whole without
  8. 'express written permission from Teletech Systems.
  9. '=====================================================================
  10. '
  11. 'This source code contains the following routines:
  12. '  o SetAppHelp() 'Called in the main Form_Load event to register your
  13. '                 'program with WINHELP.EXE
  14. '  o QuitHelp()    'Deregisters your program with WINHELP.EXE. Should
  15. '                  'be called in your main Form_Unload event
  16. '  o ShowHelpTopic(Topicnum) 'Brings up context sensitive help based on
  17. '                  'any of the following CONTEXT IDs
  18. '  o ShowContents  'Displays the startup topic
  19. '********** Shameless Plug <g> **********
  20. 'The Standard and Professional editions of HelpWriter
  21. ' also include the following routines to add sizzle to your
  22. ' helpfile presentation...
  23. '  o HelpWindowSize(x,y,dx,dy) ' Position help window in a screen
  24. '                              ' independent manner
  25. '  o SearchHelp()  'Brings up the windows help KEYWORD SEARCH dialog box
  26. '***********************************************************************
  27. '
  28. '=====================================================================
  29. 'List of Context IDs for <Address>
  30. '=====================================================================
  31. Global Const Hlp_Main_Screen = 20    'Main Help Window
  32. '=====================================================================
  33. '
  34. '
  35. '  Help engine section.
  36.  
  37. ' Commands to pass WinHelp()
  38. Global Const HELP_CONTEXT = &H1 '  Display topic in ulTopic
  39. Global Const HELP_QUIT = &H2    '  Terminate help
  40. Global Const HELP_FINDER = &HB  '  Display Contents tab
  41. Global Const HELP_INDEX = &H3   '  Display index
  42. Global Const HELP_HELPONHELP = &H4      '  Display help on using help
  43. Global Const HELP_SETINDEX = &H5        '  Set the current Index for multi index help
  44. Global Const HELP_KEY = &H101           '  Display topic for keyword in offabData
  45. Global Const HELP_MULTIKEY = &H201
  46. Global Const HELP_CONTENTS = &H3     ' Display Help for a particular topic
  47. Global Const HELP_SETCONTENTS = &H5  ' Display Help contents topic
  48. Global Const HELP_CONTEXTPOPUP = &H8 ' Display Help topic in popup window
  49. Global Const HELP_FORCEFILE = &H9    ' Ensure correct Help file is displayed
  50. Global Const HELP_COMMAND = &H102    ' Execute Help macro
  51. Global Const HELP_PARTIALKEY = &H105 ' Display topic found in keyword list
  52. Global Const HELP_SETWINPOS = &H203  ' Display and position Help window
  53.  
  54.     Type HELPWININFO
  55.       wStructSize As Long
  56.       X As Long
  57.       Y As Long
  58.       dX As Long
  59.       dY As Long
  60.       wMax As Long
  61.       rgChMember As String * 2
  62.     End Type
  63.     Declare Function WinHelp Lib "User32.dll" Alias "WinHelpA" (ByVal hWnd As Long, ByVal lpHelpFile As String, ByVal wCommand As Long, ByVal dwData As Any) As Long
  64.     Declare Function WinHelpByInfo Lib "User32.dll" Alias "WinHelpA" (ByVal hWnd As Long, ByVal lpHelpFile As String, ByVal wCommand As Long, dwData As HELPWININFO) As Long
  65.     Declare Function WinHelpByStr Lib "User32.dll" Alias "WinHelpA" (ByVal hWnd As Long, ByVal lpHelpFile As String, ByVal wCommand As Long, ByVal dwData$) As Long
  66.     Declare Function WinHelpByNum Lib "User32.dll" Alias "WinHelpA" (ByVal hWnd As Long, ByVal lpHelpFile As String, ByVal wCommand As Long, ByVal dwData&) As Long
  67.     Dim m_hWndMainWindow As Long ' hWnd to tell WINHELP the helpfile owner
  68.  
  69. Dim MainWindowInfo As HELPWININFO
  70. Public Sub SetAppHelp(ByVal hWndMainWindow)
  71. '=====================================================================
  72. 'To use these subroutines to access WINHELP, you need to add
  73. 'at least this one subroutine call to your code
  74. '     o  In the Form_Load event of your main Form enter:
  75. '        Call SetAppHelp(Me.hWnd) 'To setup helpfile variables
  76. '         (If you are not interested in keyword searching or context
  77. '         sensitive help, this is the only call you need to make!)
  78. '=====================================================================
  79.     m_hWndMainWindow = hWndMainWindow
  80.     If Right$(Trim$(App.Path), 1) = "\" Then
  81.         App.HelpFile = App.Path + "KYN.HLP"
  82.     Else
  83.         App.HelpFile = App.Path + "\KYN.HLP"
  84.     End If
  85.     MainWindowInfo.wStructSize = 26
  86.     MainWindowInfo.X = 256
  87.     MainWindowInfo.Y = 256
  88.     MainWindowInfo.dX = 512
  89.     MainWindowInfo.dY = 512
  90.     MainWindowInfo.rgChMember = Chr$(0) + Chr$(0)
  91. End Sub
  92. Public Sub QuitHelp()
  93.     Dim Result As Variant
  94.     Result = WinHelp(m_hWndMainWindow, App.HelpFile, HELP_QUIT, Chr$(0) + Chr$(0) + Chr$(0) + Chr$(0))
  95. End Sub
  96. Public Sub ShowHelpTopic(ByVal ContextID As Long)
  97. '=====================================================================
  98. '  FOR CONTEXT SENSITIVE HELP IN RESPONSE TO A COMMAND BUTTON ...
  99. '=====================================================================
  100. '     o   For 'Help button' controls, you can call:
  101. '         Call ShowHelpTopic(<any Hlpxxx entry above>)
  102. '=====================================================================
  103. '  TO ADD FORM LEVEL CONTEXT SENSITIVE HELP...
  104. '=====================================================================
  105. '     o  For FORM level context sensetive help, you should set each
  106. '        Me.HelpContext=<any Hlp_xxx entry above>
  107. '
  108.     Dim Result As Variant
  109.  
  110.     Result = WinHelpByNum(m_hWndMainWindow, App.HelpFile, HELP_CONTEXT, CLng(ContextID))
  111.  
  112. End Sub
  113. Public Sub ShowHelpTopic2(ByVal ContextID As Long)
  114. '=====================================================================
  115. '  DISPLAY CONTEXT SENSITIVE HELP IN WINDOW 2 ...
  116. '=====================================================================
  117. '     o   For 'Help button' controls, you can call:
  118. '         Call ShowHelpTopic2(<any Hlpxxx entry above>)
  119. '
  120.     Dim Result As Variant
  121.  
  122.     Result = WinHelpByNum(m_hWndMainWindow, App.HelpFile & ">HlpWnd02", HELP_CONTEXT, CLng(ContextID))
  123.  
  124. End Sub
  125. Public Sub ShowHelpTopic3(ByVal ContextID As Long)
  126. '=====================================================================
  127. '  DISPLAY CONTEXT SENSITIVE HELP IN WINDOW 3 ...
  128. '=====================================================================
  129. '     o   For 'Help button' controls, you can call:
  130. '         Call ShowHelpTopic3(<any Hlpxxx entry above>)
  131. '
  132.     Dim Result As Variant
  133.  
  134.     Result = WinHelpByNum(m_hWndMainWindow, App.HelpFile & ">HlpWnd03", HELP_CONTEXT, CLng(ContextID))
  135.  
  136. End Sub
  137. Public Sub ShowGlossary()
  138.     Dim Result As Variant
  139.  
  140.     Result = WinHelpByNum(m_hWndMainWindow, App.HelpFile, HELP_CONTEXT, CLng(64000))
  141.  
  142. End Sub
  143. Public Sub ShowPopupHelp(ByVal ContextID As Long)
  144. '=====================================================================
  145. '  FOR POPUP HELP IN RESPONSE TO A COMMAND BUTTON ...
  146. '=====================================================================
  147.     Dim Result As Variant
  148.  
  149.     Result = WinHelpByNum(m_hWndMainWindow, App.HelpFile, HELP_CONTEXTPOPUP, CLng(ContextID))
  150.  
  151. End Sub
  152. Public Sub DoHelpMacro(ByVal MacroString As String)
  153. '=====================================================================
  154. '  FOR POPUP HELP IN RESPONSE TO A COMMAND BUTTON ...
  155. '=====================================================================
  156.     Dim Result As Variant
  157.  
  158.     Result = WinHelpByStr(m_hWndMainWindow, App.HelpFile, HELP_COMMAND, ByVal (MacroString))
  159.  
  160. End Sub
  161. Public Sub ShowHelpContents()
  162. '=====================================================================
  163. '  DISPLAY STARTUP TOPIC IN RESPONSE TO A COMMAND BUTTON or MENU ...
  164. '=====================================================================
  165. '
  166.     Dim Result As Variant
  167.  
  168.     Result = WinHelpByNum(m_hWndMainWindow, App.HelpFile, HELP_CONTENTS, CLng(0))
  169.  
  170. End Sub
  171. Public Sub ShowContentsTab()
  172. '=====================================================================
  173. '  DISPLAY Contents tab (*.CNT)
  174. '=====================================================================
  175. '
  176.     Dim Result As Variant
  177.  
  178.     Result = WinHelpByNum(m_hWndMainWindow, App.HelpFile, HELP_FINDER, CLng(0))
  179.  
  180. End Sub
  181. Public Sub ShowHelpOnHelp()
  182. '=====================================================================
  183. '  DISPLAY HELP for WINHELP.EXE  ...
  184. '=====================================================================
  185. '
  186.     Dim Result As Variant
  187.  
  188.     Result = WinHelpByNum(m_hWndMainWindow, App.HelpFile, HELP_HELPONHELP, CLng(0))
  189.  
  190. End Sub
  191.