source/help.h

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