cde/lib/DtHelp/HelpQuickDI.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: HelpQuickDI.h /main/6 1996/04/05 14:41:11 mgreess $ */
  24 /*************************************<+>*************************************
  25  *****************************************************************************
  26  **
  27  **  File:   HelpQuickDI.h
  28  **
  29  **  Project:  Cache Creek (Rivers) Project:
  30  **
  31  **  Description:  Internal header file for QuickHelpDialog Widget.
  32  **  -----------
  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 _HelpQuickDI_h
  44 #define _HelpQuickDI_h
  45
  46 #include "DisplayAreaI.h"
  47
  48 /* General Define for Quick Help Dialog Widget */
  49
  50 #define DtHELP_TOPIC            1
  51 #define DtHELP_STRING           2
  52 #define DtMAN_TOPIC             3
  53 #define DtFILE_TOPIC            4
  54
  55
  56 /* Access File Expantion Definitions */
  57
  58 #define DtACCESS_PATH_TYPE             "help"
  59 #define DtACCESS_PATH_SUFFIX           ".rp"
  60
  61
  62 #define DtNULL_TOPIC_STRING            "Null Topic"
  63
  64
  65
  66 /*****************************************************************************
  67  * Function:        void _DtHelpQuickDialogHypertextCB(
  68  *                              DtHelpDispAreaStruct *pDisplayAreaStruct,
  69  *                              XtPointer clientData,
  70  *                              DtHyperTextCallbackStruct *hyperData)
  71  *
  72  * Parameters:      pDisplayAreaStruct  Specifies the curretn display are info.
  73  *
  74  *                  hyperData           Specifies the current hypertext info
  75  *                                      structure.
  76  *
  77  *                  clientData          Specifies the client data passed into
  78  *                                      the hypertext callback.
  79  *
  80  * Return Value:    Void.
  81  *
  82  * Purpose:         Process all hypertext requests in a given Help Dialogs
  83  *                  display area.
  84  *
  85  *****************************************************************************/
  86 extern void _DtHelpQuickDialogHypertextCB (
  87     XtPointer pDisplayAreaStruct,
  88     XtPointer clientData,
  89     DtHelpHyperTextStruct *hyperData);
  90
  91
  92 #endif /* _HelpQuickDI_h */
  93 /* Do not add anything after this endif. */