dtcm: Coverity 89287
[oweals/cde.git] / cde / programs / dtwm / WmHelp.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 /* 
24  * (c) Copyright 1987, 1988, 1989, 1990, 1992 HEWLETT-PACKARD COMPANY 
25  * (c) Copyright 1989, 1990, 1991, 1992 OPEN SOFTWARE FOUNDATION, INC. 
26  * ALL RIGHTS RESERVED 
27 */ 
28
29 #include "WmGlobal.h"
30 /*
31  *    Various types of help available.
32  */
33
34 #define WM_DT_HELP_VOLUME                       "FPanel"
35 #define WM_DT_HELP_TOPIC                        "_HOMETOPIC"
36
37 #define WM_DT_WSRENAME_HELP_TOPIC               "WSRENAME"
38 #define WM_DT_WSRENAMEERROR_HELP_TOPIC          "WSRENAMEERROR"
39 #define WM_DT_ICONBOX_TOPIC                     "ICONBOX"
40 #define WM_DT_WSPRESENCE_TOPIC                  "WSPRESENCE"
41
42 typedef struct _WmHelpTopicData
43 {
44    char *helpVolume;
45    char *helpTopic;
46
47 } WmHelpTopicData;
48
49
50 /********    Public Function Declarations    ********/
51
52 extern Boolean RestoreHelpDialogs(
53                               WmScreenData *pSD);
54 extern void SaveHelpResources(
55                               WmScreenData *pSD);
56 extern Boolean WmDtHelp (
57                               String args);
58 extern Boolean WmDtHelpMode (
59                               void);
60 extern void WmDtHelpOnVersion (
61                                 Widget shell);
62 extern void WmDtStringHelpCB (Widget  theWidget,
63                                XtPointer  client_data,
64                                XtPointer  call_data );
65
66 extern void WmDtWmStringHelpCB (Widget  theWidget,
67                                XtPointer  client_data,
68                                XtPointer  call_data );
69
70 extern void WmDtDisplayTopicHelp (Widget widget,
71                                 char * helpVolume,
72                                 char * locationID);
73
74 extern void WmDtDisplayStringHelp (Widget widget,
75                                   char * helpString);
76
77 extern void WmDtWmTopicHelpCB (Widget  theWidget,
78                                XtPointer  client_data,
79                                XtPointer  call_data );
80
81 /********    End Public Function Declarations    ********/
82
83 /****************************   eof    ***************************/