ReactOS 0.4.15-dev-8100-g1887773
htmlhelp.h
Go to the documentation of this file.
1/*
2 * Copyright 2004 Jacek Caban
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
17 */
18
19#ifndef __HTMLHELP_H__
20#define __HTMLHELP_H__
21
22#define HH_DISPLAY_TOPIC 0x00
23#define HH_HELP_FINDER 0x00
24#define HH_DISPLAY_TOC 0x01
25#define HH_DISPLAY_INDEX 0x02
26#define HH_DISPLAY_SEARCH 0x03
27#define HH_SET_WIN_TYPE 0x04
28#define HH_GET_WIN_TYPE 0x05
29#define HH_GET_WIN_HANDLE 0x06
30#define HH_ENUM_INFO_TYPE 0x07
31#define HH_SET_INFO_TYPE 0x08
32#define HH_SYNC 0x09
33#define HH_RESERVED1 0x0A
34#define HH_RESERVED2 0x0B
35#define HH_RESERVED3 0x0C
36#define HH_KEYWORD_LOOKUP 0x0D
37#define HH_DISPLAY_TEXT_POPUP 0x0E
38#define HH_HELP_CONTEXT 0x0F
39#define HH_TP_HELP_CONTEXTMENU 0x10
40#define HH_TP_HELP_WM_HELP 0x11
41#define HH_CLOSE_ALL 0x12
42#define HH_ALINK_LOOKUP 0x13
43#define HH_GET_LAST_ERROR 0x14
44#define HH_ENUM_CATEGORY 0x15
45#define HH_ENUM_CATEGORY_IT 0x16
46#define HH_RESET_IT_FILTER 0x17
47#define HH_SET_INCLUSIVE_FILTER 0x18
48#define HH_SET_EXCLUSIVE_FILTER 0x19
49#define HH_INITIALIZE 0x1C
50#define HH_UNINITIALIZE 0x1D
51#define HH_SAFE_DISPLAY_TOPIC 0x20
52#define HH_PRETRANSLATEMESSAGE 0xFD
53#define HH_SET_GLOBAL_PROPERTY 0xFC
54
55#define HHWIN_PROP_TAB_AUTOHIDESHOW 0x00000001
56#define HHWIN_PROP_ONTOP 0x00000002
57#define HHWIN_PROP_NOTITLEBAR 0x00000004
58#define HHWIN_PROP_NODEF_STYLES 0x00000008
59#define HHWIN_PROP_NODEF_EXSTYLES 0x00000010
60#define HHWIN_PROP_TRI_PANE 0x00000020
61#define HHWIN_PROP_NOTB_TEXT 0x00000040
62#define HHWIN_PROP_POST_QUIT 0x00000080
63#define HHWIN_PROP_AUTO_SYNC 0x00000100
64#define HHWIN_PROP_TRACKING 0x00000200
65#define HHWIN_PROP_TAB_SEARCH 0x00000400
66#define HHWIN_PROP_TAB_HISTORY 0x00000800
67#define HHWIN_PROP_TAB_FAVORITES 0x00001000
68#define HHWIN_PROP_CHANGE_TITLE 0x00002000
69#define HHWIN_PROP_NAV_ONLY_WIN 0x00004000
70#define HHWIN_PROP_NO_TOOLBAR 0x00008000
71#define HHWIN_PROP_MENU 0x00010000
72#define HHWIN_PROP_TAB_ADVSEARCH 0x00020000
73#define HHWIN_PROP_USER_POS 0x00040000
74#define HHWIN_PROP_TAB_CUSTOM1 0x00080000
75#define HHWIN_PROP_TAB_CUSTOM2 0x00100000
76#define HHWIN_PROP_TAB_CUSTOM3 0x00200000
77#define HHWIN_PROP_TAB_CUSTOM4 0x00400000
78#define HHWIN_PROP_TAB_CUSTOM5 0x00800000
79#define HHWIN_PROP_TAB_CUSTOM6 0x01000000
80#define HHWIN_PROP_TAB_CUSTOM7 0x02000000
81#define HHWIN_PROP_TAB_CUSTOM8 0x04000000
82#define HHWIN_PROP_TAB_CUSTOM9 0x08000000
83#define HHWIN_TB_MARGIN 0x10000000
84
85#define HHWIN_PARAM_PROPERTIES 0x00000002
86#define HHWIN_PARAM_STYLES 0x00000004
87#define HHWIN_PARAM_EXSTYLES 0x00000008
88#define HHWIN_PARAM_RECT 0x00000010
89#define HHWIN_PARAM_NAV_WIDTH 0x00000020
90#define HHWIN_PARAM_SHOWSTATE 0x00000040
91#define HHWIN_PARAM_INFOTYPES 0x00000080
92#define HHWIN_PARAM_TB_FLAGS 0x00000100
93#define HHWIN_PARAM_EXPANSION 0x00000200
94#define HHWIN_PARAM_TABPOS 0x00000400
95#define HHWIN_PARAM_TABORDER 0x00000800
96#define HHWIN_PARAM_HISTORY_COUNT 0x00001000
97#define HHWIN_PARAM_CUR_TAB 0x00002000
98
99#define HHWIN_BUTTON_EXPAND 0x00000002
100#define HHWIN_BUTTON_BACK 0x00000004
101#define HHWIN_BUTTON_FORWARD 0x00000008
102#define HHWIN_BUTTON_STOP 0x00000010
103#define HHWIN_BUTTON_REFRESH 0x00000020
104#define HHWIN_BUTTON_HOME 0x00000040
105#define HHWIN_BUTTON_BROWSE_FWD 0x00000080
106#define HHWIN_BUTTON_BROWSE_BCK 0x00000100
107#define HHWIN_BUTTON_NOTES 0x00000200
108#define HHWIN_BUTTON_CONTENTS 0x00000400
109#define HHWIN_BUTTON_SYNC 0x00000800
110#define HHWIN_BUTTON_OPTIONS 0x00001000
111#define HHWIN_BUTTON_PRINT 0x00002000
112#define HHWIN_BUTTON_INDEX 0x00004000
113#define HHWIN_BUTTON_SEARCH 0x00008000
114#define HHWIN_BUTTON_HISTORY 0x00010000
115#define HHWIN_BUTTON_FAVORITES 0x00020000
116#define HHWIN_BUTTON_JUMP1 0x00040000
117#define HHWIN_BUTTON_JUMP2 0x00080000
118#define HHWIN_BUTTON_ZOOM 0x00100000
119#define HHWIN_BUTTON_TOC_NEXT 0x00200000
120#define HHWIN_BUTTON_TOC_PREV 0x00400000
121
122#define HHWIN_DEF_BUTTONS \
123 (HHWIN_BUTTON_EXPAND | HHWIN_BUTTON_BACK | HHWIN_BUTTON_OPTIONS | HHWIN_BUTTON_PRINT)
124
125#define IDTB_EXPAND 200
126#define IDTB_CONTRACT 201
127#define IDTB_STOP 202
128#define IDTB_REFRESH 203
129#define IDTB_BACK 204
130#define IDTB_HOME 205
131#define IDTB_SYNC 206
132#define IDTB_PRINT 207
133#define IDTB_OPTIONS 208
134#define IDTB_FORWARD 209
135#define IDTB_NOTES 210
136#define IDTB_BROWSE_FWD 211
137#define IDTB_BROWSE_BACK 212
138#define IDTB_CONTENTS 213
139#define IDTB_INDEX 214
140#define IDTB_SEARCH 215
141#define IDTB_HISTORY 216
142#define IDTB_FAVORITES 217
143#define IDTB_JUMP1 218
144#define IDTB_JUMP2 219
145#define IDTB_CUSTOMIZE 221
146#define IDTB_ZOOM 222
147#define IDTB_TOC_NEXT 223
148#define IDTB_TOC_PREV 224
149
150#define HHN_FIRST (0U-860U)
151#define HHN_LAST (0U-879U)
152#define HHN_NAVCOMPLETE HHN_FIRST
153#define HHN_TRACK (HHN_FIRST-1)
154#define HHN_WINDOW_CREATE (HHN_FIRST-2)
155
156
157#ifdef __cplusplus
158extern "C" {
159#endif
160
161typedef struct tagHH_NOTIFY {
165
166typedef struct tagHH_POPUPA {
177
178typedef struct tagHH_POPUPW {
189
190DECL_WINELIB_TYPE_AW(HH_POPUP)
191
202
203typedef struct tagHH_ALINKW {
213
214DECL_WINELIB_TYPE_AW(HH_ALINK)
215
216enum {
225
226enum {
231
232typedef struct tagHH_ENUM_IT {
234 int iType;
239
240typedef struct tagHH_ENUM_CAT {
245
246typedef struct tagHH_SET_INFOTYPE {
251
253
254enum {
259
260#define HH_MAX_TABS 19
261
262enum {
272
273#define HH_MAX_TABS_CUSTOM (HH_TAB_CUSTOM_LAST-HH_TAB_CUSTOM_FIRST+1)
274#define HH_FTS_DEFAULT_PROXIMITY -1
275
276typedef struct tagHH_FTS_QUERYA {
286
287typedef struct tagHH_FTS_QUERYW {
297
298DECL_WINELIB_TYPE_AW(HH_FTS_QUERY)
299
328 BYTE tabOrder[HH_MAX_TABS+1];
338
339typedef struct tagHH_WINTYPEW {
377
378DECL_WINELIB_TYPE_AW(HH_WINTYPE)
379
380enum {
406
407typedef struct tagHH_NTRACKA {
413
414typedef struct tagHH_NTRACKW {
420
421DECL_WINELIB_TYPE_AW(HH_NTRACK)
422
425#define HtmlHelp WINELIB_NAME_AW(HtmlHelp)
426
427#define ATOM_HTMLHELP_API_ANSI (LPTSTR)14
428#define ATOM_HTMLHELP_API_UNICODE (LPTSTR)15
429
430typedef enum tagHH_GPROPID {
437
438#ifdef __oaidl_h__
439
440typedef struct tagHH_GLOBAL_PROPERTY
441{
443 VARIANT var;
444} HH_GLOBAL_PROPERTY ;
445
446#endif /* __oaidl_h__ */
447
448#ifdef __cplusplus
449}
450#endif
451
452#endif /* __HTMLHELP_H__ */
unsigned int BOOL
Definition: ntddk_ex.h:94
unsigned long DWORD
Definition: ntddk_ex.h:95
GLuint id
Definition: glext.h:5910
#define HH_MAX_TABS
Definition: htmlhelp.h:260
struct tagHH_ENUM_IT * PHH_ENUM_IT
DWORD * PHH_INFOTYPE
Definition: htmlhelp.h:252
struct tagHH_FTS_QUERYA HH_FTS_QUERYA
@ HH_TAB_CUSTOM_LAST
Definition: htmlhelp.h:270
@ HH_TAB_SEARCH
Definition: htmlhelp.h:265
@ HH_TAB_HISTORY
Definition: htmlhelp.h:267
@ HH_TAB_CONTENTS
Definition: htmlhelp.h:263
@ HH_TAB_CUSTOM_FIRST
Definition: htmlhelp.h:269
@ HH_TAB_INDEX
Definition: htmlhelp.h:264
@ HH_TAB_FAVORITES
Definition: htmlhelp.h:266
@ HH_TAB_AUTHOR
Definition: htmlhelp.h:268
HWND WINAPI HtmlHelpW(HWND, LPCWSTR, UINT, DWORD_PTR)
Definition: hhctrl.c:157
struct tagHH_WINTYPEA * PHH_WINTYPEA
struct tagHH_WINTYPEW HH_WINTYPEW
struct tagHH_NTRACKA HH_NTRACKA
struct tagHH_WINTYPEA HH_WINTYPEA
struct tagHH_POPUPA HH_POPUPA
struct tagHH_POPUPW HH_POPUPW
struct tagHH_ALINKA HH_ALINKA
struct tagHH_FTS_QUERYW HH_FTS_QUERYW
struct tagHH_SET_INFOTYPE HH_SET_INFOTYPE
struct tagHH_ENUM_CAT HH_ENUM_CAT
struct tagHH_WINTYPEW * PHH_WINTYPEW
@ HHWIN_NAVTYPE_TOC
Definition: htmlhelp.h:217
@ HHWIN_NAVTYPE_INDEX
Definition: htmlhelp.h:218
@ HHWIN_NAVTYPE_FAVORITES
Definition: htmlhelp.h:220
@ HHWIN_NAVTYPE_AUTHOR
Definition: htmlhelp.h:222
@ HHWIN_NAVTYPE_SEARCH
Definition: htmlhelp.h:219
@ HHWIN_NAVTYPE_CUSTOM_FIRST
Definition: htmlhelp.h:223
@ HHWIN_NAVTYPE_HISTORY
Definition: htmlhelp.h:221
struct tagHH_ALINKW HH_ALINKW
@ HHWIN_NAVTAB_LEFT
Definition: htmlhelp.h:256
@ HHWIN_NAVTAB_BOTTOM
Definition: htmlhelp.h:257
@ HHWIN_NAVTAB_TOP
Definition: htmlhelp.h:255
DWORD HH_INFOTYPE
Definition: htmlhelp.h:252
enum tagHH_GPROPID HH_GPROPID
HWND WINAPI HtmlHelpA(HWND, LPCSTR, UINT, DWORD_PTR)
Definition: hhctrl.c:421
struct tagHH_NTRACKW HH_NTRACKW
tagHH_GPROPID
Definition: htmlhelp.h:430
@ HH_GPROPID_UI_LANGUAGE
Definition: htmlhelp.h:433
@ HH_GPROPID_TOOLBAR_MARGIN
Definition: htmlhelp.h:432
@ HH_GPROPID_SINGLETHREAD
Definition: htmlhelp.h:431
@ HH_GPROPID_CURRENT_SUBSET
Definition: htmlhelp.h:434
@ HH_GPROPID_CONTENT_LANGUAGE
Definition: htmlhelp.h:435
struct tagHH_ENUM_IT HH_ENUM_IT
struct tagHH_NOTIFY HH_NOTIFY
@ HHACT_CUSTOMIZE
Definition: htmlhelp.h:397
@ HHACT_JUMP1
Definition: htmlhelp.h:398
@ HHACT_REFRESH
Definition: htmlhelp.h:391
@ HHACT_PRINT
Definition: htmlhelp.h:395
@ HHACT_TAB_CONTENTS
Definition: htmlhelp.h:381
@ HHACT_TOC_PREV
Definition: htmlhelp.h:402
@ HHACT_TAB_FAVORITES
Definition: htmlhelp.h:385
@ HHACT_TOC_NEXT
Definition: htmlhelp.h:401
@ HHACT_NOTES
Definition: htmlhelp.h:403
@ HHACT_LAST_ENUM
Definition: htmlhelp.h:404
@ HHACT_TAB_HISTORY
Definition: htmlhelp.h:384
@ HHACT_JUMP2
Definition: htmlhelp.h:399
@ HHACT_OPTIONS
Definition: htmlhelp.h:394
@ HHACT_CONTRACT
Definition: htmlhelp.h:387
@ HHACT_ZOOM
Definition: htmlhelp.h:400
@ HHACT_TAB_INDEX
Definition: htmlhelp.h:382
@ HHACT_FORWARD
Definition: htmlhelp.h:389
@ HHACT_STOP
Definition: htmlhelp.h:390
@ HHACT_EXPAND
Definition: htmlhelp.h:386
@ HHACT_TAB_SEARCH
Definition: htmlhelp.h:383
@ HHACT_SYNC
Definition: htmlhelp.h:393
@ HHACT_BACK
Definition: htmlhelp.h:388
@ HHACT_HOME
Definition: htmlhelp.h:392
@ HHACT_HIGHLIGHT
Definition: htmlhelp.h:396
struct tagHH_ENUM_CAT * PHH_ENUM_CAT
@ IT_HIDDEN
Definition: htmlhelp.h:229
@ IT_EXCLUSIVE
Definition: htmlhelp.h:228
@ IT_INCLUSIVE
Definition: htmlhelp.h:227
const char * var
Definition: shader.c:5666
unsigned int UINT
Definition: ndis.h:50
long LONG
Definition: pedump.c:60
LPCSTR pszMsgText
Definition: htmlhelp.h:197
LPCSTR pszUrl
Definition: htmlhelp.h:196
LPCSTR pszKeywords
Definition: htmlhelp.h:195
BOOL fReserved
Definition: htmlhelp.h:194
BOOL fIndexOnFail
Definition: htmlhelp.h:200
int cbStruct
Definition: htmlhelp.h:193
LPCSTR pszWindow
Definition: htmlhelp.h:199
LPCSTR pszMsgTitle
Definition: htmlhelp.h:198
LPCWSTR pszUrl
Definition: htmlhelp.h:207
int cbStruct
Definition: htmlhelp.h:204
LPCWSTR pszKeywords
Definition: htmlhelp.h:206
BOOL fIndexOnFail
Definition: htmlhelp.h:211
LPCWSTR pszWindow
Definition: htmlhelp.h:210
LPCWSTR pszMsgText
Definition: htmlhelp.h:208
LPCWSTR pszMsgTitle
Definition: htmlhelp.h:209
BOOL fReserved
Definition: htmlhelp.h:205
LPCSTR pszCatDescription
Definition: htmlhelp.h:243
LPCSTR pszCatName
Definition: htmlhelp.h:242
LPCSTR pszITName
Definition: htmlhelp.h:236
LPCSTR pszCatName
Definition: htmlhelp.h:235
LPCSTR pszITDescription
Definition: htmlhelp.h:237
BOOL fUniCodeStrings
Definition: htmlhelp.h:278
LPCSTR pszWindow
Definition: htmlhelp.h:284
BOOL fStemmedSearch
Definition: htmlhelp.h:281
LPCSTR pszSearchQuery
Definition: htmlhelp.h:279
LPCWSTR pszWindow
Definition: htmlhelp.h:295
BOOL fStemmedSearch
Definition: htmlhelp.h:292
BOOL fUniCodeStrings
Definition: htmlhelp.h:289
LPCWSTR pszSearchQuery
Definition: htmlhelp.h:290
NMHDR hdr
Definition: htmlhelp.h:162
PCSTR pszurl
Definition: htmlhelp.h:163
PHH_WINTYPEA phhWinType
Definition: htmlhelp.h:411
PCSTR pszCurUrl
Definition: htmlhelp.h:409
PHH_WINTYPEW phhWinType
Definition: htmlhelp.h:418
PCSTR pszCurUrl
Definition: htmlhelp.h:416
RECT rcMargins
Definition: htmlhelp.h:174
UINT idString
Definition: htmlhelp.h:169
LPCSTR pszFont
Definition: htmlhelp.h:175
LPCSTR pszText
Definition: htmlhelp.h:170
COLORREF clrForeground
Definition: htmlhelp.h:172
COLORREF clrBackground
Definition: htmlhelp.h:173
int cbStruct
Definition: htmlhelp.h:167
HINSTANCE hinst
Definition: htmlhelp.h:168
POINT pt
Definition: htmlhelp.h:171
HINSTANCE hinst
Definition: htmlhelp.h:180
int cbStruct
Definition: htmlhelp.h:179
RECT rcMargins
Definition: htmlhelp.h:186
LPCWSTR pszFont
Definition: htmlhelp.h:187
COLORREF clrBackground
Definition: htmlhelp.h:185
POINT pt
Definition: htmlhelp.h:183
COLORREF clrForeground
Definition: htmlhelp.h:184
UINT idString
Definition: htmlhelp.h:181
LPCWSTR pszText
Definition: htmlhelp.h:182
LPCSTR pszInfoTypeName
Definition: htmlhelp.h:249
DWORD fsToolBarFlags
Definition: htmlhelp.h:323
RECT rcWindowPos
Definition: htmlhelp.h:309
LPCSTR pszToc
Definition: htmlhelp.h:319
DWORD fsWinProperties
Definition: htmlhelp.h:305
DWORD dwExStyles
Definition: htmlhelp.h:308
LPCSTR pszJump1
Definition: htmlhelp.h:330
LPCSTR pszIndex
Definition: htmlhelp.h:320
LPCSTR pszHome
Definition: htmlhelp.h:322
LPCSTR pszFile
Definition: htmlhelp.h:321
LPCSTR pszJump2
Definition: htmlhelp.h:331
DWORD dwStyles
Definition: htmlhelp.h:307
LPCSTR pszType
Definition: htmlhelp.h:303
LPCSTR pszCaption
Definition: htmlhelp.h:306
BOOL fUniCodeStrings
Definition: htmlhelp.h:302
HWND hwndCaller
Definition: htmlhelp.h:312
DWORD fsValidMembers
Definition: htmlhelp.h:304
LPCSTR pszCustomTabs
Definition: htmlhelp.h:336
LPCSTR pszUrlJump2
Definition: htmlhelp.h:333
PHH_INFOTYPE paInfoTypes
Definition: htmlhelp.h:313
HWND hwndNavigation
Definition: htmlhelp.h:315
RECT rcMinSize
Definition: htmlhelp.h:334
BOOL fNotExpanded
Definition: htmlhelp.h:324
HWND hwndToolBar
Definition: htmlhelp.h:314
LPCSTR pszUrlJump1
Definition: htmlhelp.h:332
LPCWSTR pszIndex
Definition: htmlhelp.h:359
BYTE tabOrder[HH_MAX_TABS+1]
Definition: htmlhelp.h:367
LPCWSTR pszJump1
Definition: htmlhelp.h:369
LPCWSTR pszHome
Definition: htmlhelp.h:361
DWORD dwStyles
Definition: htmlhelp.h:346
RECT rcWindowPos
Definition: htmlhelp.h:348
HWND hwndNavigation
Definition: htmlhelp.h:354
DWORD dwExStyles
Definition: htmlhelp.h:347
HWND hwndToolBar
Definition: htmlhelp.h:353
PHH_INFOTYPE paInfoTypes
Definition: htmlhelp.h:352
LPCWSTR pszToc
Definition: htmlhelp.h:358
DWORD fsToolBarFlags
Definition: htmlhelp.h:362
LPCWSTR pszJump2
Definition: htmlhelp.h:370
DWORD fsValidMembers
Definition: htmlhelp.h:343
LPCWSTR pszType
Definition: htmlhelp.h:342
LPCWSTR pszUrlJump2
Definition: htmlhelp.h:372
LPCWSTR pszFile
Definition: htmlhelp.h:360
LPCWSTR pszCaption
Definition: htmlhelp.h:345
DWORD fsWinProperties
Definition: htmlhelp.h:344
BOOL fUniCodeStrings
Definition: htmlhelp.h:341
BOOL fNotExpanded
Definition: htmlhelp.h:363
LPCWSTR pszUrlJump1
Definition: htmlhelp.h:371
HWND hwndCaller
Definition: htmlhelp.h:351
RECT rcMinSize
Definition: htmlhelp.h:373
LPCWSTR pszCustomTabs
Definition: htmlhelp.h:375
uint32_t DWORD_PTR
Definition: typedefs.h:65
const char * PCSTR
Definition: typedefs.h:52
#define DECL_WINELIB_TYPE_AW(type)
Definition: windef.h:401
DWORD COLORREF
Definition: windef.h:300
#define WINAPI
Definition: msvc.h:6
const char * LPCSTR
Definition: xmlstorage.h:183
const WCHAR * LPCWSTR
Definition: xmlstorage.h:185
unsigned char BYTE
Definition: xxhash.c:193