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