source/help.h

   1 /* $Id: help.h,v 1.12 2004/07/21 11:32:05 yooden Exp $ */
   2 /*******************************************************************************
   3 *                                                                              *
   4 * help.h --  Nirvana Editor Help Display                                       *
   5 *                                                                              *
   6 * Copyright (c) 1999-2001 Mark Edel                                            *
   7 *                                                                              *
   8 * This is free software; you can redistribute it and/or modify it under the    *
   9 * terms of the GNU General Public License as published by the Free Software    *
  10 * Foundation; either version 2 of the License, or (at your option) any later   *
  11 * version. In addition, you may distribute version of this program linked to   *
  12 * Motif or Open Motif. See README for details.                                 *
  13 *                                                                              *
  14 * This software is distributed in the hope that it will be useful, but WITHOUT *
  15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or        *
  16 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License        *
  17 * for more details.                                                            *
  18 *                                                                              *
  19 * You should have received a copy of the GNU General Public License along with *
  20 * software; if not, write to the Free Software Foundation, Inc., 59 Temple     *
  21 * Place, Suite 330, Boston, MA  02111-1307 USA                                 *
  22 *                                                                              *
  23 * Nirvana Text Editor                                                          *
  24 * September 10, 1991                                                           *
  25 *                                                                              *
  26 * Written by Mark Edel                                                         *
  27 *                                                                              *
  28 *******************************************************************************/
  29
  30 #ifndef NEDIT_HELP_H_INCLUDED
  31 #define NEDIT_HELP_H_INCLUDED
  32
  33 #include "help_topic.h"
  34
  35 #include <X11/Intrinsic.h>
  36
  37 /*============================================================================*/
  38 /*                          VARIABLE TYPE DEFINITIONS                         */
  39 /*============================================================================*/
  40
  41 typedef struct HelpMenu         /* Maintains help menu structure */
  42 {
  43     struct HelpMenu * next;
  44     int               level;    /* menu level, submenu > 1               */
  45     enum HelpTopic    topic;    /* HELP_none for submenu & separator     */
  46     char            * wgtName;
  47     int               hideIt;   /* value which determines displayability */
  48     char              mnemonic; /* '-' for separator                     */
  49     char            * subTitle; /* title for sub menu, or NULL           */
  50
  51 } HelpMenu;
  52
  53 typedef struct Href             /* Source to topic internal hyperlinks */
  54 {
  55     struct Href *  next;
  56     int            location;    /* position to link in topic    */
  57     enum HelpTopic topic;       /* target of link in this topic */
  58     char *         source;      /* hypertext link characters    */
  59     char *         target;      /* hypertext target characters  */
  60
  61 } Href;
  62
  63 /*============================================================================*/
  64 /*                             VARIABLE DECLARATIONS                          */
  65 /*============================================================================*/
  66
  67 extern HelpMenu H_M[];
  68 extern char *HelpTitles[];
  69 extern const char linkdate[];
  70 extern const char linktime[];
  71
  72 /*============================================================================*/
  73 /*                             PROGRAM PROTOTYPES                             */
  74 /*============================================================================*/
  75
  76 void Help(enum HelpTopic topic);
  77 void PrintVersion(void);
  78 void InstallHelpLinkActions(XtAppContext context);
  79
  80 #endif /* NEDIT_HELP_H_INCLUDED */