resae.h

resae.h


// Apple events. Numbers below 4000 are taken by PowerPlant.

// Event command codes -- all suites are here to avoid conflict
#define AE_GetURL            4000   // GetURL
#define AE_Go               4001   // GoBack
#define AE_OpenURL            4002   // OpenURL
#define AE_RegisterViewer      4003   // RegisterViewer
#define AE_UnregisterViewer    4004   // UnregisterViewer
#define AE_ShowFile            4005   // ShowFile
#define AE_ParseAnchor         4006   // ParseAnchor
#define AE_RegisterURLEcho      4007   // Register URL echo
#define AE_UnregisterURLEcho   4008   // Unregister URL echo
#define AE_SpyActivate         4009   // Activate
#define AE_SpyListWindows      4010   // ListWindows
#define AE_GetWindowInfo      4011   // GetWindowInfo
#define AE_RegisterWinClose      4012   // RegisterWindowClose
#define AE_UnregisterWinClose   4013   // UnregisterWindowClose
#define AE_RegisterProtocol      4014   // RegisterProtocol
#define AE_UnregisterProtocol   4015   // UnregisterProtocol

#define AE_GetOption         4016   // GetOption   ее the option suite is not implemented yet ее
#define AE_SetOption         4017   // SetOption
#define AE_ListOptions         4018   // ListOptions

#define AE_CancelProgress      4025   // Cancel download
#define AE_FindURL            4028   // Find the URL for the file
// Events we send
#define AE_ViewDocFile         4019   // ViewDocFile
#define AE_BeginProgress      4020   // Begin progress
#define AE_SetProgressRange      4021   // Set progress range
#define AE_MakingProgress      4022   // Making progress
#define AE_EndProgress         4023   // End progress
#define AE_QueryViewer         4024   // Query viewer
#define AE_URLEcho            4026   // URL echo
#define AE_WindowClose         4027   // WindowClose


/*********************************************************************************
 * Netscape suite
 * Event: Go
 * Arguments: keyDirectObject (objectSpecifier for a window
 *            direction       (stil in flux, currently back, forward, home, and again)
 *                        should really be a history object
 *********************************************************************************/
// Event codes
#define AE_www_suite       'MOSS'

#define AE_www_go          'gogo'   // keyDirectObject HWIN, direction 'dire'
// direction can be kAENext, kAEPrevious, AE_www_go_again, AE_www_go_home
#define AE_www_go_direction 'dire'   // directions
#define AE_www_go_again    'agai'   // keyDirectObject HWIN 
#define AE_www_go_home      'home'   // keyDirectObject HWIN 

// Objects
#define AE_www_typeWindow   'HWIN'
// window properties
#define AE_www_typeWindowURL   'curl'   // Property: current URL
#define AE_www_typeWindowID   'wiid'   // unique ID
#define AE_www_typeWindowBusy 'busy'   // Are we busy
// application properties
#define AE_www_typeApplicationAlert 'ALAP'

/*********************************************************************************
 * URL suite
 * Standard Mac "GetURL suite, as defined by John Norstad and others
 * Look around ftp://ftp.acns.nwu.edu/pub/newswatcher/ for official spec
 * Event: GetURL
 * Arguments:    keyDirectObject (typeText, the url
 *               to (destination) (typeFSS optional file to save to)
 *            from (refererer) (typeText, the referer)
 *            with (window) (typeObjectSpec, the window)
 *********************************************************************************/
#define AE_url_suite      'GURL'

// Event codes
#define AE_url_getURL       'GURL'   // keyDirectObject typeChar URL, 
// AE_www_typeWindow window window   to load the url in
#define AE_url_getURLdestination 'dest'   
#define AE_url_getURLrefererer 'refe'

