summaryrefslogtreecommitdiff
path: root/common/quicktime_win32/AppleEvents.h
blob: adf8f84ebc9f55112b6a92c98c12132820c8d694 (plain) (blame)
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
/*
     File:       AppleEvents.h
 
     Contains:   AppleEvent Package Interfaces.
 
     Version:    QuickTime 7.3
 
     Copyright:  (c) 2007 (c) 1989-2001 by Apple Computer, Inc., all rights reserved
 
     Bugs?:      For bug reports, consult the following page on
                 the World Wide Web:
 
                     http://developer.apple.com/bugreporter/
 
*/
#ifndef __APPLEEVENTS__
#define __APPLEEVENTS__

#ifndef __MACTYPES__
#include <MacTypes.h>
#endif

#ifndef __MIXEDMODE__
#include <MixedMode.h>
#endif

/*
    Note:   The functions and types for the building and parsing AppleEvent  
            messages has moved to AEDataModel.h
*/
#ifndef __AEDATAMODEL__
#include <AEDataModel.h>
#endif


/*Note: The functions for interacting with events has moved to AEInteraction.h*/


#if PRAGMA_ONCE
#pragma once
#endif

#ifdef __cplusplus
extern "C" {
#endif

#if PRAGMA_IMPORT
#pragma import on
#endif

enum {
                                        /* Keywords for Apple event parameters */
  keyDirectObject               = FOUR_CHAR_CODE('----'),
  keyErrorNumber                = FOUR_CHAR_CODE('errn'),
  keyErrorString                = FOUR_CHAR_CODE('errs'),
  keyProcessSerialNumber        = FOUR_CHAR_CODE('psn '), /* Keywords for special handlers */
  keyPreDispatch                = FOUR_CHAR_CODE('phac'), /* preHandler accessor call */
  keySelectProc                 = FOUR_CHAR_CODE('selh'), /* more selector call */
                                        /* Keyword for recording */
  keyAERecorderCount            = FOUR_CHAR_CODE('recr'), /* available only in vers 1.0.1 and greater */
                                        /* Keyword for version information */
  keyAEVersion                  = FOUR_CHAR_CODE('vers') /* available only in vers 1.0.1 and greater */
};

/* Event Class */
enum {
  kCoreEventClass               = FOUR_CHAR_CODE('aevt')
};

/* Event ID's */
enum {
  kAEOpenApplication            = FOUR_CHAR_CODE('oapp'),
  kAEOpenDocuments              = FOUR_CHAR_CODE('odoc'),
  kAEPrintDocuments             = FOUR_CHAR_CODE('pdoc'),
  kAEQuitApplication            = FOUR_CHAR_CODE('quit'),
  kAEAnswer                     = FOUR_CHAR_CODE('ansr'),
  kAEApplicationDied            = FOUR_CHAR_CODE('obit'),
  kAEShowPreferences            = FOUR_CHAR_CODE('pref') /* sent by Mac OS X when the user chooses the Preferences item */
};

/* Constants for recording */
enum {
  kAEStartRecording             = FOUR_CHAR_CODE('reca'), /* available only in vers 1.0.1 and greater */
  kAEStopRecording              = FOUR_CHAR_CODE('recc'), /* available only in vers 1.0.1 and greater */
  kAENotifyStartRecording       = FOUR_CHAR_CODE('rec1'), /* available only in vers 1.0.1 and greater */
  kAENotifyStopRecording        = FOUR_CHAR_CODE('rec0'), /* available only in vers 1.0.1 and greater */
  kAENotifyRecording            = FOUR_CHAR_CODE('recr') /* available only in vers 1.0.1 and greater */
};





/*
 * AEEventSource is defined as an SInt8 for compatability with pascal.
 * Important note: keyEventSourceAttr is returned by AttributePtr as a typeShortInteger.
 * Be sure to pass at least two bytes of storage to AEGetAttributePtr - the result can be
 * compared directly against the following enums.
 */
typedef SInt8 AEEventSource;
enum {
  kAEUnknownSource              = 0,
  kAEDirectCall                 = 1,
  kAESameProcess                = 2,
  kAELocalProcess               = 3,
  kAERemoteProcess              = 4
};

/**************************************************************************
  These calls are used to set up and modify the event dispatch table.
**************************************************************************/
/*
 *  AEInstallEventHandler()
 *  
 *  Availability:
 *    Non-Carbon CFM:   in InterfaceLib 7.1 and later
 *    CarbonLib:        in CarbonLib 1.0 and later
 *    Mac OS X:         in version 10.0 and later
 */
EXTERN_API( OSErr )
AEInstallEventHandler(
  AEEventClass        theAEEventClass,
  AEEventID           theAEEventID,
  AEEventHandlerUPP   handler,
  long                handlerRefcon,
  Boolean             isSysHandler)                           THREEWORDINLINE(0x303C, 0x091F, 0xA816);


/*
 *  AERemoveEventHandler()
 *  
 *  Availability:
 *    Non-Carbon CFM:   in InterfaceLib 7.1 and later
 *    CarbonLib:        in CarbonLib 1.0 and later
 *    Mac OS X:         in version 10.0 and later
 */
EXTERN_API( OSErr )
AERemoveEventHandler(
  AEEventClass        theAEEventClass,
  AEEventID           theAEEventID,
  AEEventHandlerUPP   handler,
  Boolean             isSysHandler)                           THREEWORDINLINE(0x303C, 0x0720, 0xA816);


/*
 *  AEGetEventHandler()
 *  
 *  Availability:
 *    Non-Carbon CFM:   in InterfaceLib 7.1 and later
 *    CarbonLib:        in CarbonLib 1.0 and later
 *    Mac OS X:         in version 10.0 and later
 */
EXTERN_API( OSErr )
AEGetEventHandler(
  AEEventClass         theAEEventClass,
  AEEventID            theAEEventID,
  AEEventHandlerUPP *  handler,
  long *               handlerRefcon,
  Boolean              isSysHandler)                          THREEWORDINLINE(0x303C, 0x0921, 0xA816);




/**************************************************************************
  These calls are used to set up and modify special hooks into the
  AppleEvent manager.
**************************************************************************/
/*
 *  AEInstallSpecialHandler()
 *  
 *  Availability:
 *    Non-Carbon CFM:   in InterfaceLib 7.1 and later
 *    CarbonLib:        in CarbonLib 1.0 and later
 *    Mac OS X:         in version 10.0 and later
 */
EXTERN_API( OSErr )
AEInstallSpecialHandler(
  AEKeyword           functionClass,
  AEEventHandlerUPP   handler,
  Boolean             isSysHandler)                           THREEWORDINLINE(0x303C, 0x0500, 0xA816);


/*
 *  AERemoveSpecialHandler()
 *  
 *  Availability:
 *    Non-Carbon CFM:   in InterfaceLib 7.1 and later
 *    CarbonLib:        in CarbonLib 1.0 and later
 *    Mac OS X:         in version 10.0 and later
 */
EXTERN_API( OSErr )
AERemoveSpecialHandler(
  AEKeyword           functionClass,
  AEEventHandlerUPP   handler,
  Boolean             isSysHandler)                           THREEWORDINLINE(0x303C, 0x0501, 0xA816);


/*
 *  AEGetSpecialHandler()
 *  
 *  Availability:
 *    Non-Carbon CFM:   in InterfaceLib 7.1 and later
 *    CarbonLib:        in CarbonLib 1.0 and later
 *    Mac OS X:         in version 10.0 and later
 */
EXTERN_API( OSErr )
AEGetSpecialHandler(
  AEKeyword            functionClass,
  AEEventHandlerUPP *  handler,
  Boolean              isSysHandler)                          THREEWORDINLINE(0x303C, 0x052D, 0xA816);



/**************************************************************************
  This call was added in version 1.0.1. If called with the keyword
  keyAERecorderCount ('recr'), the number of recorders that are
  currently active is returned in 'result'
  (available only in vers 1.0.1 and greater).
**************************************************************************/
/*
 *  AEManagerInfo()
 *  
 *  Availability:
 *    Non-Carbon CFM:   in InterfaceLib 7.1 and later
 *    CarbonLib:        in CarbonLib 1.0 and later
 *    Mac OS X:         in version 10.0 and later
 */
EXTERN_API( OSErr )
AEManagerInfo(
  AEKeyword   keyWord,
  long *      result)                                         THREEWORDINLINE(0x303C, 0x0441, 0xA816);







#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif

#ifdef __cplusplus
}
#endif

#endif /* __APPLEEVENTS__ */