AppleEvents.h

Go to the documentation of this file.

 
#ifndef __APPLEEVENTS__
#define __APPLEEVENTS__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __MIXEDMODE__
#include <MixedMode.h>
#endif
 
#ifndef __AEDATAMODEL__
#include <AEDataModel.h>
#endif
 
#ifndef __AEINTERACTION__
#include <AEInteraction.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
    enum
    {
        keyDirectObject = FOUR_CHAR_CODE('----'),
        keyErrorNumber = FOUR_CHAR_CODE('errn'),
        keyErrorString = FOUR_CHAR_CODE('errs'),
        keyProcessSerialNumber =
            FOUR_CHAR_CODE('psn '),              
        keyPreDispatch = FOUR_CHAR_CODE('phac'), 
        keySelectProc = FOUR_CHAR_CODE('selh'),  
        keyAERecorderCount =
            FOUR_CHAR_CODE('recr'), 
        keyAEVersion =
            FOUR_CHAR_CODE('vers') 
    };
 
    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 = FOUR_CHAR_CODE(
            'pref') 
    };
 
    enum
    {
        kAEStartRecording =
            FOUR_CHAR_CODE('reca'), 
        kAEStopRecording =
            FOUR_CHAR_CODE('recc'), 
        kAENotifyStartRecording =
            FOUR_CHAR_CODE('rec1'), 
        kAENotifyStopRecording =
            FOUR_CHAR_CODE('rec0'), 
        kAENotifyRecording =
            FOUR_CHAR_CODE('recr') 
    };
 
    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.
    **************************************************************************/
    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);
 
    /***************************************************************************
      These calls are used to set up and modify special hooks into the
      AppleEvent manager.
    **************************************************************************/
    OSErr
    AEInstallSpecialHandler(AEKeyword functionClass, AEEventHandlerUPP handler,
                            Boolean isSysHandler);
 
    OSErr
    AERemoveSpecialHandler(AEKeyword functionClass, AEEventHandlerUPP handler,
                           Boolean isSysHandler);
 
    OSErr
    AEGetSpecialHandler(AEKeyword functionClass, AEEventHandlerUPP *handler,
                        Boolean isSysHandler);
 
    /***************************************************************************
      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).
    **************************************************************************/
    OSErr
    AEManagerInfo(AEKeyword keyWord, long *result);
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif