cde/lib/DtHelp/LinkMgrI.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: LinkMgrI.h /main/6 1995/11/13 16:31:02 rswiston $ */
  24 /*************************************<+>*************************************
  25  *****************************************************************************
  26  **
  27  **  File:   LinkMgrI.h
  28  **
  29  **  Project:
  30  **
  31  **  Description:  Public Header file for Canvas.c
  32  **
  33  **  (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992 Hewlett-Packard Company
  34  **
  35  **  (c) Copyright 1993, 1994 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 Novell, Inc.
  39  **
  40  *******************************************************************
  41  *************************************<+>*************************************/
  42 #ifndef _DtCvLinkMgrI_h
  43 #define _DtCvLinkMgrI_h
  44
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 /********    Semi-Public Enums    ********/
  51 enum    _dtLinkType {
  52         _DtLinkTypeNone,
  53         _DtLinkTypeLink,
  54         _DtLinkTypeSwitch
  55 };
  56
  57 /********    Semi-Public Enum Typedefs    ********/
  58 typedef enum _dtLinkType        _DtLinkType;
  59
  60 /********    Semi-Public Structures Declarations    ********/
  61 typedef struct  _DtLinkData {
  62         int      lnk_type;
  63         int      hint;
  64         char    *spec;
  65         char    *descrip;
  66 } _DtLinkData;
  67
  68 typedef struct  _DtSwitchData {
  69         char    *interp;
  70         char    *cmd;
  71         char    *branches;
  72 } _DtSwitchData;
  73
  74 typedef struct  _dtCvLinkEntry {
  75         _DtLinkType      type;
  76         char            *id;
  77         union {
  78           _DtLinkData   link;
  79           _DtSwitchData swtch;
  80         } info;
  81 } _DtCvLinkEntry;
  82
  83 struct  _dtCvLinkDb {
  84         int              max;
  85         _DtCvLinkEntry  *list;
  86 };
  87
  88 /********    Semi-Public typedef Structures Declarations    ********/
  89 #if !defined(_DtCanvasI_h) && !defined(_DtCvLinkMgrP_h)
  90 typedef       struct  _dtCvLinkDb*    _DtCvLinkDb;
  91 #endif
  92
  93 /********    Semi-Public Function Declarations    ********/
  94
  95 extern  int              _DtLinkDbGetHint(
  96                                 _DtCvLinkDb      link_data,
  97                                 int              link_index);
  98 extern  int              _DtLinkDbGetLinkInfo(
  99                                 _DtCvLinkDb      link_data,
 100                                 int              link_index,
 101                                 int             (*filter)(),
 102                                 void            *client_data,
 103                                 _DtCvLinkInfo   *ret_info);
 104 extern  char            *_DtLinkDbGetLinkSpec(
 105                                 _DtCvLinkDb      link_data,
 106                                 int              link_index);
 107 extern  int              _DtLinkDbGetLinkType(
 108                                 _DtCvLinkDb      link_data,
 109                                 int              link_index);
 110
 111 #ifdef __cplusplus
 112 }  /* Close scope of 'extern "C"' declaration which encloses file. */
 113 #endif
 114
 115 #endif /* _DtCvLinkMgrI_h */
 116 /* DON'T ADD ANYTHING AFTER THIS #endif */