AppleEvents.h File Reference

AppleEvent Package Interfaces. More...

#include <MacTypes.h>
#include <MixedMode.h>
#include <AEDataModel.h>
#include <AEInteraction.h>

Go to the source code of this file.

Typedefs
typedef SInt8	AEEventSource

Enumerations
enum	{   keyDirectObject = FOUR_CHAR_CODE('----') , keyErrorNumber = FOUR_CHAR_CODE('errn') , keyErrorString = FOUR_CHAR_CODE('errs') , keyProcessSerialNumber ,   keyPreDispatch = FOUR_CHAR_CODE('phac') , keySelectProc = FOUR_CHAR_CODE('selh') , keyAERecorderCount , keyAEVersion }
enum	{ kCoreEventClass = FOUR_CHAR_CODE('aevt') }
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 }
enum	{   kAEStartRecording , kAEStopRecording , kAENotifyStartRecording , kAENotifyStopRecording ,   kAENotifyRecording }
enum	{   kAEUnknownSource = 0 , kAEDirectCall = 1 , kAESameProcess = 2 , kAELocalProcess = 3 ,   kAERemoteProcess = 4 }

Functions
OSErr	AEInstallEventHandler (AEEventClass theAEEventClass, AEEventID theAEEventID, AEEventHandlerUPP handler, long handlerRefcon, Boolean isSysHandler)
OSErr	AERemoveEventHandler (AEEventClass theAEEventClass, AEEventID theAEEventID, AEEventHandlerUPP handler, Boolean isSysHandler)
OSErr	AEGetEventHandler (AEEventClass theAEEventClass, AEEventID theAEEventID, AEEventHandlerUPP *handler, long *handlerRefcon, Boolean isSysHandler)
OSErr	AEInstallSpecialHandler (AEKeyword functionClass, AEEventHandlerUPP handler, Boolean isSysHandler)
OSErr	AERemoveSpecialHandler (AEKeyword functionClass, AEEventHandlerUPP handler, Boolean isSysHandler)
OSErr	AEGetSpecialHandler (AEKeyword functionClass, AEEventHandlerUPP *handler, Boolean isSysHandler)
OSErr	AEManagerInfo (AEKeyword keyWord, long *result)

Detailed Description

AppleEvent Package Interfaces.

Introduced In: System 7.5

Avaliable From: Universal Interfaces 3.4.1

Copyright: © 1989-2001 by Apple Computer, Inc., all rights reserved

For bug reports, consult the following page on the World Wide Web:

http://developer.apple.com/bugreporter/

Typedef Documentation

AEEventSource

typedef SInt8 AEEventSource

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.

Enumeration Type Documentation

anonymous enum

anonymous enum

Note: The functions and types for the building and parsing AppleEvent messages has moved to AEDataModel.h Note: The functions for interacting with events has moved to AEInteraction.h

Enumerator
keyDirectObject	Keywords for Apple event parameters
keyPreDispatch	Keywords for special handlers
keySelectProc	preHandler accessor call
keyAERecorderCount	more selector call Keyword for recording
keyAEVersion	available only in vers 1.0.1 and greater Keyword for version information

anonymous enum

anonymous enum

Event Class

anonymous enum

anonymous enum

Event ID©s

anonymous enum

anonymous enum

Constants for recording

Enumerator
kAEStopRecording	available only in vers 1.0.1 and greater
kAENotifyStartRecording	available only in vers 1.0.1 and greater
kAENotifyStopRecording	available only in vers 1.0.1 and greater
kAENotifyRecording	available only in vers 1.0.1 and greater

Function Documentation

AEGetEventHandler()

OSErr AEGetEventHandler	(	AEEventClass	theAEEventClass,
		AEEventID	theAEEventID,
		AEEventHandlerUPP *	handler,
		long *	handlerRefcon,
		Boolean	isSysHandler
	)

AEGetEventHandler()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

AEGetSpecialHandler()

OSErr AEGetSpecialHandler	(	AEKeyword	functionClass,
		AEEventHandlerUPP *	handler,
		Boolean	isSysHandler
	)

AEGetSpecialHandler()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

AEInstallEventHandler()

OSErr AEInstallEventHandler	(	AEEventClass	theAEEventClass,
		AEEventID	theAEEventID,
		AEEventHandlerUPP	handler,
		long	handlerRefcon,
		Boolean	isSysHandler
	)

AEInstallEventHandler()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

AEInstallSpecialHandler()

OSErr AEInstallSpecialHandler	(	AEKeyword	functionClass,
		AEEventHandlerUPP	handler,
		Boolean	isSysHandler
	)

AEInstallSpecialHandler()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

AEManagerInfo()

OSErr AEManagerInfo	(	AEKeyword	keyWord,
		long *	result
	)

AEManagerInfo()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

AERemoveEventHandler()

OSErr AERemoveEventHandler	(	AEEventClass	theAEEventClass,
		AEEventID	theAEEventID,
		AEEventHandlerUPP	handler,
		Boolean	isSysHandler
	)

AERemoveEventHandler()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later

AERemoveSpecialHandler()

OSErr AERemoveSpecialHandler	(	AEKeyword	functionClass,
		AEEventHandlerUPP	handler,
		Boolean	isSysHandler
	)

AERemoveSpecialHandler()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: in CarbonLib 1.0 and later

Mac OS X: in version 10.0 and later