cde/programs/dthelp/dthelpdemo/HelpCacheI.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 libraries 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: HelpCacheI.h /main/3 1995/11/08 09:18:06 rswiston $ */
  24 /************************************<+>*************************************
  25  ****************************************************************************
  26  **
  27  **  File:        HelpCacheI.h
  28  **
  29  **  Project:     CDE dthelpdemo sample program.
  30  **
  31  **  Description: This is the header file for the HelpCache.c module.
  32  **
  33  **
  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
  39  **      Novell, Inc.
  40  **
  41  ****************************************************************************
  42  ************************************<+>*************************************/
  43
  44 #ifndef _HelpCacheI_h
  45 #define _HelpCacheI_h
  46
  47
  48
  49 /****************************************************************
  50  *
  51  *  Cache List Info Structure Definition.
  52  *
  53  ****************************************************************/
  54 typedef struct _CacheListStruct {
  55     Widget                    helpDialog;
  56     Boolean                   inUseFlag;
  57     struct _CacheListStruct   *pNext;
  58     struct _CacheListStruct   *pPrevious;
  59 } CacheListStruct;
  60
  61
  62
  63 /****************************************************************************
  64  * Function:        void DisplayTopic(
  65  *                              Widget parent,
  66  *                              char *accessPath,
  67  *                              char *idString)
  68  *
  69  *
  70  * Return Value:    Void.
  71  *
  72  * Purpose:         Creats and displays a new help dialog w/the requested help
  73  *                  volume and topic.
  74  *
  75  ****************************************************************************/
  76 extern void DisplayTopic(
  77     Widget  parent,
  78     char    *helpVolume,
  79     char    *locationId);
  80
  81
  82
  83
  84 /****************************************************************************
  85  * Function:        void DisplayMain(
  86  *                              Widget parent,
  87  *                              char *helpVolume,
  88  *                              char *locationId)
  89  *
  90  *
  91  * Return Value:    Void.
  92  *
  93  * Purpose:         Displays help for helpdemo in the one helpDialog window
  94  *                  created for the applicaiton.
  95  *
  96  ****************************************************************************/
  97 extern void DisplayMain(
  98     Widget  parent,
  99     char    *helpVolume,
 100     char    *locationId);
 101
 102
 103
 104 /****************************************************************************
 105  * Function:        void DisplayVersion(
 106  *                              Widget parent,
 107  *                              char *helpVolume,
 108  *                              char *locationId)
 109  *
 110  * Return Value:    Void.
 111  *
 112  * Purpose:         Displays the version dialog for the helpdemo program.
 113  *
 114  ****************************************************************************/
 115 extern void DisplayVersion(
 116     Widget  parent,
 117     char    *helpVolume,
 118     char    *locationId);
 119
 120
 121
 122 /*****************************************************************************
 123  * Function:        void HelpMapCB()
 124  *
 125  *
 126  *
 127  * Parameters:      client_data is the widget in reference to
 128  *                  which widget w is placed
 129  *
 130  * Return Value:    Void.
 131  *
 132  * Purpose:         Determins where a new child dialog should be mapped in
 133  *                  relation to its parent.
 134  *
 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.
 139  *
 140  *****************************************************************************/
 141 extern XtCallbackProc HelpMapCB(
 142     Widget w,
 143     XtPointer clientData,
 144     XtPointer callData);
 145
 146
 147
 148 /****************************************************************************
 149  * Function:        void DisplayMan()
 150  *
 151  * Parameters:
 152  *
 153  * Return Value:    Void.
 154  *
 155  * Purpose:         Displays a UNIX man page in a quick help dialog.
 156  *
 157  ****************************************************************************/
 158 extern void DisplayMan(
 159     Widget  parent,
 160     char    *man);
 161
 162
 163
 164 /****************************************************************************
 165  * Function:        void ProcessLinkCB(
 166  *                              Widget w,
 167  *                              XtPointer  clientData,
 168  *                              XtPointer callData
 169  *
 170  * Parameters:
 171  *
 172  * Return Value:    Void.
 173  *
 174  * Purpose:         Process JUMP-NEW and APP-LINK hypertext requests in a
 175  *                  given Help Dialog Window.
 176  *
 177  *                  This is the callback used for the DtNhyperLinkCallback
 178  *                  on each of the help dialog widges created.
 179  *
 180  ****************************************************************************/
 181 extern void ProcessLinkCB (
 182     Widget w,
 183     XtPointer clientData,
 184     XtPointer callData);
 185
 186
 187 #endif /* _HelpCacheI_h */
 188 /* DON'T ADD ANYTHING AFTER THIS #endif */
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204