winhlp32: Links are clicked on WM_LBUTTONDOWN not WM_LBUTTONUP.
[wine] / programs / winhlp32 / winhelp.h
1 /*
2  * Help Viewer
3  *
4  * Copyright    1996 Ulrich Schmid
5  * Copyright    2002 Sylvain Petreolle <spetreolle@yahoo.fr>
6  *              2002 Eric Pouech
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with this library; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21  */
22
23 #define MAX_LANGUAGE_NUMBER     255
24 #define MAX_STRING_LEN          255
25
26 #define INTERNAL_BORDER_WIDTH   5
27 #define POPUP_YDISTANCE         20
28 #define SHADOW_DX               10
29 #define SHADOW_DY               10
30 #define BUTTON_CX               6
31 #define BUTTON_CY               6
32
33 #ifndef RC_INVOKED
34
35 #include <stdarg.h>
36
37 #include "hlpfile.h"
38 #include "windef.h"
39 #include "winbase.h"
40 #include "macro.h"
41 #include "winhelp_res.h"
42
43 typedef struct tagHelpButton
44 {
45     HWND                hWnd;
46
47     LPCSTR              lpszID;
48     LPCSTR              lpszName;
49     LPCSTR              lpszMacro;
50
51     WPARAM              wParam;
52
53     RECT                rect;
54
55     struct tagHelpButton*next;
56 } WINHELP_BUTTON;
57
58 typedef struct
59 {
60     HLPFILE_PAGE*       page;
61     HLPFILE_WINDOWINFO* wininfo;
62     ULONG               relative;
63 } WINHELP_WNDPAGE;
64
65 typedef struct tagPageSet
66 {
67     /* FIXME: for now it's a fixed size */
68     WINHELP_WNDPAGE     set[40];
69     unsigned            index;
70 } WINHELP_PAGESET;
71
72 typedef struct tagWinHelp
73 {
74     LPCSTR              lpszName;
75
76     WINHELP_BUTTON*     first_button;
77     HLPFILE_PAGE*       page;
78
79     HWND                hMainWnd;
80     HWND                hShadowWnd;
81     HWND                hHistoryWnd;
82
83     WNDPROC             origRicheditWndProc;
84
85     HFONT*              fonts;
86     UINT                fonts_len;
87
88     HCURSOR             hHandCur;
89
90     HBRUSH              hBrush;
91
92     HLPFILE_WINDOWINFO* info;
93
94     WINHELP_PAGESET     back;
95     unsigned            font_scale; /* 0 = small, 1 = normal, 2 = large */
96
97     struct tagWinHelp*  next;
98 } WINHELP_WINDOW;
99
100 #define DC_NOMSG     0x00000000
101 #define DC_MINMAX    0x00000001
102 #define DC_INITTERM  0x00000002
103 #define DC_JUMP      0x00000004
104 #define DC_ACTIVATE  0x00000008
105 #define DC_CALLBACKS 0x00000010
106
107 #define DW_NOTUSED    0
108 #define DW_WHATMSG    1
109 #define DW_MINMAX     2
110 #define DW_SIZE       3
111 #define DW_INIT       4
112 #define DW_TERM       5
113 #define DW_STARTJUMP  6
114 #define DW_ENDJUMP    7
115 #define DW_CHGFILE    8
116 #define DW_ACTIVATE   9
117 #define DW_CALLBACKS 10
118
119 typedef long (CALLBACK *WINHELP_LDLLHandler)(WORD, LONG, LONG);
120
121 typedef struct tagDll
122 {
123     HANDLE              hLib;
124     const char*         name;
125     WINHELP_LDLLHandler handler;
126     DWORD               class;
127     struct tagDll*      next;
128 } WINHELP_DLL;
129
130 typedef struct
131 {
132     UINT                wVersion;
133     HANDLE              hInstance;
134     BOOL                isBook;
135     WINHELP_WINDOW*     active_win;
136     WINHELP_WINDOW*     active_popup;
137     WINHELP_WINDOW*     win_list;
138     WNDPROC             button_proc;
139     WINHELP_DLL*        dlls;
140     WINHELP_PAGESET     history;
141     HFONT               hButtonFont;
142 } WINHELP_GLOBALS;
143
144 extern WINHELP_GLOBALS Globals;
145 extern FARPROC         Callbacks[];
146
147 BOOL WINHELP_CreateHelpWindow(WINHELP_WNDPAGE*, int, BOOL);
148 BOOL WINHELP_OpenHelpWindow(HLPFILE_PAGE* (*)(HLPFILE*, LONG, ULONG*),
149                             HLPFILE*, LONG, HLPFILE_WINDOWINFO*, int);
150 BOOL WINHELP_GetOpenFileName(LPSTR, int);
151 BOOL WINHELP_CreateIndexWindow(BOOL);
152 void WINHELP_DeleteBackSet(WINHELP_WINDOW*);
153 HLPFILE* WINHELP_LookupHelpFile(LPCSTR lpszFile);
154 HLPFILE_WINDOWINFO* WINHELP_GetWindowInfo(HLPFILE* hlpfile, LPCSTR name);
155 void WINHELP_LayoutMainWindow(WINHELP_WINDOW* win);
156
157 extern const char MAIN_WIN_CLASS_NAME[];
158 extern const char BUTTON_BOX_WIN_CLASS_NAME[];
159 extern const char TEXT_WIN_CLASS_NAME[];
160 extern const char SHADOW_WIN_CLASS_NAME[];
161 extern const char HISTORY_WIN_CLASS_NAME[];
162 extern const char STRING_BUTTON[];
163 extern const char STRING_MENU_Xx[];
164 extern const char STRING_DIALOG_TEST[];
165 #endif
166
167 /* Buttons */
168 #define WH_FIRST_BUTTON     500