VirtualBox

source: vbox/trunk/src/VBox/Additions/WINNT/Graphics/Wine/include/htmlhelp.h@ 33282

Last change on this file since 33282 was 16477, checked in by vboxsync, 16 years ago

LGPL disclaimer by filemuncher
  • Property svn:eol-style set to native
File size: 12.8 KB
Line 
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/*
20 * Sun LGPL Disclaimer: For the avoidance of doubt, except that if any license choice
21 * other than GPL or LGPL is available it will apply instead, Sun elects to use only
22 * the Lesser General Public License version 2.1 (LGPLv2) at this time for any software where
23 * a choice of LGPL license versions is made available with the language indicating
24 * that LGPLv2 or any later version may be used, or where a choice of which version
25 * of the LGPL is applied is otherwise unspecified.
26 */
27
28#ifndef __HTMLHELP_H__
29#define __HTMLHELP_H__
30
31#define HH_DISPLAY_TOPIC 0x00
32#define HH_HELP_FINDER 0x00
33#define HH_DISPLAY_TOC 0x01
34#define HH_DISPLAY_INDEX 0x02
35#define HH_DISPLAY_SEARCH 0x03
36#define HH_SET_WIN_TYPE 0x04
37#define HH_GET_WIN_TYPE 0x05
38#define HH_GET_WIN_HANDLE 0x06
39#define HH_ENUM_INFO_TYPE 0x07
40#define HH_SET_INFO_TYPE 0x08
41#define HH_SYNC 0x09
42#define HH_RESERVED1 0x0A
43#define HH_RESERVED2 0x0B
44#define HH_RESERVED3 0x0C
45#define HH_KEYWORD_LOOKUP 0x0D
46#define HH_DISPLAY_TEXT_POPUP 0x0E
47#define HH_HELP_CONTEXT 0x0F
48#define HH_TP_HELP_CONTEXTMENU 0x10
49#define HH_TP_HELP_WM_HELP 0x11
50#define HH_CLOSE_ALL 0x12
51#define HH_ALINK_LOOKUP 0x13
52#define HH_GET_LAST_ERROR 0x14
53#define HH_ENUM_CATEGORY 0x15
54#define HH_ENUM_CATEGORY_IT 0x16
55#define HH_RESET_IT_FILTER 0x17
56#define HH_SET_INCLUSIVE_FILTER 0x18
57#define HH_SET_EXCLUSIVE_FILTER 0x19
58#define HH_INITIALIZE 0x1C
59#define HH_UNINITIALIZE 0x1D
60#define HH_SAFE_DISPLAY_TOPIC 0x20
61#define HH_PRETRANSLATEMESSAGE 0xFD
62#define HH_SET_GLOBAL_PROPERTY 0xFC
63
64#define HHWIN_PROP_TAB_AUTOHIDESHOW 0x00000001
65#define HHWIN_PROP_ONTOP 0x00000002
66#define HHWIN_PROP_NOTITLEBAR 0x00000004
67#define HHWIN_PROP_NODEF_STYLES 0x00000008
68#define HHWIN_PROP_NODEF_EXSTYLES 0x00000010
69#define HHWIN_PROP_TRI_PANE 0x00000020
70#define HHWIN_PROP_NOTB_TEXT 0x00000040
71#define HHWIN_PROP_POST_QUIT 0x00000080
72#define HHWIN_PROP_AUTO_SYNC 0x00000100
73#define HHWIN_PROP_TRACKING 0x00000200
74#define HHWIN_PROP_TAB_SEARCH 0x00000400
75#define HHWIN_PROP_TAB_HISTORY 0x00000800
76#define HHWIN_PROP_TAB_FAVORITES 0x00001000
77#define HHWIN_PROP_CHANGE_TITLE 0x00002000
78#define HHWIN_PROP_NAV_ONLY_WIN 0x00004000
79#define HHWIN_PROP_NO_TOOLBAR 0x00008000
80#define HHWIN_PROP_MENU 0x00010000
81#define HHWIN_PROP_TAB_ADVSEARCH 0x00020000
82#define HHWIN_PROP_USER_POS 0x00040000
83#define HHWIN_PROP_TAB_CUSTOM1 0x00080000
84#define HHWIN_PROP_TAB_CUSTOM2 0x00100000
85#define HHWIN_PROP_TAB_CUSTOM3 0x00200000
86#define HHWIN_PROP_TAB_CUSTOM4 0x00400000
87#define HHWIN_PROP_TAB_CUSTOM5 0x00800000
88#define HHWIN_PROP_TAB_CUSTOM6 0x01000000
89#define HHWIN_PROP_TAB_CUSTOM7 0x02000000
90#define HHWIN_PROP_TAB_CUSTOM8 0x04000000
91#define HHWIN_PROP_TAB_CUSTOM9 0x08000000
92#define HHWIN_TB_MARGIN 0x10000000
93
94#define HHWIN_PARAM_PROPERTIES 0x00000002
95#define HHWIN_PARAM_STYLES 0x00000004
96#define HHWIN_PARAM_EXSTYLES 0x00000008
97#define HHWIN_PARAM_RECT 0x00000010
98#define HHWIN_PARAM_NAV_WIDTH 0x00000020
99#define HHWIN_PARAM_SHOWSTATE 0x00000040
100#define HHWIN_PARAM_INFOTYPES 0x00000080
101#define HHWIN_PARAM_TB_FLAGS 0x00000100
102#define HHWIN_PARAM_EXPANSION 0x00000200
103#define HHWIN_PARAM_TABPOS 0x00000400
104#define HHWIN_PARAM_TABORDER 0x00000800
105#define HHWIN_PARAM_HISTORY_COUNT 0x00001000
106#define HHWIN_PARAM_CUR_TAB 0x00002000
107
108#define HHWIN_BUTTON_EXPAND 0x00000002
109#define HHWIN_BUTTON_BACK 0x00000004
110#define HHWIN_BUTTON_FORWARD 0x00000008
111#define HHWIN_BUTTON_STOP 0x00000010
112#define HHWIN_BUTTON_REFRESH 0x00000020
113#define HHWIN_BUTTON_HOME 0x00000040
114#define HHWIN_BUTTON_BROWSE_FWD 0x00000080
115#define HHWIN_BUTTON_BROWSE_BCK 0x00000100
116#define HHWIN_BUTTON_NOTES 0x00000200
117#define HHWIN_BUTTON_CONTENTS 0x00000400
118#define HHWIN_BUTTON_SYNC 0x00000800
119#define HHWIN_BUTTON_OPTIONS 0x00001000
120#define HHWIN_BUTTON_PRINT 0x00002000
121#define HHWIN_BUTTON_INDEX 0x00004000
122#define HHWIN_BUTTON_SEARCH 0x00008000
123#define HHWIN_BUTTON_HISTORY 0x00010000
124#define HHWIN_BUTTON_FAVORITES 0x00020000
125#define HHWIN_BUTTON_JUMP1 0x00040000
126#define HHWIN_BUTTON_JUMP2 0x00080000
127#define HHWIN_BUTTON_ZOOM 0x00100000
128#define HHWIN_BUTTON_TOC_NEXT 0x00200000
129#define HHWIN_BUTTON_TOC_PREV 0x00400000
130
131#define HHWIN_DEF_BUTTONS \
132 (HHWIN_BUTTON_EXPAND | HHWIN_BUTTON_BACK | HHWIN_BUTTON_OPTIONS | HHWIN_BUTTON_PRINT)
133
134#define IDTB_EXPAND 200
135#define IDTB_CONTRACT 201
136#define IDTB_STOP 202
137#define IDTB_REFRESH 203
138#define IDTB_BACK 204
139#define IDTB_HOME 205
140#define IDTB_SYNC 206
141#define IDTB_PRINT 207
142#define IDTB_OPTIONS 208
143#define IDTB_FORWARD 209
144#define IDTB_NOTES 210
145#define IDTB_BROWSE_FWD 211
146#define IDTB_BROWSE_BACK 212
147#define IDTB_CONTENTS 213
148#define IDTB_INDEX 214
149#define IDTB_SEARCH 215
150#define IDTB_HISTORY 216
151#define IDTB_FAVORITES 217
152#define IDTB_JUMP1 218
153#define IDTB_JUMP2 219
154#define IDTB_CUSTOMIZE 221
155#define IDTB_ZOOM 222
156#define IDTB_TOC_NEXT 223
157#define IDTB_TOC_PREV 224
158
159#define HHN_FIRST (0U-860U)
160#define HHN_LAST (0U-879U)
161#define HHN_NAVCOMPLETE HHN_FIRST
162#define HHN_TRACK (HHN_FIRST-1)
163#define HHN_WINDOW_CREATE (HHN_FIRST-2)
164
165
166#ifdef __cplusplus
167extern "C" {
168#endif
169
170typedef struct tagHH_NOTIFY {
171 NMHDR hdr;
172 PCSTR pszurl;
173} HH_NOTIFY;
174
175typedef struct tagHH_POPUPA {
176 int cbStruct;
177 HINSTANCE hinst;
178 UINT idString;
179 LPCSTR pszText;
180 POINT pt;
181 COLORREF clrForeground;
182 COLORREF clrBackground;
183 RECT rcMargins;
184 LPCSTR pszFont;
185} HH_POPUPA;
186
187typedef struct tagHH_POPUPW {
188 int cbStruct;
189 HINSTANCE hinst;
190 UINT idString;
191 LPCWSTR pszText;
192 POINT pt;
193 COLORREF clrForeground;
194 COLORREF clrBackground;
195 RECT rcMargins;
196 LPCWSTR pszFont;
197} HH_POPUPW;
198
199DECL_WINELIB_TYPE_AW(HH_POPUP)
200
201typedef struct tagHH_ALINKA {
202 int cbStruct;
203 BOOL fReserved;
204 LPCSTR pszKeywords;
205 LPCSTR pszUrl;
206 LPCSTR pszMsgText;
207 LPCSTR pszMsgTitle;
208 LPCSTR pszWindow;
209 BOOL fIndexOnFail;
210} HH_ALINKA;
211
212typedef struct tagHH_ALINKW {
213 int cbStruct;
214 BOOL fReserved;
215 LPCWSTR pszKeywords;
216 LPCWSTR pszUrl;
217 LPCWSTR pszMsgText;
218 LPCWSTR pszMsgTitle;
219 LPCWSTR pszWindow;
220 BOOL fIndexOnFail;
221} HH_ALINKW;
222
223DECL_WINELIB_TYPE_AW(HH_ALINK)
224
225enum {
226 HHWIN_NAVTYPE_TOC,
227 HHWIN_NAVTYPE_INDEX,
228 HHWIN_NAVTYPE_SEARCH,
229 HHWIN_NAVTYPE_FAVORITES,
230 HHWIN_NAVTYPE_HISTORY,
231 HHWIN_NAVTYPE_AUTHOR,
232 HHWIN_NAVTYPE_CUSTOM_FIRST = 11
233};
234
235enum {
236 IT_INCLUSIVE,
237 IT_EXCLUSIVE,
238 IT_HIDDEN
239};
240
241typedef struct tagHH_ENUM_IT {
242 int cbStruct;
243 int iType;
244 LPCSTR pszCatName;
245 LPCSTR pszITName;
246 LPCSTR pszITDescription;
247} HH_ENUM_IT, *PHH_ENUM_IT;
248
249typedef struct tagHH_ENUM_CAT {
250 int cbStruct;
251 LPCSTR pszCatName;
252 LPCSTR pszCatDescription;
253} HH_ENUM_CAT, *PHH_ENUM_CAT;
254
255typedef struct tagHH_SET_INFOTYPE {
256 int cbStruct;
257 LPCSTR pszCatName;
258 LPCSTR pszInfoTypeName;
259} HH_SET_INFOTYPE;
260
261typedef DWORD HH_INFOTYPE, *PHH_INFOTYPE;
262
263enum {
264 HHWIN_NAVTAB_TOP,
265 HHWIN_NAVTAB_LEFT,
266 HHWIN_NAVTAB_BOTTOM
267};
268
269#define HH_MAX_TABS 19
270
271enum {
272 HH_TAB_CONTENTS,
273 HH_TAB_INDEX,
274 HH_TAB_SEARCH,
275 HH_TAB_FAVORITES,
276 HH_TAB_HISTORY,
277 HH_TAB_AUTHOR,
278 HH_TAB_CUSTOM_FIRST = 11,
279 HH_TAB_CUSTOM_LAST = HH_MAX_TABS
280};
281
282#define HH_MAX_TABS_CUSTOM (HH_TAB_CUSTOM_LAST-HH_TAB_CUSTOM_FIRST+1)
283#define HH_FTS_DEFAULT_PROXIMITY -1
284
285typedef struct tagHH_FTS_QUERYA {
286 int cbStruct;
287 BOOL fUniCodeStrings;
288 LPCSTR pszSearchQuery;
289 LONG iProximity;
290 BOOL fStemmedSearch;
291 BOOL fTitleOnly;
292 BOOL fExecute;
293 LPCSTR pszWindow;
294} HH_FTS_QUERYA;
295
296typedef struct tagHH_FTS_QUERYW {
297 int cbStruct;
298 BOOL fUniCodeStrings;
299 LPCWSTR pszSearchQuery;
300 LONG iProximity;
301 BOOL fStemmedSearch;
302 BOOL fTitleOnly;
303 BOOL fExecute;
304 LPCWSTR pszWindow;
305} HH_FTS_QUERYW;
306
307DECL_WINELIB_TYPE_AW(HH_FTS_QUERY)
308
309typedef struct tagHH_WINTYPEA {
310 int cbStruct;
311 BOOL fUniCodeStrings;
312 LPCSTR pszType;
313 DWORD fsValidMembers;
314 DWORD fsWinProperties;
315 LPCSTR pszCaption;
316 DWORD dwStyles;
317 DWORD dwExStyles;
318 RECT rcWindowPos;
319 int nShowState;
320 HWND hwndHelp;
321 HWND hwndCaller;
322 PHH_INFOTYPE paInfoTypes;
323 HWND hwndToolBar;
324 HWND hwndNavigation;
325 HWND hwndHTML;
326 int iNavWidth;
327 RECT rcHTML;
328 LPCSTR pszToc;
329 LPCSTR pszIndex;
330 LPCSTR pszFile;
331 LPCSTR pszHome;
332 DWORD fsToolBarFlags;
333 BOOL fNotExpanded;
334 int curNavType;
335 int tabpos;
336 int idNotify;
337 BYTE tabOrder[HH_MAX_TABS+1];
338 int cHistory;
339 LPCSTR pszJump1;
340 LPCSTR pszJump2;
341 LPCSTR pszUrlJump1;
342 LPCSTR pszUrlJump2;
343 RECT rcMinSize;
344 int cbInfoTypes;
345 LPCSTR pszCustomTabs;
346} HH_WINTYPEA, *PHH_WINTYPEA;
347
348typedef struct tagHH_WINTYPEW {
349 int cbStruct;
350 BOOL fUniCodeStrings;
351 LPCWSTR pszType;
352 DWORD fsValidMembers;
353 DWORD fsWinProperties;
354 LPCWSTR pszCaption;
355 DWORD dwStyles;
356 DWORD dwExStyles;
357 RECT rcWindowPos;
358 int nShowState;
359 HWND hwndHelp;
360 HWND hwndCaller;
361 PHH_INFOTYPE paInfoTypes;
362 HWND hwndToolBar;
363 HWND hwndNavigation;
364 HWND hwndHTML;
365 int iNavWidth;
366 RECT rcHTML;
367 LPCWSTR pszToc;
368 LPCWSTR pszIndex;
369 LPCWSTR pszFile;
370 LPCWSTR pszHome;
371 DWORD fsToolBarFlags;
372 BOOL fNotExpanded;
373 int curNavType;
374 int tabpos;
375 int idNotify;
376 BYTE tabOrder[HH_MAX_TABS+1];
377 int cHistory;
378 LPCWSTR pszJump1;
379 LPCWSTR pszJump2;
380 LPCWSTR pszUrlJump1;
381 LPCWSTR pszUrlJump2;
382 RECT rcMinSize;
383 int cbInfoTypes;
384 LPCWSTR pszCustomTabs;
385} HH_WINTYPEW, *PHH_WINTYPEW;
386
387DECL_WINELIB_TYPE_AW(HH_WINTYPE)
388
389enum {
390 HHACT_TAB_CONTENTS,
391 HHACT_TAB_INDEX,
392 HHACT_TAB_SEARCH,
393 HHACT_TAB_HISTORY,
394 HHACT_TAB_FAVORITES,
395 HHACT_EXPAND,
396 HHACT_CONTRACT,
397 HHACT_BACK,
398 HHACT_FORWARD,
399 HHACT_STOP,
400 HHACT_REFRESH,
401 HHACT_HOME,
402 HHACT_SYNC,
403 HHACT_OPTIONS,
404 HHACT_PRINT,
405 HHACT_HIGHLIGHT,
406 HHACT_CUSTOMIZE,
407 HHACT_JUMP1,
408 HHACT_JUMP2,
409 HHACT_ZOOM,
410 HHACT_TOC_NEXT,
411 HHACT_TOC_PREV,
412 HHACT_NOTES,
413 HHACT_LAST_ENUM
414};
415
416typedef struct tagHH_NTRACKA {
417 NMHDR hdr;
418 PCSTR pszCurUrl;
419 int idAction;
420 PHH_WINTYPEA phhWinType;
421} HH_NTRACKA;
422
423typedef struct tagHH_NTRACKW {
424 NMHDR hdr;
425 PCSTR pszCurUrl;
426 int idAction;
427 PHH_WINTYPEW phhWinType;
428} HH_NTRACKW;
429
430DECL_WINELIB_TYPE_AW(HH_NTRACK)
431
432HWND WINAPI HtmlHelpA(HWND,LPCSTR,UINT,DWORD_PTR);
433HWND WINAPI HtmlHelpW(HWND,LPCWSTR,UINT,DWORD_PTR);
434#define HtmlHelp WINELIB_NAME_AW(HtmlHelp)
435
436#define ATOM_HTMLHELP_API_ANSI (LPTSTR)14
437#define ATOM_HTMLHELP_API_UNICODE (LPTSTR)15
438
439typedef enum tagHH_GPROPID {
440 HH_GPROPID_SINGLETHREAD = 1,
441 HH_GPROPID_TOOLBAR_MARGIN = 2,
442 HH_GPROPID_UI_LANGUAGE = 3,
443 HH_GPROPID_CURRENT_SUBSET = 4,
444 HH_GPROPID_CONTENT_LANGUAGE = 5
445} HH_GPROPID;
446
447#ifdef __WIDL_OAIDL_H
448
449typedef struct tagHH_GLOBAL_PROPERTY
450{
451 HH_GPROPID id;
452 VARIANT var;
453} HH_GLOBAL_PROPERTY ;
454
455#endif /* __WIDL_OAIDL_H */
456
457#ifdef __cplusplus
458}
459#endif
460
461#endif /* __HTMLHELP_H__ */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette