cde/lib/DtHelp/HelpAccessI.h

   1 /* $XConsortium: HelpAccessI.h /main/4 1995/10/26 12:23:38 rswiston $ */
   2 /*************************************<+>*************************************
   3  *****************************************************************************
   4  **
   5  **  File:   HelpAccessI.h
   6  **
   7  **  Project:  Cache Creek (Rivers) Project:
   8  **
   9  **  Description:  Internal header file for HelpAccess.c
  10  **  -----------
  11  **
  12  **  (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992 Hewlett-Packard Company
  13  **
  14  **  (c) Copyright 1993, 1994 Hewlett-Packard Company
  15  **  (c) Copyright 1993, 1994 International Business Machines Corp.
  16  **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
  17  **  (c) Copyright 1993, 1994 Novell, Inc.
  18  **
  19  *******************************************************************
  20  *************************************<+>*************************************/
  21 #ifndef _HelpAccessI_h
  22 #define _HelpAccessI_h
  23
  24
  25
  26
  27 /* The following Defines are for all the F1 key help requests */
  28
  29 /* Help Dialog */
  30 #define DtHELP_dialogShell_STR  "_HOMETOPIC"
  31
  32 /* Menubar help access */
  33 #define DtHELP_onHelpMenu_STR                "_HOMETOPIC"
  34 #define DtHELP_onTableOfContenseMenu_STR     "TABLE-OF-CONTENTS"
  35 #define DtHELP_onTasksMenu_STR               "TASKS"
  36 #define DtHELP_onReferenceMenu_STR           "REFERENCE"
  37 #define DtHELP_onMouseAndKeysMenu_STR        "MOUSE-AND-KEYBOARD"
  38 #define DtHELP_onVersionMenu_STR             "_COPYRIGHT"
  39
  40 #define DtHELP_ExecutionPolicy_STR           "EXECUTION-POLICY"
  41
  42 /* Menu Item Id's (F1 Key) */
  43 #define DtHELP_FileMenu_STR           "HELP-FILE-MENU"
  44 #define DtHELP_EditMenu_STR           "HELP-EDIT-MENU"
  45 #define DtHELP_SearchMenu_STR         "HELP-SEARCH-MENU"
  46 #define DtHELP_NavigateMenu_STR       "HELP-NAVIGATE-MENU"
  47 #define DtHELP_HelpMenu_STR           "HELP-HELP-MENU"
  48 #define DtHELP_PopupMenu_STR          "HELP-POPUP-MENU"
  49
  50 /* Quick Help Dialog help access defines */
  51 #define DtHELP_quickHelpShell_STR   "QUICK-HELP"
  52 #define DtHELP_quickHelpBtn_STR     "QUICK-HELP"
  53
  54 /* History Dialog help access defines */
  55 #define DtHELP_historyShell_STR       "HISTORY"
  56 #define DtHELP_historyHelpBtn_STR     "HISTORY"
  57
  58 /* Printing Dialog help access defines */
  59 #define DtHELP_printShell_STR       "PRINTING"
  60 #define DtHELP_printHelpBtn_STR     "PRINTING"
  61
  62 /* Index Search Dialog help access defines */
  63 #define DtHELP_srchIndexShell_STR   "INDEX-SEARCH"
  64 #define DtHELP_srchIndexHelpBtn_STR "INDEX-SEARCH"
  65
  66 /* Volume Selection Dialog help access defines */
  67 #define DtHELP_volSelectShell_STR    "VOLUME-SELECT"
  68 #define DtHELP_volSelectHelpBtn_STR  "VOLUME-SELECT"
  69
  70
  71
  72 /****************************************************************************
  73  * Function:          void  _DtHelpCB (widget, clientData, callData)
  74  *                                    Widget    widget;
  75  *                                    XtPointer clientData;
  76  *                                    XtPointer   callData;
  77  *
  78  * Parameters:           widget
  79  *                       clientData
  80  *                       callData
  81  *
  82  *
  83  * Return Value:    Void.
  84  *
  85  * Purpose:         Catches any "F1" key presses in a help dialog widget, or
  86  *                  selects any of the help buttons in any of the help dialogs
  87  *                  dialogs.
  88  *
  89  ***************************************************************************/
  90 extern void  _DtHelpCB(
  91     Widget widget,
  92     XtPointer clientData,
  93     XtPointer callData);
  94
  95
  96
  97
  98
  99 /*****************************************************************************
 100  * Function:        void _DtHelpListFree (DtHelpListStruct *pHead);
 101  *
 102  *
 103  * Parameters:      pHead   Specifies the head pointer to the help list.
 104  *
 105  * Return Value:    Void.
 106  *
 107  * Purpose:         Frees all elements in a Help List.
 108  *
 109  *****************************************************************************/
 110 extern void _DtHelpListFree(
 111     DtHelpListStruct * * pHead);
 112
 113
 114
 115
 116
 117 /*****************************************************************************
 118  * Function:        DtHelpListStruct * _DtHelpListAdd(
 119  *                                       char *locationId,
 120  *                                       Widget widget,
 121  *                                       int widgetType,
 122  *                                       DtHelpListStruct *pHead)
 123  *
 124  *
 125  * Parameters:
 126  *
 127  * Return Value:    Void.
 128  *
 129  * Purpose:         Adds an element to the top of the given topicList.
 130  *
 131  *****************************************************************************/
 132 extern DtHelpListStruct * _DtHelpListAdd(
 133     char *locationId,
 134     Widget widget,
 135     _DtHelpCommonHelpStuff * help,
 136     DtHelpListStruct **pHead);
 137
 138
 139
 140 #endif /* _HelpAccessI_h */
 141 /* Do not add anything after this endif. */
 142