2 * CDE - Common Desktop Environment
4 * Copyright (c) 1993-2012, The Open Group. All rights reserved.
6 * These libraries and programs are free software; you can
7 * redistribute them and/or modify them under the terms of the GNU
8 * Lesser General Public License as published by the Free Software
9 * Foundation; either version 2 of the License, or (at your option)
12 * These libraries and programs are distributed in the hope that
13 * they will be useful, but WITHOUT ANY WARRANTY; without even the
14 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU Lesser General Public License for more
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with these libraries and programs; if not, write
20 * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
21 * Floor, Boston, MA 02110-1301 USA
23 /* $XConsortium: Help.h /main/3 1995/10/26 12:23:24 rswiston $ */
25 * (c) Copyright 1993, 1994 Hewlett-Packard Company
26 * (c) Copyright 1993, 1994 International Business Machines Corp.
27 * (c) Copyright 1993, 1994 Sun Microsystems, Inc.
28 * (c) Copyright 1993, 1994 Novell, Inc.
34 #include <X11/Intrinsic.h>
45 /* Common DtHelp Resources */
47 #ifndef DtNcloseCallback
48 #define DtNcloseCallback "closeCallback"
51 #define DtNcolumns XmNcolumns
53 #ifndef DtNexecutionPolicy
54 #define DtNexecutionPolicy "executionPolicy"
57 #define DtNhelpFile "helpFile"
59 #ifndef DtNhelpOnHelpVolume
60 #define DtNhelpOnHelpVolume "helpOnHelpVolume"
63 #define DtNhelpPrint "helpPrint"
66 #define DtNhelpType "helpType"
69 #define DtNhelpVolume "helpVolume"
71 #ifndef DtNhyperLinkCallback
72 #define DtNhyperLinkCallback "hyperLinkCallback"
75 #define DtNlocationId "locationId"
78 #define DtNmanPage "manPage"
80 #ifndef DtNminimizeButtons
81 #define DtNminimizeButtons XmNminimizeButtons
84 #define DtNpaperSize "paperSize"
87 #define DtNprinter "printer"
90 #define DtNrows XmNrows
92 #ifndef DtNscrollBarPolicy
93 #define DtNscrollBarPolicy "scrollBarPolicy"
96 #define DtNstringData "stringData"
100 #define DtCCallback XmCCallback
103 #ifndef DtCCloseCallback
104 #define DtCCloseCallback "CloseCallback"
107 #define DtCColumns XmCColumns
109 #ifndef DtCExecutionPolicy
110 #define DtCExecutionPolicy "ExecutionPolicy"
113 #define DtCHelpFile "HelpFile"
115 #ifndef DtCHelpOnHelpVolume
116 #define DtCHelpOnHelpVolume "HelpOnHelpVolume"
119 #define DtCHelpPrint "HelpPrint"
122 #define DtCHelpType "HelpType"
124 #ifndef DtCHelpVolume
125 #define DtCHelpVolume "HelpVolume"
127 #ifndef DtCHyperLinkCallback
128 #define DtCHyperLinkCallback "HyperLinkCallback"
130 #ifndef DtCLocationId
131 #define DtCLocationId "LocationId"
134 #define DtCManPage "ManPage"
136 #ifndef DtCMinimizeButtons
137 #define DtCMinimizeButtons XmCMinimizeButtons
140 #define DtCPaperSize "PaperSize"
143 #define DtCPrinter "Printer"
146 #define DtCRows XmCRows
148 #ifndef DtCScrollBarPolicy
149 #define DtCScrollBarPolicy "ScrollBarPolicy"
151 #ifndef DtCStringData
152 #define DtCStringData "StringData"
155 /* Representation types */
157 #ifndef DtRDtExecutionPolicy
158 #define DtRDtExecutionPolicy "DtExecutionPolicy"
160 #ifndef DtRDtHelpType
161 #define DtRDtHelpType "DtHelpType"
163 #ifndef DtRDtPaperSize
164 #define DtRDtPaperSize "DtPaperSize"
166 #ifndef DtRDtScrollBarPolicy
167 #define DtRDtScrollBarPolicy "DtScrollBarPolicy"
170 /* DtHelpDialogCallbackStruct windowHint field */
172 #define DtHELP_POPUP_WINDOW 1
173 #define DtHELP_CURRENT_WINDOW 2
174 #define DtHELP_NEW_WINDOW 3
176 /* DtHelpDialogCallbackStruct hyperType field */
178 #define DtHELP_LINK_JUMP_NEW 1
179 #define DtHELP_LINK_TOPIC 1
180 #define DtHELP_LINK_MAN_PAGE 4
181 #define DtHELP_LINK_APP_DEFINE 5
182 #define DtHELP_LINK_TEXT_FILE 8
184 /* DtHelpDialogCallbackStruct reason field */
186 #define DtCR_HELP_LINK_ACTIVATE 1
187 #define DtCR_HELP_CLOSE 2
188 #define DtCR_HELP_HELP 3
190 /* Possible values for DtNscrollBarPolicy resource */
192 #define DtHELP_NO_SCROLLBARS 0
193 #define DtHELP_STATIC_SCROLLBARS 1
194 #define DtHELP_AS_NEEDED_SCROLLBARS 2
196 /* Possible values for DtNexecutionPolicy resource */
197 #define DtHELP_EXECUTE_NONE 0
198 #define DtHELP_EXECUTE_QUERY_ALL 1
199 #define DtHELP_EXECUTE_QUERY_UNALIASED 2
200 #define DtHELP_EXECUTE_ALL 3
202 /* Possible values for DtNhelpType resource */
204 #define DtHELP_TYPE_TOPIC 0
205 #define DtHELP_TYPE_STRING 1
206 #define DtHELP_TYPE_MAN_PAGE 2
207 #define DtHELP_TYPE_FILE 3
208 #define DtHELP_TYPE_DYNAMIC_STRING 4
210 /* Possible values for DtNpaperSize resource */
212 #define DtHELP_PAPERSIZE_LETTER 0
213 #define DtHELP_PAPERSIZE_LEGAL 1
214 #define DtHELP_PAPERSIZE_EXECUTIVE 2
215 #define DtHELP_PAPERSIZE_A4 3
216 #define DtHELP_PAPERSIZE_B5 4
218 /* DtHelpQuickGetChildGetChild() function */
220 #define DtHELP_QUICK_CLOSE_BUTTON 1
221 #define DtHELP_QUICK_PRINT_BUTTON 2
222 #define DtHELP_QUICK_HELP_BUTTON 3
223 #define DtHELP_QUICK_SEPARATOR 4
224 #define DtHELP_QUICK_MORE_BUTTON 5
225 #define DtHELP_QUICK_BACK_BUTTON 6
227 /* Return values for DtHelpReturnSelectedWidgetId() */
229 #define DtHELP_SELECT_ERROR -1
230 #define DtHELP_SELECT_VALID 0
231 #define DtHELP_SELECT_ABORT 1
232 #define DtHELP_SELECT_INVALID 2
247 } DtHelpDialogCallbackStruct;
254 extern void DtHelpSetCatalogName(
257 extern int DtHelpReturnSelectedWidgetId(
266 #endif /* _Dt_Help_h */