cde/lib/DtHelp/FormatI.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: FormatI.h /main/5 1995/10/26 12:20:54 rswiston $ */
  24 /************************************<+>*************************************
  25  ****************************************************************************
  26  **
  27  **   File:        FormatI.h
  28  **
  29  **   Project:     TextGraphic Display routines
  30  **
  31  **   Description: Header file for Format.c
  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  ****************************************************************************
  44  ************************************<+>*************************************/
  45 #ifndef _DtHelpFormatI_h
  46 #define _DtHelpFormatI_h
  47
  48 extern  int              _DtHelpFormatAsciiFile (
  49                                 XtPointer         client_data,
  50                                 char             *filename,
  51                                 XtPointer        *ret_topic);
  52 extern  int              _DtHelpFormatAsciiString (
  53                                 XtPointer         client_data,
  54                                 char            *input_string,
  55                                 XtPointer        *ret_topic);
  56 extern  int              _DtHelpFormatAsciiStringDynamic (
  57                                 XtPointer         client_data,
  58                                 char            *input_string,
  59                                 XtPointer        *ret_topic);
  60 extern  int              _DtFormatGetParagraphList(
  61                                 XtPointer        *ret_topic);
  62 extern  int              _DtHelpFormatIndexEntries (
  63                                 XtPointer         client_data,
  64                                 _DtHelpVolumeHdl     volume,
  65                                 int              *ret_cnt,
  66                                 XmString        **ret_words,
  67                                 XmFontList       *ret_list,
  68                                 Boolean          *ret_mod);
  69 extern  void             _DtFormatInitializeFontQuarks(
  70                                 char    **font_attr );
  71 extern  int              _DtFormatInitializeVariables(
  72                                 char             *input_string,
  73                                 int               grow_size );
  74 extern  int              _DtFormatProcessString (
  75                                 char    **input_string,
  76                                 int       seg_type,
  77                                 char    **font_attr );
  78 extern  int              _DtHelpFormatToc (
  79                                 XtPointer         client_data,
  80                                 _DtHelpVolumeHdl     volume,
  81                                 char            *id_string,
  82                                 char            *ret_id,
  83                                 XtPointer       *ret_handle);
  84 extern  int              _DtHelpFormatTopic (
  85                                 XtPointer         client_data,
  86                                 _DtHelpVolumeHdl     volume,
  87                                 char            *id_string,
  88                                 Boolean          look_at_id,
  89                                 XtPointer       *ret_handle);
  90 extern  int              _DtHelpFormatTopicTitle (
  91                                 XtPointer         client_data,
  92                                 _DtHelpVolumeHdl     volume,
  93                                 char             *location_id,
  94                                 XmString         *ret_title,
  95                                 XmFontList       *ret_list,
  96                                 Boolean          *ret_mod);
  97 extern  int              _DtHelpFormatVolumeTitle (
  98                                 XtPointer         client_data,
  99                                 _DtHelpVolumeHdl     volume,
 100                                 XmString         *ret_title,
 101                                 XmFontList       *ret_list,
 102                                 Boolean          *ret_mod);
 103 extern int              _DtHelpGetAsciiVolumeTitle (
 104                                 XtPointer            client_data,
 105                                 _DtHelpVolumeHdl      volume,
 106                                 char                **ret_title);
 107
 108 #endif /* _DtHelpFormatI_h */