File: Help.h

package info (click to toggle)
motif 2.3.8-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 36,432 kB
  • sloc: ansic: 452,643; sh: 4,613; makefile: 2,030; yacc: 1,604; lex: 352; cpp: 348
file content (266 lines) | stat: -rw-r--r-- 6,773 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
/*
 * CDE - Common Desktop Environment
 *
 * Copyright (c) 1993-2012, The Open Group. All rights reserved.
 *
 * These libraries and programs are free software; you can
 * redistribute them and/or modify them under the terms of the GNU
 * Lesser General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * These libraries and programs are distributed in the hope that
 * they will be useful, but WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with these librararies and programs; if not, write
 * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301 USA
 */
/* $XConsortium: Help.h /main/3 1995/10/26 12:23:24 rswiston $ */
/*
 *  (c) Copyright 1993, 1994 Hewlett-Packard Company
 *  (c) Copyright 1993, 1994 International Business Machines Corp.
 *  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
 *  (c) Copyright 1993, 1994 Novell, Inc.
 */

#ifndef _Dt_Help_h
#define _Dt_Help_h

#include <X11/Intrinsic.h>

#ifdef __cplusplus
extern "C" {
#endif


/*
 * Constants
 */

/* Common DtHelp Resources  */

#ifndef DtNcloseCallback
#define DtNcloseCallback	   "closeCallback"
#endif
#ifndef DtNcolumns
#define DtNcolumns                 XmNcolumns
#endif
#ifndef DtNexecutionPolicy
#define DtNexecutionPolicy         "executionPolicy"
#endif
#ifndef DtNhelpFile
#define DtNhelpFile                "helpFile"
#endif
#ifndef DtNhelpOnHelpVolume
#define DtNhelpOnHelpVolume		"helpOnHelpVolume"
#endif
#ifndef DtNhelpPrint
#define DtNhelpPrint               "helpPrint"
#endif
#ifndef DtNhelpType
#define DtNhelpType                "helpType"
#endif
#ifndef DtNhelpVolume
#define DtNhelpVolume              "helpVolume"
#endif
#ifndef DtNhyperLinkCallback
#define DtNhyperLinkCallback       "hyperLinkCallback"
#endif
#ifndef DtNlocationId
#define DtNlocationId              "locationId"
#endif
#ifndef DtNmanPage
#define DtNmanPage                 "manPage"
#endif
#ifndef DtNminimizeButtons
#define DtNminimizeButtons         XmNminimizeButtons
#endif
#ifndef DtNpaperSize
#define DtNpaperSize               "paperSize"
#endif
#ifndef DtNprinter
#define DtNprinter                 "printer"
#endif
#ifndef DtNrows
#define DtNrows                    XmNrows
#endif
#ifndef DtNscrollBarPolicy
#define DtNscrollBarPolicy         "scrollBarPolicy"
#endif
#ifndef DtNstringData
#define DtNstringData              "stringData"
#endif

#ifndef DtCCallback
#define DtCCallback                XmCCallback
#endif

#ifndef DtCCloseCallback
#define DtCCloseCallback	   "CloseCallback"
#endif
#ifndef DtCColumns
#define DtCColumns                 XmCColumns
#endif
#ifndef DtCExecutionPolicy
#define DtCExecutionPolicy         "ExecutionPolicy"
#endif
#ifndef DtCHelpFile
#define DtCHelpFile                "HelpFile"
#endif
#ifndef DtCHelpOnHelpVolume
#define DtCHelpOnHelpVolume	   "HelpOnHelpVolume"
#endif
#ifndef DtCHelpPrint
#define DtCHelpPrint               "HelpPrint"
#endif
#ifndef DtCHelpType
#define DtCHelpType                "HelpType"
#endif
#ifndef DtCHelpVolume
#define DtCHelpVolume              "HelpVolume"
#endif
#ifndef DtCHyperLinkCallback
#define DtCHyperLinkCallback       "HyperLinkCallback"
#endif
#ifndef DtCLocationId
#define DtCLocationId              "LocationId"
#endif
#ifndef DtCManPage
#define DtCManPage                 "ManPage"
#endif
#ifndef DtCMinimizeButtons
#define DtCMinimizeButtons         XmCMinimizeButtons
#endif
#ifndef DtCPaperSize
#define DtCPaperSize               "PaperSize"
#endif
#ifndef DtCPrinter
#define DtCPrinter                 "Printer"
#endif
#ifndef DtCRows
#define DtCRows                    XmCRows
#endif
#ifndef DtCScrollBarPolicy
#define DtCScrollBarPolicy         "ScrollBarPolicy"
#endif
#ifndef DtCStringData
#define DtCStringData              "StringData"
#endif

/* Representation types */

#ifndef DtRDtExecutionPolicy
#define DtRDtExecutionPolicy         "DtExecutionPolicy"
#endif
#ifndef DtRDtHelpType
#define DtRDtHelpType                "DtHelpType"
#endif
#ifndef DtRDtPaperSize
#define DtRDtPaperSize               "DtPaperSize"
#endif
#ifndef DtRDtScrollBarPolicy
#define DtRDtScrollBarPolicy         "DtScrollBarPolicy"
#endif

/* DtHelpDialogCallbackStruct windowHint field */

#define DtHELP_POPUP_WINDOW       1
#define DtHELP_CURRENT_WINDOW     2
#define DtHELP_NEW_WINDOW         3

/* DtHelpDialogCallbackStruct hyperType field */

#define DtHELP_LINK_JUMP_NEW          1
#define DtHELP_LINK_TOPIC             1
#define DtHELP_LINK_MAN_PAGE          4
#define DtHELP_LINK_APP_DEFINE        5
#define DtHELP_LINK_TEXT_FILE         8

/* DtHelpDialogCallbackStruct reason field */

#define DtCR_HELP_LINK_ACTIVATE      1
#define DtCR_HELP_CLOSE              2
#define DtCR_HELP_HELP               3

/* Possible values for DtNscrollBarPolicy resource */

#define  DtHELP_NO_SCROLLBARS        0
#define  DtHELP_STATIC_SCROLLBARS    1
#define  DtHELP_AS_NEEDED_SCROLLBARS 2

/* Possible values for DtNexecutionPolicy resource */
#define  DtHELP_EXECUTE_NONE			0
#define  DtHELP_EXECUTE_QUERY_ALL		1
#define  DtHELP_EXECUTE_QUERY_UNALIASED		2
#define  DtHELP_EXECUTE_ALL			3

/* Possible values for DtNhelpType resource */

#define DtHELP_TYPE_TOPIC           0
#define DtHELP_TYPE_STRING          1
#define DtHELP_TYPE_MAN_PAGE        2
#define DtHELP_TYPE_FILE            3
#define DtHELP_TYPE_DYNAMIC_STRING  4

/* Possible values for DtNpaperSize resource */

#define DtHELP_PAPERSIZE_LETTER     0
#define DtHELP_PAPERSIZE_LEGAL      1
#define DtHELP_PAPERSIZE_EXECUTIVE  2
#define DtHELP_PAPERSIZE_A4         3
#define DtHELP_PAPERSIZE_B5         4

/* DtHelpQuickGetChildGetChild() function */

#define DtHELP_QUICK_CLOSE_BUTTON    1
#define DtHELP_QUICK_PRINT_BUTTON    2
#define DtHELP_QUICK_HELP_BUTTON     3
#define DtHELP_QUICK_SEPARATOR       4
#define DtHELP_QUICK_MORE_BUTTON     5
#define DtHELP_QUICK_BACK_BUTTON     6

/* Return values for DtHelpReturnSelectedWidgetId() */

#define DtHELP_SELECT_ERROR   -1 
#define DtHELP_SELECT_VALID    0
#define DtHELP_SELECT_ABORT    1
#define DtHELP_SELECT_INVALID  2 


/*
 * Types
 */

typedef struct {
	int	reason;
	XEvent	*event;
	char	*locationId;
	char	*helpVolume;
	char	*specification;
	int	hyperType;
	int	windowHint;
} DtHelpDialogCallbackStruct;


/*
 * Functions
 */

extern void DtHelpSetCatalogName(
		char		*catFile);

extern int DtHelpReturnSelectedWidgetId(
		Widget		parent,
		Cursor		cursor,
		Widget		*widget);

#ifdef __cplusplus
}
#endif

#endif /* _Dt_Help_h */