cde/lib/DtHelp/HelpTermP.h

   1 /*
   2  * CDE - Common Desktop Environment
   3  *
   4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
   5  *
   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)
  10  * any later version.
  11  *
  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
  16  * details.
  17  *
  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
  22  */
  23 /* $XConsortium: HelpTermP.h /main/4 1995/10/26 12:25:56 rswiston $ */
  24 /*************************************<+>*************************************
  25  *****************************************************************************
  26  **
  27  **  File:   FormatTerm.h
  28  **
  29  **  Project:  Cache Creek (Rivers) Project:
  30  **
  31  **  Description:  Public Header file for FormatTerm.c, the terminal access
  32  **                functions.
  33  **
  34  **  (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992 Hewlett-Packard Company
  35  **
  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.
  40  **
  41  *******************************************************************
  42  *************************************<+>*************************************/
  43 #ifndef _DtHelpFormatTermP_h
  44 #define _DtHelpFormatTermP_h
  45
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 /**************************
  52  * Link Types and Window
  53  * Hints should match what
  54  * is in Canvas.h
  55  **************************/
  56 /**************************
  57  * Link Types
  58  **************************/
  59
  60 #ifndef CELinkType_Execute
  61 #define CELinkType_Execute      3
  62 #endif
  63 #ifndef CELinkType_ManPage
  64 #define CELinkType_ManPage      4
  65 #endif
  66 #ifndef CELinkType_AppDefine
  67 #define CELinkType_AppDefine    5
  68 #endif
  69 #ifndef CELinkType_SameVolume
  70 #define CELinkType_SameVolume   6
  71 #endif
  72 #ifndef CELinkType_CrossLink
  73 #define CELinkType_CrossLink    7
  74 #endif
  75 #ifndef CELinkType_TextFile
  76 #define CELinkType_TextFile     8
  77 #endif
  78
  79
  80 /**************************
  81  * Window Hint Kinds
  82  **************************/
  83
  84 #ifndef CEWindowHint_PopupWindow
  85 #define CEWindowHint_PopupWindow        1
  86 #endif
  87 #ifndef CEWindowHint_CurrentWindow
  88 #define CEWindowHint_CurrentWindow      2
  89 #endif
  90 #ifndef CEWindowHint_NewWindow
  91 #define CEWindowHint_NewWindow          3
  92 #endif
  93
  94 /********    Public Defines Declarations    ********/
  95
  96 /********    Public Structures Declarations    ********/
  97
  98
  99 /*****************************************************************************
 100  * Structure:       DtHelpHyperLines
 101  *
 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.
 105  *
 106  *
 107  *****************************************************************************/
 108 typedef struct {
 109         char    *title;
 110         char    *specification;
 111         int      hyper_type;
 112         int      win_hint;
 113 } DtHelpHyperLines;
 114
 115
 116 /********    Public Function Declarations    ********/
 117
 118 /*****************************************************************************
 119  * Function:          extern void _DtHelpFreeTopicData (
 120  *                                  char  **helpList,
 121  *                                  DtHelpHyperLines   *hyperList)
 122  *
 123  *
 124  * Parameters:      helpList    Specifies the parent widget ID.
 125  *                  hyperList   Specifies the name of the created dialog
 126  *
 127  * Return Value:    void.
 128  *
 129  * Purpose:         Free up the info gotten by _DtHelpGetTopicData.
 130  *
 131  *****************************************************************************/
 132 extern void _DtHelpFreeTopicData (
 133     char           **helpList,
 134     DtHelpHyperLines   *hyperList);
 135
 136
 137
 138 /*****************************************************************************
 139  * Function:          extern int _DtHelpGetTopicData(
 140  *                                      char *helpVolume,
 141  *                                      char *locationID,
 142  *                                      int maxColumns,
 143  *                                      char ***helpList,
 144  *                                      DtHelpHyperLines  **hyperList);
 145  *
 146  * Parameters:
 147  *
 148  *
 149  * Return Value:    int value, -1 implies that the function call failed, a
 150  *                  value of 0, implies that the call was successful.
 151  *
 152  * Purpose:         Allows developers to extract semi-formatted ASCII data
 153  *                  from a Cache Creek help file.
 154  *
 155  *****************************************************************************/
 156 extern int _DtHelpGetTopicData (
 157     char *helpVolume,
 158     char *locationID,
 159     int maxColumns,
 160     char ***helpList,
 161     DtHelpHyperLines  **hyperList);
 162
 163
 164
 165 /*****************************************************************************
 166  * Function:          extern int _DtHelpProcessLinkData(
 167  *                                   DtHelpHyperLines *hyperLine,
 168  *                                   char **helpVolume,
 169  *                                   char **locationId )
 170  *
 171  *
 172  * Parameters:
 173  *
 174  *
 175  * Return Value:    int value, -1 implies that the function call failed, a
 176  *                  value of 0, implies that the call was successful.
 177  *
 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.
 186  *
 187  *****************************************************************************/
 188 extern int _DtHelpProcessLinkData (
 189     char             *ref_volume,
 190     DtHelpHyperLines *hyperLine,
 191     char **helpVolume,
 192     char **locationId);
 193
 194
 195 #ifdef __cplusplus
 196 }  /* Close scope of 'extern "C"' declaration which encloses file. */
 197 #endif
 198
 199
 200 #endif /* _DtHelpFormatTermP_h */
 201 /* DON'T ADD ANYTHING AFTER THIS #endif */