source: git/kernel/htmlhelp.h @ fbc7cb

jengelh-datetimespielwiese
Last change on this file since fbc7cb was 5e50b2, checked in by Oliver Wienand <wienand@…>, 15 years ago
htmlhelp.h von wine angepasst git-svn-id: file:///usr/local/Singular/svn/trunk@10749 2c84dea3-7e68-4137-9b89-c4e89433aadc
  • Property mode set to 100644
File size: 12.1 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#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 {
162    NMHDR hdr;
163    PCSTR pszurl;
164} HH_NOTIFY;
165
166typedef struct tagHH_POPUPA {
167    int       cbStruct;
168    HINSTANCE hinst;
169    UINT      idString;
170    LPCSTR    pszText;
171    POINT     pt;
172    COLORREF  clrForeground;
173    COLORREF  clrBackground;
174    RECT      rcMargins;
175    LPCSTR    pszFont;
176} HH_POPUPA;
177
178typedef struct tagHH_POPUPW {
179    int       cbStruct;
180    HINSTANCE hinst;
181    UINT      idString;
182    LPCWSTR   pszText;
183    POINT     pt;
184    COLORREF  clrForeground;
185    COLORREF  clrBackground;
186    RECT      rcMargins;
187    LPCWSTR   pszFont;
188} HH_POPUPW;
189
190typedef struct tagHH_ALINKA {
191    int    cbStruct;
192    BOOL   fReserved;
193    LPCSTR pszKeywords;
194    LPCSTR pszUrl;
195    LPCSTR pszMsgText;
196    LPCSTR pszMsgTitle;
197    LPCSTR pszWindow;
198    BOOL   fIndexOnFail;
199} HH_ALINKA;
200
201typedef struct tagHH_ALINKW {
202    int     cbStruct;
203    BOOL    fReserved;
204    LPCWSTR pszKeywords;
205    LPCWSTR pszUrl;
206    LPCWSTR pszMsgText;
207    LPCWSTR pszMsgTitle;
208    LPCWSTR pszWindow;
209    BOOL    fIndexOnFail;
210} HH_ALINKW;
211
212enum {
213    HHWIN_NAVTYPE_TOC,
214    HHWIN_NAVTYPE_INDEX,
215    HHWIN_NAVTYPE_SEARCH,
216    HHWIN_NAVTYPE_FAVORITES,
217    HHWIN_NAVTYPE_HISTORY,
218    HHWIN_NAVTYPE_AUTHOR,
219    HHWIN_NAVTYPE_CUSTOM_FIRST = 11
220};
221
222enum {
223    IT_INCLUSIVE,
224    IT_EXCLUSIVE,
225    IT_HIDDEN
226};
227
228typedef struct tagHH_ENUM_IT {
229    int    cbStruct;
230    int    iType;
231    LPCSTR pszCatName;
232    LPCSTR pszITName;
233    LPCSTR pszITDescription;
234} HH_ENUM_IT, *PHH_ENUM_IT;
235
236typedef struct tagHH_ENUM_CAT {
237    int    cbStruct;
238    LPCSTR pszCatName;
239    LPCSTR pszCatDescription;
240} HH_ENUM_CAT, *PHH_ENUM_CAT;
241
242typedef struct tagHH_SET_INFOTYPE {
243    int    cbStruct;
244    LPCSTR pszCatName;
245    LPCSTR pszInfoTypeName;
246} HH_SET_INFOTYPE;
247
248typedef DWORD HH_INFOTYPE, *PHH_INFOTYPE;
249
250enum {
251    HHWIN_NAVTAB_TOP,
252    HHWIN_NAVTAB_LEFT,
253    HHWIN_NAVTAB_BOTTOM
254};
255
256#define HH_MAX_TABS 19
257
258enum {
259    HH_TAB_CONTENTS,
260    HH_TAB_INDEX,
261    HH_TAB_SEARCH,
262    HH_TAB_FAVORITES,
263    HH_TAB_HISTORY,
264    HH_TAB_AUTHOR,
265    HH_TAB_CUSTOM_FIRST = 11,
266    HH_TAB_CUSTOM_LAST = HH_MAX_TABS
267};
268
269#define HH_MAX_TABS_CUSTOM        (HH_TAB_CUSTOM_LAST-HH_TAB_CUSTOM_FIRST+1)
270#define HH_FTS_DEFAULT_PROXIMITY  -1
271
272typedef struct tagHH_FTS_QUERYA {
273    int    cbStruct;
274    BOOL   fUniCodeStrings;
275    LPCSTR pszSearchQuery;
276    LONG   iProximity;
277    BOOL   fStemmedSearch;
278    BOOL   fTitleOnly;
279    BOOL   fExecute;
280    LPCSTR pszWindow;
281} HH_FTS_QUERYA;
282
283typedef struct tagHH_FTS_QUERYW {
284    int     cbStruct;
285    BOOL    fUniCodeStrings;
286    LPCWSTR pszSearchQuery;
287    LONG    iProximity;
288    BOOL    fStemmedSearch;
289    BOOL    fTitleOnly;
290    BOOL    fExecute;
291    LPCWSTR pszWindow;
292} HH_FTS_QUERYW;
293
294
295typedef struct tagHH_WINTYPEA {
296    int          cbStruct;
297    BOOL         fUniCodeStrings;
298    LPCSTR       pszType;
299    DWORD        fsValidMembers;
300    DWORD        fsWinProperties;
301    LPCSTR       pszCaption;
302    DWORD        dwStyles;
303    DWORD        dwExStyles;
304    RECT         rcWindowPos;
305    int          nShowState;
306    HWND         hwndHelp;
307    HWND         hwndCaller;
308    PHH_INFOTYPE paInfoTypes;
309    HWND         hwndToolBar;
310    HWND         hwndNavigation;
311    HWND         hwndHTML;
312    int          iNavWidth;
313    RECT         rcHTML;
314    LPCSTR       pszToc;
315    LPCSTR       pszIndex;
316    LPCSTR       pszFile;
317    LPCSTR       pszHome;
318    DWORD        fsToolBarFlags;
319    BOOL         fNotExpanded;
320    int          curNavType;
321    int          tabpos;
322    int          idNotify;
323    BYTE         tabOrder[HH_MAX_TABS+1];
324    int          cHistory;
325    LPCSTR       pszJump1;
326    LPCSTR       pszJump2;
327    LPCSTR       pszUrlJump1;
328    LPCSTR       pszUrlJump2;
329    RECT         rcMinSize;
330    int          cbInfoTypes;
331    LPCSTR       pszCustomTabs;
332} HH_WINTYPEA, *PHH_WINTYPEA;
333
334typedef struct tagHH_WINTYPEW {
335    int          cbStruct;
336    BOOL         fUniCodeStrings;
337    LPCWSTR      pszType;
338    DWORD        fsValidMembers;
339    DWORD        fsWinProperties;
340    LPCWSTR      pszCaption;
341    DWORD        dwStyles;
342    DWORD        dwExStyles;
343    RECT         rcWindowPos;
344    int          nShowState;
345    HWND         hwndHelp;
346    HWND         hwndCaller;
347    PHH_INFOTYPE paInfoTypes;
348    HWND         hwndToolBar;
349    HWND         hwndNavigation;
350    HWND         hwndHTML;
351    int          iNavWidth;
352    RECT         rcHTML;
353    LPCWSTR      pszToc;
354    LPCWSTR      pszIndex;
355    LPCWSTR      pszFile;
356    LPCWSTR      pszHome;
357    DWORD        fsToolBarFlags;
358    BOOL         fNotExpanded;
359    int          curNavType;
360    int          tabpos;
361    int          idNotify;
362    BYTE         tabOrder[HH_MAX_TABS+1];
363    int          cHistory;
364    LPCWSTR      pszJump1;
365    LPCWSTR      pszJump2;
366    LPCWSTR      pszUrlJump1;
367    LPCWSTR      pszUrlJump2;
368    RECT         rcMinSize;
369    int          cbInfoTypes;
370    LPCWSTR      pszCustomTabs;
371} HH_WINTYPEW, *PHH_WINTYPEW;
372
373
374enum {
375    HHACT_TAB_CONTENTS,
376    HHACT_TAB_INDEX,
377    HHACT_TAB_SEARCH,
378    HHACT_TAB_HISTORY,
379    HHACT_TAB_FAVORITES,
380    HHACT_EXPAND,
381    HHACT_CONTRACT,
382    HHACT_BACK,
383    HHACT_FORWARD,
384    HHACT_STOP,
385    HHACT_REFRESH,
386    HHACT_HOME,
387    HHACT_SYNC,
388    HHACT_OPTIONS,
389    HHACT_PRINT,
390    HHACT_HIGHLIGHT,
391    HHACT_CUSTOMIZE,
392    HHACT_JUMP1,
393    HHACT_JUMP2,
394    HHACT_ZOOM,
395    HHACT_TOC_NEXT,
396    HHACT_TOC_PREV,
397    HHACT_NOTES,
398    HHACT_LAST_ENUM
399};
400
401typedef struct tagHH_NTRACKA {
402    NMHDR        hdr;
403    PCSTR        pszCurUrl;
404    int          idAction;
405    PHH_WINTYPEA phhWinType;
406} HH_NTRACKA;
407
408typedef struct tagHH_NTRACKW {
409    NMHDR        hdr;
410    PCSTR        pszCurUrl;
411    int          idAction;
412    PHH_WINTYPEW phhWinType;
413} HH_NTRACKW;
414
415
416HWND WINAPI HtmlHelpA(HWND,LPCSTR,UINT,DWORD_PTR);
417HWND WINAPI HtmlHelpW(HWND,LPCWSTR,UINT,DWORD_PTR);
418#define HtmlHelp WINELIB_NAME_AW(HtmlHelp)
419
420#define ATOM_HTMLHELP_API_ANSI    (LPTSTR)14
421#define ATOM_HTMLHELP_API_UNICODE (LPTSTR)15
422
423typedef enum tagHH_GPROPID {
424    HH_GPROPID_SINGLETHREAD     = 1,
425    HH_GPROPID_TOOLBAR_MARGIN   = 2,
426    HH_GPROPID_UI_LANGUAGE      = 3,
427    HH_GPROPID_CURRENT_SUBSET   = 4,
428    HH_GPROPID_CONTENT_LANGUAGE = 5
429} HH_GPROPID;
430
431#ifdef __WIDL_OAIDL_H
432
433typedef struct tagHH_GLOBAL_PROPERTY
434{
435    HH_GPROPID  id;
436    VARIANT     var;
437} HH_GLOBAL_PROPERTY ;
438
439#endif /* __WIDL_OAIDL_H */
440
441#ifdef __cplusplus
442}
443#endif
444
445#endif /* __HTMLHELP_H__ */
Note: See TracBrowser for help on using the repository browser.