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: HelpTermP.h /main/4 1995/10/26 12:25:56 rswiston $ */
24 /*************************************<+>*************************************
25 *****************************************************************************
29 ** Project: Cache Creek (Rivers) Project:
31 ** Description: Public Header file for FormatTerm.c, the terminal access
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 _DtHelpFormatTermP_h
44 #define _DtHelpFormatTermP_h
51 /**************************
52 * Link Types and Window
53 * Hints should match what
55 **************************/
56 /**************************
58 **************************/
60 #ifndef CELinkType_Execute
61 #define CELinkType_Execute 3
63 #ifndef CELinkType_ManPage
64 #define CELinkType_ManPage 4
66 #ifndef CELinkType_AppDefine
67 #define CELinkType_AppDefine 5
69 #ifndef CELinkType_SameVolume
70 #define CELinkType_SameVolume 6
72 #ifndef CELinkType_CrossLink
73 #define CELinkType_CrossLink 7
75 #ifndef CELinkType_TextFile
76 #define CELinkType_TextFile 8
80 /**************************
82 **************************/
84 #ifndef CEWindowHint_PopupWindow
85 #define CEWindowHint_PopupWindow 1
87 #ifndef CEWindowHint_CurrentWindow
88 #define CEWindowHint_CurrentWindow 2
90 #ifndef CEWindowHint_NewWindow
91 #define CEWindowHint_NewWindow 3
94 /******** Public Defines Declarations ********/
96 /******** Public Structures Declarations ********/
99 /*****************************************************************************
100 * Structure: DtHelpHyperLines
102 * Fields: title Indicates the title of the linked topic.
103 * specification Contains the hypertext link information.
104 * hyper_type Specifies the hypertext links type.
107 *****************************************************************************/
116 /******** Public Function Declarations ********/
118 /*****************************************************************************
119 * Function: extern void _DtHelpFreeTopicData (
121 * DtHelpHyperLines *hyperList)
124 * Parameters: helpList Specifies the parent widget ID.
125 * hyperList Specifies the name of the created dialog
127 * Return Value: void.
129 * Purpose: Free up the info gotten by _DtHelpGetTopicData.
131 *****************************************************************************/
132 extern void _DtHelpFreeTopicData (
134 DtHelpHyperLines *hyperList);
138 /*****************************************************************************
139 * Function: extern int _DtHelpGetTopicData(
144 * DtHelpHyperLines **hyperList);
149 * Return Value: int value, -1 implies that the function call failed, a
150 * value of 0, implies that the call was successful.
152 * Purpose: Allows developers to extract semi-formatted ASCII data
153 * from a Cache Creek help file.
155 *****************************************************************************/
156 extern int _DtHelpGetTopicData (
161 DtHelpHyperLines **hyperList);
165 /*****************************************************************************
166 * Function: extern int _DtHelpProcessLinkData(
167 * DtHelpHyperLines *hyperLine,
169 * char **locationId )
175 * Return Value: int value, -1 implies that the function call failed, a
176 * value of 0, implies that the call was successful.
178 * Purpose: This function is used in conjunction with the
179 * _DtHelpGetTopicData() function call to provide developers
180 * with a mechanism in which they can traverse Cache Creek
181 * hypertext links. This call will return the file and
182 * locationid information that when used with the
183 * DtGetTopicData function will retrrieve the help text
184 * and new hypertext information associated with the previous
185 * hypertext link information.
187 *****************************************************************************/
188 extern int _DtHelpProcessLinkData (
190 DtHelpHyperLines *hyperLine,
196 } /* Close scope of 'extern "C"' declaration which encloses file. */
200 #endif /* _DtHelpFormatTermP_h */
201 /* DON'T ADD ANYTHING AFTER THIS #endif */