![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to pmhelp.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [OS/2 SDKs] / os232sdk / toolkt20 / c / os2h|
Return to pmhelp.h CVS log | Up to [OS/2 SDKs] / os232sdk / toolkt20 / c / os2h |
1.1 root 1: /*static char *SCCSID = "@(#)pmhelp.h 1.7 90/04/02";*/
2:
3: /***************************************************************************\
4: *
5: * Module Name: PMHELP.H
6: *
7: * OS/2 Information Presentation Facility (IPF) for providing Help
8: *
9: * Copyright (c) International Business Machines Corporation 1989
10: * Copyright (c) Microsoft Corporation 1989
11: *
12: *****************************************************************************
13: * Define INCL_WINHELP before OS2.H to include this file
14: \***************************************************************************/
15:
16: #ifndef PMHELP_H
17: #define PMHELP_H
18:
19: /******************************************************************************/
20: /* HelpSubTable entry structure */
21: /******************************************************************************/
22:
23: typedef int HELPSUBTABLE;
24: typedef int FAR *PHELPSUBTABLE;
25:
26: /******************************************************************************/
27: /* HelpTable entry structure */
28: /******************************************************************************/
29:
30: typedef struct _HELPTABLE { /* ht */
31: USHORT idAppWindow;
32: PHELPSUBTABLE phstHelpSubTable;
33: USHORT idExtPanel;
34: } HELPTABLE;
35: typedef HELPTABLE FAR *PHELPTABLE;
36:
37: /******************************************************************************/
38: /* IPF Initialization Structure used on the */
39: /* WinCreateHelpInstance() call. */
40: /******************************************************************************/
41:
42: typedef struct _HELPINIT { /* hinit */
43: USHORT cb;
44: ULONG ulReturnCode;
45: PSZ pszTutorialName;
46: PHELPTABLE phtHelpTable;
47: HMODULE hmodHelpTableModule;
48: HMODULE hmodAccelActionBarModule;
49: USHORT idAccelTable;
50: USHORT idActionBar;
51: PSZ pszHelpWindowTitle;
52: USHORT usShowPanelId;
53: PSZ pszHelpLibraryName;
54: } HELPINIT;
55: typedef HELPINIT FAR *PHELPINIT;
56:
57:
58: /******************************************************************************/
59: /* Search parent chain indicator for HM_SET_ACTIVE_WINDOW message. */
60: /******************************************************************************/
61:
62: #define HWND_PARENT (HWND)NULL
63:
64: /******************************************************************************/
65: /* Constants used to define whether user wants to display panel using */
66: /* panel number or panel name. */
67: /******************************************************************************/
68:
69: #define HM_RESOURCEID 0
70: #define HM_PANELNAME 1
71:
72: #define HMPANELTYPE_NUMBER 0
73: #define HMPANELTYPE_NAME 1
74:
75: /******************************************************************************/
76: /* Constants used to define how the panel IDs are displayed on */
77: /* help panels. */
78: /******************************************************************************/
79:
80: #define CMIC_HIDE_PANEL_ID 0x0000
81: #define CMIC_SHOW_PANEL_ID 0x0001
82: #define CMIC_TOGGLE_PANEL_ID 0x0002
83:
84: /******************************************************************************/
85: /* Window Help function declarations. */
86: /******************************************************************************/
87: /* XLATOFF */
88: #ifdef INCL_16
89: #define WinDestroyHelpInstance Win16DestroyHelpInstance
90: #define WinCreateHelpInstance Win16CreateHelpInstance
91: #define WinAssociateHelpInstance Win16AssociateHelpInstance
92: #define WinQueryHelpInstance Win16QueryHelpInstance
93: #define WinLoadHelpTable Win16LoadHelpTable
94: #define WinCreateHelpTable Win16CreateHelpTable
95: #endif /* INCL_16 */
96: /* XLATON */
97:
98: BOOL APIENTRY WinDestroyHelpInstance( HWND hwndHelpInstance);
99: HWND APIENTRY WinCreateHelpInstance( HAB hab, PHELPINIT phinitHMInitStructure);
100: BOOL APIENTRY WinAssociateHelpInstance( HWND hwndHelpInstance, HWND hwndApp);
101: HWND APIENTRY WinQueryHelpInstance( HWND hwndApp);
102: BOOL APIENTRY WinLoadHelpTable (HWND hwndHelpInstance, USHORT idHelpTable,
103: HMODULE Module);
104: BOOL APIENTRY WinCreateHelpTable (HWND hwndHelpInstance,
105: PHELPTABLE phtHelpTable);
106:
107: /******************************************************************************/
108: /* IPF message base. */
109: /******************************************************************************/
110:
111: #define HM_MSG_BASE 0x0220
112:
113: /******************************************************************************/
114: /* Messages applications can send to the IPF. */
115: /******************************************************************************/
116:
117: #define HM_DISMISS_WINDOW HM_MSG_BASE+0x0001
118: #define HM_DISPLAY_HELP HM_MSG_BASE+0x0002
119: #define HM_EXT_HELP HM_MSG_BASE+0x0003
120: #define HM_SET_ACTIVE_WINDOW HM_MSG_BASE+0x0004
121: #define HM_LOAD_HELP_TABLE HM_MSG_BASE+0x0005
122: #define HM_CREATE_HELP_TABLE HM_MSG_BASE+0x0006
123: #define HM_SET_HELP_WINDOW_TITLE HM_MSG_BASE+0x0007
124: #define HM_SET_SHOW_PANEL_ID HM_MSG_BASE+0x0008
125: #define HM_REPLACE_HELP_FOR_HELP HM_MSG_BASE+0x0009
126: #define HM_HELP_INDEX HM_MSG_BASE+0x000a
127: #define HM_HELP_CONTENTS HM_MSG_BASE+0x000b
128: #define HM_KEYS_HELP HM_MSG_BASE+0x000c
129: #define HM_SET_HELP_LIBRARY_NAME HM_MSG_BASE+0x000d
130:
131: /******************************************************************************/
132: /* Messages the IPF sends to the applications active window */
133: /* as defined by the IPF. */
134: /******************************************************************************/
135:
136: #define HM_ERROR HM_MSG_BASE+0x000e
137: #define HM_HELPSUBITEM_NOT_FOUND HM_MSG_BASE+0x000f
138: #define HM_QUERY_KEYS_HELP HM_MSG_BASE+0x0010
139: #define HM_TUTORIAL HM_MSG_BASE+0x0011
140: #define HM_EXT_HELP_UNDEFINED HM_MSG_BASE+0x0012
141: #define HM_ACTIONBAR_COMMAND HM_MSG_BASE+0x0013
142: #define HM_INFORM HM_MSG_BASE+0x0014
143:
144: /******************************************************************************/
145: /* HMERR_NO_FRAME_WND_IN_CHAIN - There is no frame window in the */
146: /* window chain from which to find or set the associated help */
147: /* instance. */
148: /******************************************************************************/
149:
150: #define HMERR_NO_FRAME_WND_IN_CHAIN 0x00001001L
151:
152: /******************************************************************************/
153: /* HMERR_INVALID_ASSOC_APP_WND - The application window handle */
154: /* specified on the WinAssociateHelpInstance() call is not a valid */
155: /* window handle. */
156: /******************************************************************************/
157:
158: #define HMERR_INVALID_ASSOC_APP_WND 0x00001002L
159:
160: /******************************************************************************/
161: /* HMERR_INVALID_ASSOC_HELP_INST - The help instance handle specified */
162: /* on the WinAssociateHelpInstance() call is not a valid */
163: /* window handle. */
164: /******************************************************************************/
165:
166: #define HMERR_INVALID_ASSOC_HELP_INST 0x00001003L
167:
168: /******************************************************************************/
169: /* HMERR_INVALID_DESTROY_HELP_INST - The window handle specified */
170: /* as the help instance to destroy is not of the help instance class. */
171: /******************************************************************************/
172:
173: #define HMERR_INVALID_DESTROY_HELP_INST 0x00001004L
174:
175: /******************************************************************************/
176: /* HMERR_NO_HELP_INST_IN_CHAIN - The parent or owner chain of the */
177: /* application window specified does not have a help instance */
178: /* associated with it. */
179: /******************************************************************************/
180:
181: #define HMERR_NO_HELP_INST_IN_CHAIN 0x00001005L
182:
183: /******************************************************************************/
184: /* HMERR_INVALID_HELP_INSTANCE_HDL - The handle specified to be a */
185: /* help instance does not have the class name of a IPF */
186: /* help instance. */
187: /******************************************************************************/
188:
189: #define HMERR_INVALID_HELP_INSTANCE_HDL 0x00001006L
190:
191: /******************************************************************************/
192: /* HMERR_INVALID_QUERY_APP_WND - The application window specified on */
193: /* a WinQueryHelpInstance() call is not a valid window handle. */
194: /******************************************************************************/
195:
196: #define HMERR_INVALID_QUERY_APP_WND 0x00001007L
197:
198: /******************************************************************************/
199: /* HMERR_HELP_INST_CALLED_INVALID - The handle of the help instance */
200: /* specified on an API call to the IPF does not have the */
201: /* class name of an IPF help instance. */
202: /******************************************************************************/
203:
204: #define HMERR_HELP_INST_CALLED_INVALID 0x00001008L
205: #define HMERR_HELPTABLE_UNDEFINE 0x00001009L
206: #define HMERR_HELP_INSTANCE_UNDEFINE 0x0000100aL
207: #define HMERR_HELPITEM_NOT_FOUND 0x0000100bL
208: #define HMERR_INVALID_HELPSUBITEM_SIZE 0x0000100cL
209: #define HMERR_HELPSUBITEM_NOT_FOUND 0x0000100dL
210:
211: /******************************************************************************/
212: /* HMERR_INDEX_NOT_FOUND - No index in library file. */
213: /******************************************************************************/
214:
215: #define HMERR_INDEX_NOT_FOUND 0x00002001L
216:
217: /******************************************************************************/
218: /* HMERR_CONTENT_NOT_FOUND - Library file does not have any contents. */
219: /******************************************************************************/
220:
221: #define HMERR_CONTENT_NOT_FOUND 0x00002002L
222:
223: /******************************************************************************/
224: /* HMERR_OPEN_LIB_FILE - Cannot open library file. */
225: /******************************************************************************/
226:
227: #define HMERR_OPEN_LIB_FILE 0x00002003L
228:
229: /******************************************************************************/
230: /* HMERR_READ_LIB_FILE - Cannot read library file. */
231: /******************************************************************************/
232:
233: #define HMERR_READ_LIB_FILE 0x00002004L
234:
235: /******************************************************************************/
236: /* HMERR_CLOSE_LIB_FILE - Cannot close library file. */
237: /******************************************************************************/
238:
239: #define HMERR_CLOSE_LIB_FILE 0x00002005L
240:
241: /******************************************************************************/
242: /* HMERR_INVALID_LIB_FILE - Improper library file provided. */
243: /******************************************************************************/
244:
245: #define HMERR_INVALID_LIB_FILE 0x00002006L
246:
247: /******************************************************************************/
248: /* HMERR_NO_MEMORY - Unable to allocate the requested amount of memory. */
249: /******************************************************************************/
250:
251: #define HMERR_NO_MEMORY 0x00002007L
252:
253: /******************************************************************************/
254: /* HMERR_ALLOCATE_SEGMENT - Unable */
255: /* to allocate a segment of memory for memory allocation requested */
256: /* from the IPF. */
257: /******************************************************************************/
258:
259: #define HMERR_ALLOCATE_SEGMENT 0x00002008L
260:
261: /******************************************************************************/
262: /* HMERR_FREE_MEMORY - Unable to free allocated memory. */
263: /******************************************************************************/
264:
265: #define HMERR_FREE_MEMORY 0x00002009L
266:
267: /******************************************************************************/
268: /* HMERR_PANEL_NOT_FOUND - Unable */
269: /* to find a help panel requested to IPF. */
270: /******************************************************************************/
271:
272: #define HMERR_PANEL_NOT_FOUND 0x00002010L
273:
274: /******************************************************************************/
275: /* HMERR_DATABASE_NOT_OPEN - Unable to read the unopened database. */
276: /******************************************************************************/
277:
278: #define HMERR_DATABASE_NOT_OPEN 0x00002011L
279:
280: #endif
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.