cde/programs/dtfile/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 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: Help.h /main/4 1995/11/02 14:39:56 rswiston $ */
  24 /************************************<+>*************************************
  25  ****************************************************************************
  26  *
  27  *   FILE:           Help.h
  28  *
  29  *   COMPONENT_NAME: Desktop File Manager
  30  *
  31  *   DESCRIPTION:    dtfile help defines
  32  *
  33  *   (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company
  34  *   (c) Copyright 1993, 1994, 1995 International Business Machines Corp.
  35  *   (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.
  36  *   (c) Copyright 1993, 1994, 1995 Novell, Inc.
  37  *
  38  ****************************************************************************
  39  ************************************<+>*************************************/
  40
  41 #ifndef _VF_Help_h
  42 #define _VF_Help_h
  43
  44
  45 #define MAIN_HELP_DIALOG    0
  46 #define HYPER_HELP_DIALOG   1
  47
  48 extern DialogClass * helpClass;
  49
  50
  51 typedef struct
  52 {
  53    Boolean       displayed;
  54    Position      x;
  55    Position      y;
  56    Dimension     width;
  57    Dimension     height;
  58
  59    String        idString;
  60    String        volString;
  61    String        topicTitle;
  62    String        fileType;
  63    int           helpType;
  64 } HelpData, * HelpDataPtr;
  65
  66
  67 typedef struct
  68 {
  69    Widget    shell;
  70    Widget    helpDialog;
  71 } HelpRec;
  72
  73
  74
  75 extern void HelpRequestCB(
  76                         Widget w,
  77                         XtPointer clientData,
  78                         XtPointer callData) ;
  79 extern void DTHelpRequestCB(
  80                         Widget w,
  81                         XtPointer clientData,
  82                         XtPointer callData) ;
  83 extern void TrashHelpRequestCB(
  84                         Widget w,
  85                         XtPointer clientData,
  86                         XtPointer callData) ;
  87 extern void ShowHelpDialog(
  88                         Widget parentShell,
  89                         XtPointer topLevelRec,
  90                         int dialogType,
  91                         DialogData *dialogData,
  92                         char *idString,
  93                         char *volString,
  94                         char *topicTitle,
  95                         char *fileType,
  96                         int helpType) ;
  97 extern void ShowTrashHelpDialog(
  98                         Widget parentShell,
  99                         int dialogType,
 100                         DialogData *dialogData,
 101                         char *idString,
 102                         char *volString) ;
 103 extern void ShowDTHelpDialog(
 104                         Widget parentShell,
 105                         int workspaceNum,
 106                         int dialogType,
 107                         DialogData *dialogData,
 108                         char *idString,
 109                         char *volString,
 110                         char *topicTitle,
 111                         char *fileType,
 112                         int helpType) ;
 113 extern XtPointer MapFileTypeToHelpString (
 114                         String filetype,
 115                         String topicTitle) ;
 116
 117 extern void ObjectHelp(
 118                         Widget w,
 119                         XtPointer clientData,
 120                         XtPointer callData) ;
 121
 122 extern void closeCB_mainHelpDialog(
 123                         Widget wid,
 124                         XtPointer client_data,
 125                         XtPointer cbs) ;
 126
 127
 128
 129 /* Help defines for Trash.c */
 130 #define HELP_TRASH_DIALOG_STR "FMTrashDialogDE"
 131
 132 /* Help defines for ChangeDir.c */
 133 #define HELP_CHANGEDIR_DIALOG_STR "FMChangeToDialogDE"
 134
 135 /* Help defines for File.c */
 136 #define HELP_NAMECHANGE_DIALOG_STR "FileManagerNameChangeDialog"
 137
 138 /* Help defines for the File Manager Popup ... File.c */
 139 #define HELP_POPUP_MENU_STR "FMPopupMenuDE"
 140
 141 /* Help defines for the Desktop popup */
 142 #define HELP_DESKTOP_POPUP_MENU_STR "FMDesktopMenuDE"
 143
 144 /* Help defines for FileDialog.c (move) */
 145 #define HELP_MOVE_DIALOG_STR "FMMoveDialogDE"
 146
 147 /* Help defines for FileDialog.c (copy) */
 148 #define HELP_COPY_DIALOG_STR "FMCopyDialogDE"
 149
 150 /* Help defines for FileDialog.c (link) */
 151 #define HELP_LINK_DIALOG_STR "FMCopyLinkDialogDE"
 152
 153 /* Help defines for FileDialog.c (create) */
 154 #define HELP_CREATE_FILE_DIALOG_STR "FMCreateFileDialogDE"
 155 #define HELP_CREATE_DIR_DIALOG_STR "FMCreateFolderDialogDE"
 156
 157 /* Help defines for FileMgr.c */
 158 #define HELP_FILE_MANAGER_VIEW_STR "FMDirectoryViewDE"
 159
 160 /* Help defines for FileOp.c */
 161 #define HELP_FILE_MANAGER_REP_REN "FMCopyWarnRenDialogDE"
 162 #define HELP_FILE_MANAGER_REP_MRG "FMCopyWarnMrgDialogDE"
 163 #define HELP_FILE_MANAGER_MULTI   "FMCopyWarnMultiDialogDE"
 164
 165 /* Help defines for Filter.c */
 166 #define HELP_FILTER_DIALOG_STR "FMFilterDialogDE"
 167
 168 /* Help defines for Find.c */
 169 #define HELP_FIND_DIALOG_STR "FMFindDialogDE"
 170
 171 /* Help defines for Menu.c */
 172 #define HELP_FILE_MENU_STR "FMFileMenuDE"
 173 #define HELP_SELECTED_MENU_STR "FMActionsMenuDE"
 174 #define HELP_VIEW_MENU_STR "FMViewMenuDE"
 175 #define HELP_HELP_MENU_STR "FMHelpMenuDE"
 176 #define HELP_RENAME_COMMAND_STR "FileManagerRenameCommand"
 177 #define HELP_MOVE_AS_COMMAND_STR "FileManagerMoveCommand"
 178 #define HELP_COPY_AS_COMMAND_STR "FileManagerCopyAsCommand"
 179 #define HELP_LINK_AS_COMMAND_STR "FileManagerLinkCommand"
 180 #define HELP_PROPERTIES_COMMAND_STR "FileManagerPropertiesCommand"
 181 #define HELP_PUT_ON_DT_COMMAND_STR "FileManagerPutOnDTCommand"
 182
 183 #define HELP_TRASH_FILES_COMMAND_STR "FileManagerTrashFilesCommand"
 184 #define HELP_REREAD_COMMAND_STR "FileManagerRereadCommand"
 185 #define HELP_FAST_CHANGE_TO_COMMAND_STR "FileManagerFastChangeToCommand"
 186 #define HELP_CHANGE_TO_COMMAND_STR "FileManagerChangeToCommand"
 187 #define HELP_NEW_VIEW_COMMAND_STR "FMViewMenuDE"
 188 #define HELP_CLEAN_UP_COMMAND_STR "FileManagerCleanUpCommand"
 189 #define HELP_SELECT_ALL_COMMAND_STR "FileManagerSelectAllCommand"
 190 #define HELP_UNSELECT_ALL_COMMAND_STR "FileManagerUnselectAllCommand"
 191 #define HELP_SHOW_HIDDEN_COMMAND_STR "FileManagerShowHiddenCommand"
 192 #define HELP_PREFERENCES_COMMAND_STR "FileManagerPreferencesCommand"
 193 #define HELP_FILTER_COMMAND_STR "FileManagerFilterCommand"
 194 #define HELP_SAVE_SETTINGS_COMMAND_STR "FileManagerSaveSettingsCommand"
 195 #define HELP_HOME_TOPIC "_HOMETOPIC"
 196 #define HELP_TASKS_STR "Tasks"
 197 #define HELP_REFERENCE_STR "Reference"
 198 #define HELP_HELP_MODE_STR "FileManagerHelpMode"
 199 #define HELP_USING_STR "_HOMETOPIC"
 200 #define HELP_ABOUT_STR "_COPYRIGHT"
 201 #define HELP_TOC_STR "TOC"
 202 #define HELP_TRASH_OVERVIEW_TOPIC_STR "ToOpenTheTrashCanTA"
 203 #define HELP_TRASH_TASKS_TOPIC_STR "ToDeleteAnObjectTA"
 204
 205 /* Help defines for ModAttr.c */
 206 #define HELP_PROPERTIES_DIALOG_STR "FMPropertiesDialogDE"
 207
 208 /* Help defines for Prefs.c */
 209 #define HELP_PREFERENCES_DIALOG_STR "FMPreferencesDialogDE"
 210 #define HELP_PREFERENCES_HEADERS_STR "FileManagerPrefHeadersOptions"
 211 #define HELP_PREFERENCES_PLACEMENT_STR "FileManagerPrefPlacementOptions"
 212 #define HELP_PREFERENCES_VIEW_STR "FileManagerPrefViewOptions"
 213 #define HELP_PREFERENCES_SHOW_STR "FileManagerPrefShowOptions"
 214 #define HELP_PREFERENCES_ORDER_STR "FileManagerPrefOrderOptions"
 215 #define HELP_PREFERENCES_DIRECTION_STR "FileManagerPrefDirectionOptions"
 216
 217 #endif /* _VF_Help_h */
 218 /* DON'T ADD ANYTHING AFTER THIS #endif */