/*********************************************************************************
 * "Spyglass" suite
 * http://www.spyglass.com:4040/newtechnology/integration/iapi.htm
 *
 * Accepted events:
 * Event:   OpenURL
 * Arguments: 
 *         S: keyDirectObject typeChar the url
 *         S: typeFSS into
 *         S: typeLongInteger windowID (unique window ID for applescript)
 *         typeLongInteger flags -- unused
 *         S: typeWildCard post data -- you can post a form
 *         S: typeChar MIME type   -- for post. Defaults to application/x-www-form-urlencoded
 *         S: typePSN Progress app
 *   Reply:   windowID
 *
 * Event:   RegisterViewer
 * Arguments:
 *         keyDirectObject typeApplSignature
 *         typeChar      MIME type
 *   Reply:   bool success
 *
 * Event:   UnRegisterViewer
 *         keyDirectObject typeApplSignature
 *         typeChar      MIME type
 *   Reply:   none
 *
 * Event: RegisterURLEcho
 *          keyDirectObject typeApplSignature (optional). Otherwise, sender is used
 *   Reply:   typeBoolean on success, errAECoercionFail if already registered
 *
 * Event: UnregisterURLEcho
 *         keyDirectObject typeApplSignature (optional). Otherwise, sender is used
 *
 *  SENDING:
 * Event:   ViewDocFile
 * Arguments:
 *         keyDirectObject   typeAlias file spec
 *         typeChar   url
 *         typeChar   mime type
 *         typeLongInteger window id
 *   Reply:   none
 *
 * Event:   BeginProgress
 * Arguments:
 *         keyDirectObject typeLongInteger windowID
 *         typeChar message
 *  Reply:   typeLongInteger transactionID
 *
 * Event:   SetProgressRange
 * Arguments:
 *         keyDirectObject typeLongInteger transactionID
 *         typeLongInteger   max value. -1 if the value is unknown
 *  Reply:   none
 *
 * Event:   MakingProgress
 * Arguments:
 *         keyDirectObject typeLongInteger transactionID
 *         typeText message
 *         typeLongInteger current value of the transaction
 *   Reply: typeBoolean cancel
 *
 * Event:   EndProgress
 * Arguments:
 *         keyDirectObject typeLongInteger transactionID
 *   Reply: none
 *
 * Event:   QueryViewer
 * Arguments:
 *         keyDirectObject typeChar url
 *         typeChar MIME type
 *  Reply:   typeFSS fileSpec
 *
 * Event:   ShowFile
 * Arguments:
 *         keyDirectObject typeAlias -- the file
 *
 *********************************************************************************/
#define AE_spy_receive_suite      'WWW!'
#define AE_spy_send_suite         'WWW?'

// ===================== RECEIVING ==========================

// ================== Miscelaneous events

// ****************** OpenURL
#define AE_spy_openURL      'OURL'   // typeChar OpenURL
#define AE_spy_openURL_into 'INTO'   // typeFSS into
#define AE_spy_openURL_wind   'WIND'   // typeLongInteger windowID
#define AE_spy_openURL_flag 'FLGS'   // typeLongInteger flags
#define AE_spy_openURL_post   'POST'   // typeWildCard post data
#define AE_spy_openURL_mime 'MIME'   // typeChar MIME type
#define AE_spy_openURL_prog 'PROG'   // typePSN Progress app
// ****************** ShowFile
#define AE_spy_showFile      'SHWF'   // typeAlias file spec
#define AE_spy_showFile_mime 'MIME'   // typeChar MIME type
#define AE_spy_showFile_win   'WIND'   // WindowID
#define AE_spy_showFile_url 'URL '   // URL
// ****************** ParseAnchor
#define AE_spy_parse      'PRSA'   // typeChar main URL
#define AE_spy_parse_rel   'RELA'   // typeChar relative URL

// ****************** Progress (receiving)
#define AE_spy_CancelProgress 'CNCL' // typeLongInteger transactionID
#define AE_spy_CancelProgress_win 'WIND' // typeLongInteger windowID

// ****************** FindURL
#define AE_spy_findURL      'FURL'   // typeFSS file spec. Returns the URL of the file

// =================== Windows

