cde/lib/DtHelp/FormatCCDFI.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: FormatCCDFI.h /main/5 1995/10/26 12:20:47 rswiston $ */
  24 /************************************<+>*************************************
  25  ****************************************************************************
  26  **
  27  **   File:        FormatCCDFI.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 #ifndef _DtHelpFormatCCDFI_h
  45 #define _DtHelpFormatCCDFI_h
  46
  47 typedef void*   VarHandle;
  48
  49 extern  int             _DtHelpCeGetCcdfTitleChunks(
  50                                 _DtHelpVolumeHdl        volume,
  51                                 char            *loc_id,
  52                                 _FrmtUiInfo             *ui_info,
  53                                 void            ***ret_chunks);
  54 extern  int             _DtHelpCeFrmtCcdfPathAndChildren(
  55                                 _DtHelpVolumeHdl         volume,
  56                                 char                 *loc_id,
  57                                 _FrmtUiInfo             *ui_info,
  58                                 _DtCvTopicPtr          *ret_handle );
  59 extern  int             _DtHelpCeGetCcdfVolTitleChunks(
  60                                 _DtHelpVolumeHdl         volume,
  61                                 _FrmtUiInfo             *ui_info,
  62                                 void            ***ret_chunks);
  63 extern  int             _DtHelpCeFrmtCcdfTopic (
  64                                 _DtHelpVolumeHdl volume,
  65                                 char          *filename,
  66                                 int            offset,
  67                                 char          *id_string,
  68                                 _FrmtUiInfo     *ui_info,
  69                                 _DtCvTopicPtr   *ret_topic);
  70 extern  int             __DtHelpCeGetParagraphList (
  71                                 VarHandle        var_handle,
  72                                 int              make_cont,
  73                                 _DtCvFrmtOption  type,
  74                                 _DtCvTopicPtr   *ret_handle);
  75 extern  int             __DtHelpCeProcessString(
  76                                 VarHandle         var_handle,
  77                                 BufFilePtr        my_file,
  78                                 _DtCvFrmtOption   frmt_type,
  79                                 char             *scan_string,
  80                                 char             *in_string,
  81                                 int               in_size,
  82                                 int               fnt_flags,
  83                                 int               ret_on_nl,
  84                                 _DtHelpFontHints *font_attr);
  85 extern  VarHandle       __DtHelpCeSetUpVars (
  86                                 char            *lang,
  87                                 char            *code_set,
  88                                 _FrmtUiInfo     *ui_info);
  89
  90 #endif /* _DtHelpFormatCCDFI_h */