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: HelpAccessI.h /main/4 1995/10/26 12:23:38 rswiston $ */
24 /*************************************<+>*************************************
25 *****************************************************************************
27 ** File: HelpAccessI.h
29 ** Project: Cache Creek (Rivers) Project:
31 ** Description: Internal header file for HelpAccess.c
34 ** (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992 Hewlett-Packard Company
36 ** (c) Copyright 1993, 1994 Hewlett-Packard Company
37 ** (c) Copyright 1993, 1994 International Business Machines Corp.
38 ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.
39 ** (c) Copyright 1993, 1994 Novell, Inc.
41 *******************************************************************
42 *************************************<+>*************************************/
43 #ifndef _HelpAccessI_h
44 #define _HelpAccessI_h
49 /* The following Defines are for all the F1 key help requests */
52 #define DtHELP_dialogShell_STR "_HOMETOPIC"
54 /* Menubar help access */
55 #define DtHELP_onHelpMenu_STR "_HOMETOPIC"
56 #define DtHELP_onTableOfContenseMenu_STR "TABLE-OF-CONTENTS"
57 #define DtHELP_onTasksMenu_STR "TASKS"
58 #define DtHELP_onReferenceMenu_STR "REFERENCE"
59 #define DtHELP_onMouseAndKeysMenu_STR "MOUSE-AND-KEYBOARD"
60 #define DtHELP_onVersionMenu_STR "_COPYRIGHT"
62 #define DtHELP_ExecutionPolicy_STR "EXECUTION-POLICY"
64 /* Menu Item Id's (F1 Key) */
65 #define DtHELP_FileMenu_STR "HELP-FILE-MENU"
66 #define DtHELP_EditMenu_STR "HELP-EDIT-MENU"
67 #define DtHELP_SearchMenu_STR "HELP-SEARCH-MENU"
68 #define DtHELP_NavigateMenu_STR "HELP-NAVIGATE-MENU"
69 #define DtHELP_HelpMenu_STR "HELP-HELP-MENU"
70 #define DtHELP_PopupMenu_STR "HELP-POPUP-MENU"
72 /* Quick Help Dialog help access defines */
73 #define DtHELP_quickHelpShell_STR "QUICK-HELP"
74 #define DtHELP_quickHelpBtn_STR "QUICK-HELP"
76 /* History Dialog help access defines */
77 #define DtHELP_historyShell_STR "HISTORY"
78 #define DtHELP_historyHelpBtn_STR "HISTORY"
80 /* Printing Dialog help access defines */
81 #define DtHELP_printShell_STR "PRINTING"
82 #define DtHELP_printHelpBtn_STR "PRINTING"
84 /* Index Search Dialog help access defines */
85 #define DtHELP_srchIndexShell_STR "INDEX-SEARCH"
86 #define DtHELP_srchIndexHelpBtn_STR "INDEX-SEARCH"
88 /* Volume Selection Dialog help access defines */
89 #define DtHELP_volSelectShell_STR "VOLUME-SELECT"
90 #define DtHELP_volSelectHelpBtn_STR "VOLUME-SELECT"
94 /****************************************************************************
95 * Function: void _DtHelpCB (widget, clientData, callData)
97 * XtPointer clientData;
105 * Return Value: Void.
107 * Purpose: Catches any "F1" key presses in a help dialog widget, or
108 * selects any of the help buttons in any of the help dialogs
111 ***************************************************************************/
112 extern void _DtHelpCB(
114 XtPointer clientData,
121 /*****************************************************************************
122 * Function: void _DtHelpListFree (DtHelpListStruct *pHead);
125 * Parameters: pHead Specifies the head pointer to the help list.
127 * Return Value: Void.
129 * Purpose: Frees all elements in a Help List.
131 *****************************************************************************/
132 extern void _DtHelpListFree(
133 DtHelpListStruct * * pHead);
139 /*****************************************************************************
140 * Function: DtHelpListStruct * _DtHelpListAdd(
144 * DtHelpListStruct *pHead)
149 * Return Value: Void.
151 * Purpose: Adds an element to the top of the given topicList.
153 *****************************************************************************/
154 extern DtHelpListStruct * _DtHelpListAdd(
157 _DtHelpCommonHelpStuff * help,
158 DtHelpListStruct **pHead);
162 #endif /* _HelpAccessI_h */
163 /* Do not add anything after this endif. */