1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/* ncbimsg.h
* ===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's official duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
* File Name: ncbimsg.h
*
* Author: Gish, Kans, Ostell, Schuler
*
* Version Creation Date: 1/1/91
*
* $Revision: 6.0 $
*
* File Description:
* prototypes for message and alert handling
*
* Modifications:
* --------------------------------------------------------------------------
* Date Name Description of modification
* ------- ---------- -----------------------------------------------------
* 04-15-93 Schuler Changed _cdecl to LIBCALL
* 05-28-93 Schuler New function: SetMonitorHook()
* 06-09-93 Schuler Added magic_value field to Monitor
* 01-13-94 Schuler Added SetMsgHook and SetBeepHook
* 08-23-94 Schuler Workaround for Win32 Beep conflict
*
* $Log: ncbimsg.h,v $
* Revision 6.0 1997/08/25 18:16:54 madden
* Revision changed to 6.0
*
* Revision 5.2 1996/12/03 21:48:33 vakatov
* Adopted for 32-bit MS-Windows DLLs
*
* Revision 5.1 1996/07/05 16:26:10 kans
* changed MonitorXXNew functions to MonitorXXXNewEx, with new hasCancelBtn
* parameter, defined old functions to call new ones with hasCancelBtn TRUE.
*
* Revision 5.0 1996/05/28 13:18:57 ostell
* Set to revision 5.0
*
* Revision 4.0 1995/07/26 13:46:50 ostell
* force revision to 4.0
*
* Revision 2.11 1995/06/05 18:28:32 kans
* *** empty log message ***
*
* Revision 2.10 1995/05/15 18:45:58 ostell
* added Log line
*
*
*
* ==========================================================================
*/
#ifndef _NCBIMSG_
#define _NCBIMSG_
#include <ncbierr.h>
#undef NLM_EXTERN
#ifdef NLM_IMPORT
#define NLM_EXTERN NLM_IMPORT
#else
#define NLM_EXTERN extern
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*************************************************************************\
| ALERTS |
\*************************************************************************/
typedef enum MsgKey
{
KEY_NONE =0,
KEY_OK,
KEY_OKC,
KEY_ARI,
KEY_YNC,
KEY_YN,
KEY_RC,
KEY_other
}
MsgKey;
#define MSG_OK KEY_OK
#define MSG_OKC KEY_OKC
#define MSG_ARI KEY_ARI
#define MSG_YNC KEY_YNC
#define MSG_YN KEY_YN
#define MSG_RC KEY_RC
#define MSG_ERROR (KEY_other +1)
#define MSG_FATAL (KEY_other +2)
#define MSG_POST (KEY_other +3)
#define MSG_POSTERR (KEY_other +4)
/* Message response codes */
typedef enum MsgAnswser
{
ANS_NONE,
ANS_OK,
ANS_CANCEL,
ANS_ABORT,
ANS_RETRY,
ANS_IGNORE,
ANS_YES,
ANS_NO
}
MsgAnswer;
NLM_EXTERN MsgAnswer CDECL Nlm_Message VPROTO((Nlm_Int2 keysev, const char *fmt, ...));
NLM_EXTERN MsgAnswer CDECL Nlm_MsgAlert VPROTO((MsgKey key, ErrSev sev,
const char *caption, const char *fmt, ...));
NLM_EXTERN MsgAnswer LIBCALL Nlm_MsgAlertStr PROTO((MsgKey key, ErrSev sev,
const char *caption, const char *message));
typedef MsgAnswer (LIBCALLBACK *MessageHook) PROTO((MsgKey key, ErrSev sev,
const char *caption, const char *message));
NLM_EXTERN MessageHook LIBCALL Nlm_SetMessageHook PROTO((MessageHook hook));
#define Message Nlm_Message
#define MsgAlert Nlm_MsgAlert
#define MsgAlertStr Nlm_MsgAlertStr
#define SetMessageHook Nlm_SetMessageHook
/*************************************************************************\
| BEEPS |
\*************************************************************************/
typedef void (LIBCALLBACK *BeepHook) PROTO((void));
NLM_EXTERN void LIBCALL Nlm_Beep PROTO((void));
NLM_EXTERN BeepHook LIBCALL Nlm_SetBeepHook PROTO((BeepHook));
/*** MsgBeep is the preferred alias because there is a Win32 API
called Beep. Beep is undefined prior to including windows.h
in ncbiwin.h. Also Beep is not defined here if already defined
elsewhere (incase you include windows.h first) ***/
#define MsgBeep Nlm_Beep
#ifndef Beep
#define Beep Nlm_Beep
#endif
#define SetBeepHook Nlm_SetBeepHook
/*************************************************************************\
| PROGRESS MONITORS |
\*************************************************************************/
/* Monitor type codes */
typedef enum _MonType_
{
MonType_Int =1, MonType_Str
}
MonType;
/* Monitor notification codes */
typedef enum _MonCode_
{
MonCode_Create=1,
MonCode_Destroy,
MonCode_IntValue,
MonCode_StrValue
}
MonCode;
typedef struct _Monitor_
{
MonType type;
const char *strTitle;
long intValue;
const char *strValue;
long num1;
long num2;
void *extra; /* hook function may put things here */
int cancel;
int magic_value; /* check for invalid object */
int hasCancelBtn;
}
Nlm_Monitor, *Nlm_MonitorPtr;
#define Monitor Nlm_Monitor
#define MonitorPtr Nlm_MonitorPtr
typedef int (LIBCALLBACK *Nlm_MonitorHook) PROTO((Nlm_MonitorPtr pMon, MonCode code));
#define MonitorHook Nlm_MonitorHook
NLM_EXTERN MonitorPtr LIBCALL Nlm_MonitorIntNewEx PROTO((Nlm_CharPtr title, Nlm_Int4 n1, Nlm_Int4 n2, Nlm_Boolean hasCancelBtn));
NLM_EXTERN MonitorPtr LIBCALL Nlm_MonitorStrNewEx PROTO((Nlm_CharPtr title, Nlm_Int2 len, Nlm_Boolean hasCancelBtn));
NLM_EXTERN Nlm_Boolean LIBCALL Nlm_MonitorStrValue PROTO((MonitorPtr mon, Nlm_CharPtr sval));
NLM_EXTERN Nlm_Boolean LIBCALL Nlm_MonitorIntValue PROTO((MonitorPtr mon, Nlm_Int4 ival));
NLM_EXTERN MonitorPtr LIBCALL Nlm_MonitorFree PROTO((MonitorPtr mon));
NLM_EXTERN MonitorHook LIBCALL Nlm_SetMonitorHook PROTO((MonitorHook hook));
#define MonitorIntNewEx Nlm_MonitorIntNewEx
#define MonitorStrNewEx Nlm_MonitorStrNewEx
#define MonitorStrValue Nlm_MonitorStrValue
#define MonitorIntValue Nlm_MonitorIntValue
#define MonitorFree Nlm_MonitorFree
#define SetMonitorHook Nlm_SetMonitorHook
#define MonitorIntNew(a,b,c) Nlm_MonitorIntNewEx(a, b, c, TRUE)
#define Nlm_MonitorIntNew(a,b,c) Nlm_MonitorIntNewEx(a, b, c, TRUE)
#define MonitorStrNew(a,b) Nlm_MonitorStrNewEx(a, b, TRUE)
#define Nlm_MonitorStrNew(a,b) Nlm_MonitorStrNewEx(a, b, TRUE)
/*****************************************************************************
*
* Default Monitor
*
*****************************************************************************/
typedef Nlm_Boolean (LIBCALLBACK * Nlm_ProgMonFunc) PROTO((Nlm_VoidPtr data, Nlm_CharPtr str));
NLM_EXTERN Nlm_Boolean LIBCALL Nlm_ProgMon PROTO((Nlm_CharPtr str));
NLM_EXTERN Nlm_Boolean LIBCALL Nlm_SetProgMon PROTO((Nlm_ProgMonFunc func, Nlm_VoidPtr data));
NLM_EXTERN Nlm_Boolean LIBCALLBACK Nlm_StdProgMon PROTO((Nlm_VoidPtr data, Nlm_CharPtr str));
#define ProgMonFunc Nlm_ProgMonFunc
#define ProgMon Nlm_ProgMon
#define SetProgMon Nlm_SetProgMon
#define StdProgMon Nlm_StdProgMon
#ifdef __cplusplus
}
#endif
#undef NLM_EXTERN
#ifdef NLM_EXPORT
#define NLM_EXTERN NLM_EXPORT
#else
#define NLM_EXTERN
#endif
#endif
|