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 librararies 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: HelpCacheI.h /main/3 1995/11/08 09:18:06 rswiston $ */
24 /************************************<+>*************************************
25 ****************************************************************************
29 ** Project: CDE dthelpdemo sample program.
31 ** Description: This is the header file for the HelpCache.c module.
34 ** (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994
35 ** Hewlett-Packard Company
36 ** (c) Copyright 1993, 1994 International Business Machines Corp.
37 ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.
38 ** (c) Copyright 1993, 1994 Unix System Labs, Inc., a subsidiary of
41 ****************************************************************************
42 ************************************<+>*************************************/
49 /****************************************************************
51 * Cache List Info Structure Definition.
53 ****************************************************************/
54 typedef struct _CacheListStruct {
57 struct _CacheListStruct *pNext;
58 struct _CacheListStruct *pPrevious;
63 /****************************************************************************
64 * Function: void DisplayTopic(
72 * Purpose: Creats and displays a new help dialog w/the requested help
75 ****************************************************************************/
76 extern void DisplayTopic(
84 /****************************************************************************
85 * Function: void DisplayMain(
93 * Purpose: Displays help for helpdemo in the one helpDialog window
94 * created for the applicaiton.
96 ****************************************************************************/
97 extern void DisplayMain(
104 /****************************************************************************
105 * Function: void DisplayVersion(
110 * Return Value: Void.
112 * Purpose: Displays the version dialog for the helpdemo program.
114 ****************************************************************************/
115 extern void DisplayVersion(
122 /*****************************************************************************
123 * Function: void HelpMapCB()
127 * Parameters: client_data is the widget in reference to
128 * which widget w is placed
130 * Return Value: Void.
132 * Purpose: Determins where a new child dialog should be mapped in
133 * relation to its parent.
135 * Algorithm: 1. attempt left or right placement with no overlap
136 * 2. if fails, attempt up or down placement with no overlap
137 * 3. if fails, determines location with least
138 * amount of overlap, and places there.
140 *****************************************************************************/
141 extern XtCallbackProc HelpMapCB(
143 XtPointer clientData,
148 /****************************************************************************
149 * Function: void DisplayMan()
153 * Return Value: Void.
155 * Purpose: Displays a UNIX man page in a quick help dialog.
157 ****************************************************************************/
158 extern void DisplayMan(
164 /****************************************************************************
165 * Function: void ProcessLinkCB(
167 * XtPointer clientData,
172 * Return Value: Void.
174 * Purpose: Process JUMP-NEW and APP-LINK hypertext requests in a
175 * given Help Dialog Window.
177 * This is the callback used for the DtNhyperLinkCallback
178 * on each of the help dialog widges created.
180 ****************************************************************************/
181 extern void ProcessLinkCB (
183 XtPointer clientData,
187 #endif /* _HelpCacheI_h */
188 /* DON'T ADD ANYTHING AFTER THIS #endif */