htmlhelp.h
上传用户:dengkfang
上传日期:2008-12-30
资源大小:5233k
文件大小:18k
源码类别:

CA认证

开发平台:

Visual C++

  1. /****************************************************************************
  2. *                                                                           *
  3. * HtmlHelp.h                                                                *
  4. *                                                                           *
  5. * Copyright (c) 1996-1997, Microsoft Corp. All rights reserved.             *
  6. *                                                                           *
  7. ****************************************************************************/
  8. #if _MSC_VER > 1000
  9. #pragma once
  10. #endif
  11. #ifndef __HTMLHELP_H__
  12. #define __HTMLHELP_H__
  13. #ifdef __cplusplus
  14. extern "C" {
  15. #endif  // __cplusplus
  16. // Defines for Win64
  17. #ifndef _WIN64
  18. #define DWORD_PTR DWORD
  19. #endif
  20. // Commands to pass to HtmlHelp()
  21. #define HH_DISPLAY_TOPIC        0x0000
  22. #define HH_HELP_FINDER          0x0000  // WinHelp equivalent
  23. #define HH_DISPLAY_TOC          0x0001  
  24. #define HH_DISPLAY_INDEX        0x0002  
  25. #define HH_DISPLAY_SEARCH       0x0003  
  26. #define HH_SET_WIN_TYPE         0x0004
  27. #define HH_GET_WIN_TYPE         0x0005
  28. #define HH_GET_WIN_HANDLE       0x0006
  29. #define HH_ENUM_INFO_TYPE       0x0007  // Get Info type name, call repeatedly to enumerate, -1 at end
  30. #define HH_SET_INFO_TYPE        0x0008  // Add Info type to filter.
  31. #define HH_SYNC                 0x0009
  32. #define HH_RESERVED1            0x000A
  33. #define HH_RESERVED2            0x000B
  34. #define HH_RESERVED3            0x000C
  35. #define HH_KEYWORD_LOOKUP       0x000D
  36. #define HH_DISPLAY_TEXT_POPUP   0x000E  // display string resource id or text in a popup window
  37. #define HH_HELP_CONTEXT         0x000F  // display mapped numeric value in dwData
  38. #define HH_TP_HELP_CONTEXTMENU  0x0010  // text popup help, same as WinHelp HELP_CONTEXTMENU
  39. #define HH_TP_HELP_WM_HELP      0x0011  // text popup help, same as WinHelp HELP_WM_HELP
  40. #define HH_CLOSE_ALL            0x0012  // close all windows opened directly or indirectly by the caller
  41. #define HH_ALINK_LOOKUP         0x0013  // ALink version of HH_KEYWORD_LOOKUP
  42. #define HH_GET_LAST_ERROR       0x0014  // not currently implemented // See HHERROR.h
  43. #define HH_ENUM_CATEGORY        0x0015 // Get category name, call repeatedly to enumerate, -1 at end
  44. #define HH_ENUM_CATEGORY_IT     0x0016  // Get category info type members, call repeatedly to enumerate, -1 at end
  45. #define HH_RESET_IT_FILTER      0x0017  // Clear the info type filter of all info types.
  46. #define HH_SET_INCLUSIVE_FILTER 0x0018  // set inclusive filtering method for untyped topics to be included in display
  47. #define HH_SET_EXCLUSIVE_FILTER 0x0019  // set exclusive filtering method for untyped topics to be excluded from display
  48. #define HH_INITIALIZE            0x001C  // Initializes the help system.
  49. #define HH_UNINITIALIZE          0x001D  // Uninitializes the help system.
  50. #define HH_PRETRANSLATEMESSAGE  0x00fd  // Pumps messages. (NULL, NULL, MSG*). 
  51. #define HH_SET_GLOBAL_PROPERTY  0x00fc  // Set a global property. (NULL, NULL, HH_GPROP)
  52. #define HHWIN_PROP_TAB_AUTOHIDESHOW (1 << 0)    // Automatically hide/show tri-pane window
  53. #define HHWIN_PROP_ONTOP            (1 << 1)    // Top-most window
  54. #define HHWIN_PROP_NOTITLEBAR       (1 << 2)    // no title bar
  55. #define HHWIN_PROP_NODEF_STYLES     (1 << 3)    // no default window styles (only HH_WINTYPE.dwStyles)
  56. #define HHWIN_PROP_NODEF_EXSTYLES   (1 << 4)    // no default extended window styles (only HH_WINTYPE.dwExStyles)
  57. #define HHWIN_PROP_TRI_PANE         (1 << 5)    // use a tri-pane window
  58. #define HHWIN_PROP_NOTB_TEXT        (1 << 6)    // no text on toolbar buttons
  59. #define HHWIN_PROP_POST_QUIT        (1 << 7)    // post WM_QUIT message when window closes
  60. #define HHWIN_PROP_AUTO_SYNC        (1 << 8)    // automatically ssync contents and index
  61. #define HHWIN_PROP_TRACKING         (1 << 9)    // send tracking notification messages
  62. #define HHWIN_PROP_TAB_SEARCH       (1 << 10)   // include search tab in navigation pane
  63. #define HHWIN_PROP_TAB_HISTORY      (1 << 11)   // include history tab in navigation pane
  64. #define HHWIN_PROP_TAB_FAVORITES    (1 << 12)   // include favorites tab in navigation pane
  65. #define HHWIN_PROP_CHANGE_TITLE     (1 << 13)   // Put current HTML title in title bar
  66. #define HHWIN_PROP_NAV_ONLY_WIN     (1 << 14)   // Only display the navigation window
  67. #define HHWIN_PROP_NO_TOOLBAR       (1 << 15)   // Don't display a toolbar
  68. #define HHWIN_PROP_MENU             (1 << 16)   // Menu
  69. #define HHWIN_PROP_TAB_ADVSEARCH    (1 << 17)   // Advanced FTS UI.
  70. #define HHWIN_PROP_USER_POS         (1 << 18)   // After initial creation, user controls window size/position
  71. #define HHWIN_PROP_TAB_CUSTOM1      (1 << 19)   // Use custom tab #1
  72. #define HHWIN_PROP_TAB_CUSTOM2      (1 << 20)   // Use custom tab #2
  73. #define HHWIN_PROP_TAB_CUSTOM3      (1 << 21)   // Use custom tab #3
  74. #define HHWIN_PROP_TAB_CUSTOM4      (1 << 22)   // Use custom tab #4
  75. #define HHWIN_PROP_TAB_CUSTOM5      (1 << 23)   // Use custom tab #5
  76. #define HHWIN_PROP_TAB_CUSTOM6      (1 << 24)   // Use custom tab #6
  77. #define HHWIN_PROP_TAB_CUSTOM7      (1 << 25)   // Use custom tab #7
  78. #define HHWIN_PROP_TAB_CUSTOM8      (1 << 26)   // Use custom tab #8
  79. #define HHWIN_PROP_TAB_CUSTOM9      (1 << 27)   // Use custom tab #9
  80. #define HHWIN_TB_MARGIN             (1 << 28)   // the window type has a margin
  81. #define HHWIN_PARAM_PROPERTIES      (1 << 1)    // valid fsWinProperties
  82. #define HHWIN_PARAM_STYLES          (1 << 2)    // valid dwStyles
  83. #define HHWIN_PARAM_EXSTYLES        (1 << 3)    // valid dwExStyles
  84. #define HHWIN_PARAM_RECT            (1 << 4)    // valid rcWindowPos
  85. #define HHWIN_PARAM_NAV_WIDTH       (1 << 5)    // valid iNavWidth
  86. #define HHWIN_PARAM_SHOWSTATE       (1 << 6)    // valid nShowState
  87. #define HHWIN_PARAM_INFOTYPES       (1 << 7)    // valid apInfoTypes
  88. #define HHWIN_PARAM_TB_FLAGS        (1 << 8)    // valid fsToolBarFlags
  89. #define HHWIN_PARAM_EXPANSION       (1 << 9)    // valid fNotExpanded
  90. #define HHWIN_PARAM_TABPOS          (1 << 10)   // valid tabpos
  91. #define HHWIN_PARAM_TABORDER        (1 << 11)   // valid taborder
  92. #define HHWIN_PARAM_HISTORY_COUNT   (1 << 12)   // valid cHistory
  93. #define HHWIN_PARAM_CUR_TAB         (1 << 13)   // valid curNavType
  94. #define HHWIN_BUTTON_EXPAND         (1 << 1)    // Expand/contract button
  95. #define HHWIN_BUTTON_BACK           (1 << 2)    // Back button
  96. #define HHWIN_BUTTON_FORWARD        (1 << 3)    // Forward button
  97. #define HHWIN_BUTTON_STOP           (1 << 4)    // Stop button
  98. #define HHWIN_BUTTON_REFRESH        (1 << 5)    // Refresh button
  99. #define HHWIN_BUTTON_HOME           (1 << 6)    // Home button
  100. #define HHWIN_BUTTON_BROWSE_FWD     (1 << 7)    // not implemented
  101. #define HHWIN_BUTTON_BROWSE_BCK     (1 << 8)    // not implemented
  102. #define HHWIN_BUTTON_NOTES          (1 << 9)    // not implemented
  103. #define HHWIN_BUTTON_CONTENTS       (1 << 10)   // not implemented
  104. #define HHWIN_BUTTON_SYNC           (1 << 11)   // Sync button
  105. #define HHWIN_BUTTON_OPTIONS        (1 << 12)   // Options button
  106. #define HHWIN_BUTTON_PRINT          (1 << 13)   // Print button
  107. #define HHWIN_BUTTON_INDEX          (1 << 14)   // not implemented
  108. #define HHWIN_BUTTON_SEARCH         (1 << 15)   // not implemented
  109. #define HHWIN_BUTTON_HISTORY        (1 << 16)   // not implemented
  110. #define HHWIN_BUTTON_FAVORITES      (1 << 17)   // not implemented
  111. #define HHWIN_BUTTON_JUMP1          (1 << 18)
  112. #define HHWIN_BUTTON_JUMP2          (1 << 19)
  113. #define HHWIN_BUTTON_ZOOM           (1 << 20)
  114. #define HHWIN_BUTTON_TOC_NEXT       (1 << 21)
  115. #define HHWIN_BUTTON_TOC_PREV       (1 << 22)
  116. #define HHWIN_DEF_BUTTONS           
  117.             (HHWIN_BUTTON_EXPAND |  
  118.              HHWIN_BUTTON_BACK |    
  119.              HHWIN_BUTTON_OPTIONS | 
  120.              HHWIN_BUTTON_PRINT)
  121. // Button IDs
  122. #define IDTB_EXPAND             200
  123. #define IDTB_CONTRACT           201
  124. #define IDTB_STOP               202
  125. #define IDTB_REFRESH            203
  126. #define IDTB_BACK               204
  127. #define IDTB_HOME               205
  128. #define IDTB_SYNC               206
  129. #define IDTB_PRINT              207
  130. #define IDTB_OPTIONS            208
  131. #define IDTB_FORWARD            209
  132. #define IDTB_NOTES              210 // not implemented
  133. #define IDTB_BROWSE_FWD         211
  134. #define IDTB_BROWSE_BACK        212
  135. #define IDTB_CONTENTS           213 // not implemented
  136. #define IDTB_INDEX              214 // not implemented
  137. #define IDTB_SEARCH             215 // not implemented
  138. #define IDTB_HISTORY            216 // not implemented
  139. #define IDTB_FAVORITES          217 // not implemented
  140. #define IDTB_JUMP1              218
  141. #define IDTB_JUMP2              219
  142. #define IDTB_CUSTOMIZE          221
  143. #define IDTB_ZOOM               222
  144. #define IDTB_TOC_NEXT           223
  145. #define IDTB_TOC_PREV           224
  146. // Notification codes
  147. #define HHN_FIRST       (0U-860U)
  148. #define HHN_LAST        (0U-879U)
  149. #define HHN_NAVCOMPLETE   (HHN_FIRST-0)
  150. #define HHN_TRACK         (HHN_FIRST-1)
  151. #define HHN_WINDOW_CREATE (HHN_FIRST-2)
  152. typedef struct tagHHN_NOTIFY
  153. {
  154.     NMHDR   hdr;
  155.     PCSTR   pszUrl; // Multi-byte, null-terminated string
  156. } HHN_NOTIFY;
  157. typedef struct tagHH_POPUP
  158. {
  159.     int       cbStruct;      // sizeof this structure
  160.     HINSTANCE hinst;         // instance handle for string resource
  161.     UINT      idString;      // string resource id, or text id if pszFile is specified in HtmlHelp call
  162.     LPCTSTR   pszText;       // used if idString is zero
  163.     POINT     pt;            // top center of popup window
  164.     COLORREF  clrForeground; // use -1 for default
  165.     COLORREF  clrBackground; // use -1 for default
  166.     RECT      rcMargins;     // amount of space between edges of window and text, -1 for each member to ignore
  167.     LPCTSTR   pszFont;       // facename, point size, char set, BOLD ITALIC UNDERLINE
  168. } HH_POPUP;
  169. typedef struct tagHH_AKLINK
  170. {
  171.     int       cbStruct;     // sizeof this structure
  172.     BOOL      fReserved;    // must be FALSE (really!)
  173.     LPCTSTR   pszKeywords;  // semi-colon separated keywords
  174.     LPCTSTR   pszUrl;       // URL to jump to if no keywords found (may be NULL)
  175.     LPCTSTR   pszMsgText;   // Message text to display in MessageBox if pszUrl is NULL and no keyword match
  176.     LPCTSTR   pszMsgTitle;  // Message text to display in MessageBox if pszUrl is NULL and no keyword match
  177.     LPCTSTR   pszWindow;    // Window to display URL in
  178.     BOOL      fIndexOnFail; // Displays index if keyword lookup fails.
  179. } HH_AKLINK;
  180. enum {
  181.     HHWIN_NAVTYPE_TOC,
  182.     HHWIN_NAVTYPE_INDEX,
  183.     HHWIN_NAVTYPE_SEARCH,
  184.     HHWIN_NAVTYPE_FAVORITES,
  185.     HHWIN_NAVTYPE_HISTORY,   // not implemented
  186.     HHWIN_NAVTYPE_AUTHOR,
  187.     HHWIN_NAVTYPE_CUSTOM_FIRST = 11
  188. };
  189. enum {
  190.     IT_INCLUSIVE,
  191.     IT_EXCLUSIVE,
  192.     IT_HIDDEN,
  193. };
  194. typedef struct tagHH_ENUM_IT
  195. {
  196.     int       cbStruct;          // size of this structure
  197.     int       iType;             // the type of the information type ie. Inclusive, Exclusive, or Hidden
  198.     LPCSTR    pszCatName;        // Set to the name of the Category to enumerate the info types in a category; else NULL
  199.     LPCSTR    pszITName;         // volitile pointer to the name of the infotype. Allocated by call. Caller responsible for freeing
  200.     LPCSTR    pszITDescription;  // volitile pointer to the description of the infotype.
  201. } HH_ENUM_IT, *PHH_ENUM_IT;
  202. typedef struct tagHH_ENUM_CAT
  203. {
  204.     int       cbStruct;          // size of this structure
  205.     LPCSTR    pszCatName;        // volitile pointer to the category name
  206.     LPCSTR    pszCatDescription; // volitile pointer to the category description
  207. } HH_ENUM_CAT, *PHH_ENUM_CAT;
  208. typedef struct tagHH_SET_INFOTYPE
  209. {
  210.     int       cbStruct;          // the size of this structure
  211.     LPCSTR    pszCatName;        // the name of the category, if any, the InfoType is a member of.
  212.     LPCSTR    pszInfoTypeName;   // the name of the info type to add to the filter
  213. } HH_SET_INFOTYPE, *PHH_SET_INFOTYPE;
  214. typedef DWORD HH_INFOTYPE;
  215. typedef HH_INFOTYPE* PHH_INFOTYPE;
  216. enum {
  217.     HHWIN_NAVTAB_TOP,
  218.     HHWIN_NAVTAB_LEFT,
  219.     HHWIN_NAVTAB_BOTTOM,
  220. };
  221. #define HH_MAX_TABS 19  // maximum number of tabs
  222. enum {
  223.     HH_TAB_CONTENTS,
  224.     HH_TAB_INDEX,
  225.     HH_TAB_SEARCH,
  226.     HH_TAB_FAVORITES,
  227.     HH_TAB_HISTORY,
  228.     HH_TAB_AUTHOR,
  229.     HH_TAB_CUSTOM_FIRST = 11,
  230.     HH_TAB_CUSTOM_LAST = HH_MAX_TABS
  231. };
  232. #define HH_MAX_TABS_CUSTOM (HH_TAB_CUSTOM_LAST - HH_TAB_CUSTOM_FIRST + 1)
  233. // HH_DISPLAY_SEARCH Command Related Structures and Constants
  234. #define HH_FTS_DEFAULT_PROXIMITY (-1)
  235. typedef struct tagHH_FTS_QUERY
  236. {
  237.     int cbStruct;            // Sizeof structure in bytes.
  238.     BOOL fUniCodeStrings;    // TRUE if all strings are unicode.
  239.     LPCTSTR pszSearchQuery;  // String containing the search query.
  240.     LONG iProximity;         // Word proximity.
  241.     BOOL fStemmedSearch;     // TRUE for StemmedSearch only.
  242.     BOOL fTitleOnly;         // TRUE for Title search only.
  243.     BOOL fExecute;           // TRUE to initiate the search.
  244.     LPCTSTR pszWindow;       // Window to display in
  245. } HH_FTS_QUERY;
  246. // HH_WINTYPE Structure
  247. typedef struct tagHH_WINTYPE {
  248.     int     cbStruct;        // IN: size of this structure including all Information Types
  249.     BOOL    fUniCodeStrings; // IN/OUT: TRUE if all strings are in UNICODE
  250.     LPCTSTR pszType;         // IN/OUT: Name of a type of window
  251.     DWORD   fsValidMembers;  // IN: Bit flag of valid members (HHWIN_PARAM_)
  252.     DWORD   fsWinProperties; // IN/OUT: Properties/attributes of the window (HHWIN_)
  253.     LPCTSTR pszCaption;      // IN/OUT: Window title
  254.     DWORD   dwStyles;        // IN/OUT: Window styles
  255.     DWORD   dwExStyles;      // IN/OUT: Extended Window styles
  256.     RECT    rcWindowPos;     // IN: Starting position, OUT: current position
  257.     int     nShowState;      // IN: show state (e.g., SW_SHOW)
  258.     HWND  hwndHelp;          // OUT: window handle
  259.     HWND  hwndCaller;        // OUT: who called this window
  260.     HH_INFOTYPE* paInfoTypes;  // IN: Pointer to an array of Information Types
  261.     // The following members are only valid if HHWIN_PROP_TRI_PANE is set
  262.     HWND  hwndToolBar;      // OUT: toolbar window in tri-pane window
  263.     HWND  hwndNavigation;   // OUT: navigation window in tri-pane window
  264.     HWND  hwndHTML;         // OUT: window displaying HTML in tri-pane window
  265.     int   iNavWidth;        // IN/OUT: width of navigation window
  266.     RECT  rcHTML;           // OUT: HTML window coordinates
  267.     LPCTSTR pszToc;         // IN: Location of the table of contents file
  268.     LPCTSTR pszIndex;       // IN: Location of the index file
  269.     LPCTSTR pszFile;        // IN: Default location of the html file
  270.     LPCTSTR pszHome;        // IN/OUT: html file to display when Home button is clicked
  271.     DWORD   fsToolBarFlags; // IN: flags controling the appearance of the toolbar
  272.     BOOL    fNotExpanded;   // IN: TRUE/FALSE to contract or expand, OUT: current state
  273.     int     curNavType;     // IN/OUT: UI to display in the navigational pane
  274.     int     tabpos;         // IN/OUT: HHWIN_NAVTAB_TOP, HHWIN_NAVTAB_LEFT, or HHWIN_NAVTAB_BOTTOM
  275.     int     idNotify;       // IN: ID to use for WM_NOTIFY messages
  276.     BYTE    tabOrder[HH_MAX_TABS + 1];    // IN/OUT: tab order: Contents, Index, Search, History, Favorites, Reserved 1-5, Custom tabs
  277.     int     cHistory;       // IN/OUT: number of history items to keep (default is 30)
  278.     LPCTSTR pszJump1;       // Text for HHWIN_BUTTON_JUMP1
  279.     LPCTSTR pszJump2;       // Text for HHWIN_BUTTON_JUMP2
  280.     LPCTSTR pszUrlJump1;    // URL for HHWIN_BUTTON_JUMP1
  281.     LPCTSTR pszUrlJump2;    // URL for HHWIN_BUTTON_JUMP2
  282.     RECT    rcMinSize;      // Minimum size for window (ignored in version 1)
  283.     int     cbInfoTypes;    // size of paInfoTypes;
  284.     LPCTSTR pszCustomTabs;  // multiple zero-terminated strings
  285. } HH_WINTYPE, *PHH_WINTYPE;
  286. enum {
  287.     HHACT_TAB_CONTENTS,
  288.     HHACT_TAB_INDEX,
  289.     HHACT_TAB_SEARCH,
  290.     HHACT_TAB_HISTORY,
  291.     HHACT_TAB_FAVORITES,
  292.     HHACT_EXPAND,
  293.     HHACT_CONTRACT,
  294.     HHACT_BACK,
  295.     HHACT_FORWARD,
  296.     HHACT_STOP,
  297.     HHACT_REFRESH,
  298.     HHACT_HOME,
  299.     HHACT_SYNC,
  300.     HHACT_OPTIONS,
  301.     HHACT_PRINT,
  302.     HHACT_HIGHLIGHT,
  303.     HHACT_CUSTOMIZE,
  304.     HHACT_JUMP1,
  305.     HHACT_JUMP2,
  306.     HHACT_ZOOM,
  307.     HHACT_TOC_NEXT,
  308.     HHACT_TOC_PREV,
  309.     HHACT_NOTES,
  310.     HHACT_LAST_ENUM,
  311. };
  312. typedef struct tagHHNTRACK
  313. {
  314.     NMHDR   hdr;
  315.     PCSTR   pszCurUrl;      // Multi-byte, null-terminated string
  316.     int     idAction;       // HHACT_ value
  317.     HH_WINTYPE* phhWinType; // Current window type structure
  318. } HHNTRACK;
  319. HWND
  320. WINAPI
  321. HtmlHelpA(
  322.     HWND hwndCaller,
  323.     LPCSTR pszFile,
  324.     UINT uCommand,
  325.     DWORD_PTR dwData
  326.     );
  327. HWND
  328. WINAPI
  329. HtmlHelpW(
  330.     HWND hwndCaller,
  331.     LPCWSTR pszFile,
  332.     UINT uCommand,
  333.     DWORD_PTR dwData
  334.     );
  335. #ifdef UNICODE
  336. #define HtmlHelp  HtmlHelpW
  337. #else
  338. #define HtmlHelp  HtmlHelpA
  339. #endif // !UNICODE
  340. // Use the following for GetProcAddress to load from hhctrl.ocx
  341. #define ATOM_HTMLHELP_API_ANSI    (LPTSTR)((DWORD)((WORD)(14)))
  342. #define ATOM_HTMLHELP_API_UNICODE (LPTSTR)((DWORD)((WORD)(15)))
  343. ///////////////////////////////////////////////////////////////////////////////
  344. //
  345. // Global Control Properties. 
  346. //
  347. typedef enum tagHH_GPROPID
  348. {
  349.     HH_GPROPID_SINGLETHREAD=1,      // VARIANT_BOOL: True for single thread
  350.     HH_GPROPID_TOOLBAR_MARGIN=2,    // long: Provides a left/right margin around the toolbar.
  351.     HH_GPROPID_UI_LANGUAGE=3,       // long: LangId of the UI.
  352.     HH_GPROPID_CURRENT_SUBSET=4,    // BSTR: Current subset.
  353.     HH_GPROPID_CONTENT_LANGUAGE=5   // long: LandId for desired content.
  354. } HH_GPROPID;
  355. ///////////////////////////////////////////////////////////////////////////////
  356. //
  357. // Global Property structure
  358. //
  359. #ifdef __oaidl_h__
  360. #pragma pack(push, 8)
  361. typedef struct tagHH_GLOBAL_PROPERTY
  362. {
  363.     HH_GPROPID  id;
  364.     VARIANT     var;
  365. } HH_GLOBAL_PROPERTY ;
  366. #pragma pack(pop)
  367. #endif
  368. #ifdef __cplusplus
  369. }
  370. #endif // __cplusplus
  371. #endif // __HTMLHELP_H__