cde/programs/dtpad/help.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: help.h /main/4 1996/04/16 16:42:05 mgreess $ */
  24 /**********************************<+>*************************************
  25 ***************************************************************************
  26 **
  27 **  File:        help.h
  28 **
  29 **  Project:     DT dtpad, a memo maker type editor based on the Dt Editor
  30 **               widget.
  31 **
  32 **  Description:
  33 **  -----------
  34 **  This is the header file for the help related portions of dtpad.
  35 **  It provides the help volume name and location ids for the various
  36 **  help volume entry points accessed via the help callbacks in helpCB.c.
  37 **
  38 **  For example, in the line
  39 **
  40 **      #define FILE_MENU_HELP                  "fileMenu"
  41 **
  42 **  FILE_MENU_HELP is used in helpCB.c to display help for the [File] pulldown
  43 **  menu which is found in the dtpad help volume immediately following the
  44 **  "tag":
  45 **
  46 **      <location id=fileMenu>&empty;<\location>
  47 **
  48 **
  49 *******************************************************************
  50 **  (c) Copyright Hewlett-Packard Company, 1992.  All rights are
  51 **  reserved.  Copying or other reproduction of this program
  52 **  except for archival purposes is prohibited without prior
  53 **  written consent of Hewlett-Packard Company.
  54 ********************************************************************
  55 **
  56 ********************************************************************
  57 **  (c) Copyright 1993, 1994 Hewlett-Packard Company
  58 **  (c) Copyright 1993, 1994 International Business Machines Corp.
  59 **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
  60 **  (c) Copyright 1993, 1994 Novell, Inc.
  61 ********************************************************************
  62 **
  63 **
  64 **************************************************************************
  65 **********************************<+>*************************************/
  66
  67 /************************************************************************
  68  * Default Text Editor help volume name
  69  ************************************************************************/
  70 #define TEXTEDITOR_HELP_VOLUME                  "Textedit"
  71 #define HELP_ON_HELP_VOLUME                     "Help4Help"
  72
  73
  74 /************************************************************************
  75  * Help location ids for the menubar
  76  ************************************************************************/
  77 #define MENUBAR_HELP                            "menubar"
  78
  79
  80 /************************************************************************
  81  * Help location ids for pulldown menus within the menubar
  82  ************************************************************************/
  83
  84 #define FILE_MENU_HELP                          "TextEditorFileMenu"
  85 #define EDIT_MENU_HELP                          "TextEditorEditMenu"
  86 #define OPTIONS_MENU_HELP                       "TextEditorOptionsMenu"
  87 #define HELP_MENU_HELP                          "TextEditorHelpMenu"
  88 #define FORMAT_MENU_HELP                        "formatMenu"
  89
  90
  91 /************************************************************************
  92  * Help location ids for individual items within the [Help] pulldown menu
  93  ************************************************************************/
  94 #define HELP_MENU_OVERVIEW_HELP                 "_hometopic"
  95 #define HELP_MENU_TASKS_HELP                    "Tasks"
  96 #define HELP_MENU_TOC_HELP                      "TableOfContents"
  97 #define HELP_MENU_REFERENCE_HELP                "Reference"
  98 /* 'XmNActivateCallback' for [On Item] does not set a specific location id */
  99 /* the HELP_MENU_USING_HELP_HELP location id is for the HELP_ON_HELP_VOLUME */
 100 #define HELP_MENU_USING_HELP_HELP               "_hometopic"
 101 #define HELP_MENU_ABOUT_HELP                    "_copyright"
 102
 103
 104 /************************************************************************
 105  * Help location ids for dialogs posted directly or indirectly by [File]
 106  * menu items
 107  ************************************************************************/
 108 #define FILE_OPEN_DIALOG_HELP                   "openDialog"
 109 #define FILE_INCLUDE_DIALOG_HELP                "includeDialog"
 110 #define FILE_SAVEAS_DIALOG_HELP                 "saveAsDialog"
 111 #define FILE_COPYTOFILE_DIALOG_HELP             "copytofileDialog"
 112 /* [Print...] causes a separate process to be invoked with its own help */
 113
 114 /* -----> dialogs conditionally posted as the result of a [File] menu action */
 115 #define FILE_ASKIFSAVE_DIALOG_HELP              "askIfSaveDialog"
 116 #define FILE_EXISTS_DIALOG_HELP                 "fileExistsDialog"
 117 #define FILE_CONFIRM_DIALOG_HELP                "fileConfirmDialog"
 118
 119
 120 /************************************************************************
 121  * Help location ids for the dialog posted by [File] menu [Print...]
 122  * (this dialog is controlled by the DtPrintSetupBox widget)
 123  ************************************************************************/
 124 #define PRINT_SETUP_DIALOG_HELP                 "printSetupDialog"
 125
 126 /* -----> fields/buttons within the Print Setup dialog */
 127 #define PRINT_APP_SPECIFIC_OPTIONS              "print-appSpecific"
 128 #define PRINT_GENERIC_OPTIONS                   "print-generic"
 129 #define PRINT_PAGE_HEADERS_FOOTERS              "print-pageHeadersFooters"
 130 #define PRINT_PAGE_MARGINS                      "print-pageMargins"
 131
 132
 133 /************************************************************************
 134  * Help location ids for edit area and status line of the DtEditor widget
 135  ************************************************************************/
 136 #define EDIT_AREA_HELP                          "TextEditorWindow"
 137
 138 /* -----> fields/buttons within the status line */
 139 #define STATUS_LINE_HELP                        "statusLine"
 140 #define STATUS_CURRENT_LINE_HELP                "status-currentLine"
 141 #define STATUS_TOTAL_LINES_HELP                 "status-totalLines"
 142 #define STATUS_MESSAGE_HELP                     "status-message"
 143 #define STATUS_OVERSTRIKE_HELP                  "status-overstrike"
 144
 145
 146 /************************************************************************
 147  * Help location ids for the dialog posted by [Format] menu [Settings...]
 148  * (this dialog is controlled by the DtEditor widget)
 149  ************************************************************************/
 150 #define FORMAT_SETTINGS_HELP                    "formatDialog"
 151
 152 /* -----> fields/buttons within the Format Settings dialog */
 153 #define FORMAT_LEFT_MARGIN_HELP                 "format-leftmargin"
 154 #define FORMAT_RIGHT_MARGIN_HELP                "format-rightmargin"
 155 #define FORMAT_ALIGNMENT_HELP                   "format-alignment"
 156
 157
 158 /************************************************************************
 159  * Help location ids for the dialog posted by [Edit] menu [Find/Change...]
 160  * (this dialog is controlled by the DtEditor widget)
 161  ************************************************************************/
 162 #define FINDCHANGE_HELP                         "findchangeDialog"
 163
 164 /* -----> fields/buttons within the Find/Change dialog */
 165 #define FINDCHANGE_FIND_HELP                    "fc-find"
 166 #define FINDCHANGE_CHANGETO_HELP                "fc-changeto"
 167
 168
 169 /************************************************************************
 170  * Help location ids for the dialog posted by [Edit] menu [Find/Change...]
 171  * (this dialog is controlled by the DtEditor widget)
 172  ************************************************************************/
 173 #define SPELL_HELP                              "spellDialog"
 174
 175 /* -----> fields/buttons within the Check Spelling dialog */
 176 #define SPELL_MISSPELLED_WORDS_HELP             "sp-spelllist"
 177 #define SPELL_CHANGETO_HELP                     "sp-changeto"