// ****************** Activate
#define AE_spy_activate            'ACTV'   // typeLong window ID
#define AE_spy_activate_flags      'FLGS'   // typeLong unused flags
// ****************** ListWindows
#define AE_spy_listwindows         'LSTW'   // no arguments
// ****************** GetWindowInfo
#define AE_spy_getwindowinfo      'WNFO'   // typeLong window

//
// ================== Registration events
//

// ****************** RegisterURLEcho
#define AE_spy_registerURLecho      'RGUE'   // typeApplSignature application
// ****************** UnregisterURLEcho
#define AE_spy_unregisterURLecho   'UNRU'   // typeApplSignature application

// ****************** RegisterViewer
#define AE_spy_registerViewer      'RGVW'   //  typeSign   Application
#define AE_spy_registerViewer_mime   'MIME'   // typeChar      Mime type
#define AE_spy_registerViewer_flag   'MTHD'   // typeLongInteger Flags
#define AE_spy_registerViewer_ftyp   'FTYP'   // file type
// ****************** UnregisterViewer
#define AE_spy_unregisterViewer      'UNRV'   // typeApplSignature application
#define AE_spy_unregisterViewer_mime 'MIME'   // MIME type

// ****************** Register protocol
#define AE_spy_register_protocol      'RGPR'   // typeApplSignature application
#define AE_spy_register_protocol_pro    'PROT'   // typeChar protocol
// ****************** Unregister protocol
#define AE_spy_unregister_protocol      'UNRP'   // typeApplSignature application
#define AE_spy_register_protocol_pro    'PROT'   // typeChar protocol

// ****************** RegisterWindowClose
#define AE_spy_registerWinClose      'RGWC'   // typeApplSignature application
#define AE_spy_registerWinClose_win   'WIND'// typeLong window
// ****************** UnregisterWindowClose
#define AE_spy_unregisterWinClose      'UNRC'   // typeApplSignature application
#define AE_spy_unregisterWinClose_win   'WIND'// typeLong window


// ****************** SetOption
#define AE_spy_setOption         'SOPT'   // typeChar option name
#define AE_spy_setOption_value      'OPTV'   // type depends upon the option
// ****************** GetOption
#define AE_spy_getOption         'GOPT'   // typeChar option name
// ****************** ListOptions
#define AE_spy_listOptions         'LOPT'   // no arguments

//
// ===================== SENDING ============================
//
// ViewDocFile
#define AE_spy_viewDocFile         'VDOC'   // typeAlias   fileSpec
#define AE_spy_viewDocFile_url      'URL '   // typeChar   url
#define AE_spy_viewDocFile_mime      'MIME'   // typeChar mimeType
#define AE_spy_viewDocFile_wind      'WIND'   // typeLongInteger Window ID
// BeginProgress
#define AE_spy_beginProgress      'PRBG'   // typeLongInteger windowID
#define AE_spy_beginProgress_msg   'PMSG'   // typeChar message
// SetProgressRange
#define AE_spy_setProgressRange      'PRSR'   // typeLongInteger transactionID
#define AE_spy_setProgressRange_max 'MAXV'   // typeLongInteger max
// MakingProgress
#define AE_spy_makingProgress      'PRMK'   // typeLongInteger transactionID
#define AE_spy_makingProgress_msg   'PMSG'   // typeChar message
#define AE_spy_makingProgress_curr   'CURR'   // typeLongInteger current data size
// EndProgress
#define AE_spy_endProgress         'PREN'   // typeLongInteger transactionID
// QueryViewer
#define AE_spy_queryViewer         'QVWR'   // typeChar url
#define AE_spy_queryViewer_mime      'MIME'   // typeChar MIME type
// URLEcho
#define AE_spy_URLecho            'URLE'   // typeChar url
#define AE_spy_URLecho_mime         'MIME'   // typeChar MIME type
#define AE_spy_URLecho_win         'WIND'   // typeLongInt windowID
#define AE_spy_URLecho_referer      'RFRR'   // typeChar referer
// Window closed
#define AE_spy_winClosed         'WNDC'   // typeLong windowID
#define AE_spy_winClosedExiting      'EXIT'   // typeBoolean are we quitting?

PM.8/9/95 - 12:29.PM