HTMLRendering.h

Go to the documentation of this file.

 
#ifndef __HTMLRENDERING__
#define __HTMLRENDERING__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __QUICKDRAW__
#include <Quickdraw.h>
#endif
 
#ifndef __EVENTS__
#include <Events.h>
#endif
 
#ifndef __FILES__
#include <Files.h>
#endif
 
#ifndef __CODEFRAGMENTS__
#include <CodeFragments.h>
#endif
 
#ifndef __CONTROLS__
#include <Controls.h>
#endif
 
#ifndef __CFDATA__
#include <CFData.h>
#endif
 
#ifndef __CFSTRING__
#include <CFString.h>
#endif
 
#ifndef __CFURL__
#include <CFURL.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
 
  typedef struct OpaqueHRReference *HRReference;
  OSStatus
  HRGetHTMLRenderingLibVersion(NumVersion *returnVers);
 
#if TARGET_RT_MAC_CFM
#ifdef __cplusplus
  inline pascal Boolean HRHTMLRenderingLibAvailable()
  {
    return (
        (HRGetHTMLRenderingLibVersion != (void *)kUnresolvedCFragSymbolAddress));
  }
#else
#define HRHTMLRenderingLibAvailable() \
  ((HRGetHTMLRenderingLibVersion != (void *)kUnresolvedCFragSymbolAddress))
#endif
#elif TARGET_RT_MAC_MACHO
#ifdef __cplusplus
inline pascal Boolean HRHTMLRenderingLibAvailable() { return true; }
#else
#define HRHTMLRenderingLibAvailable() (true)
#endif
#endif 
  enum
  {
    kHRRendererHTML32Type = FOUR_CHAR_CODE('ht32') 
  };
 
  OSStatus
  HRNewReference(HRReference *hrRef, OSType rendererType, GrafPtr grafPtr);
 
  OSStatus
  HRNewReferenceInWindow(HRReference *hrRef, OSType rendererType,
                         WindowRef inWindowRef);
 
  OSStatus
  HRDisposeReference(HRReference hrRef);
 
  SInt32
  HRFreeMemory(Size inBytesNeeded);
 
  void
  HRScreenConfigurationChanged(void);
 
  Boolean
  HRIsHREvent(const EventRecord *eventRecord);
 
  OSStatus
  HRSetGrafPtr(HRReference hrRef, GrafPtr grafPtr);
 
  OSStatus
  HRSetWindowRef(HRReference hrRef, WindowRef windowRef);
 
  OSStatus
  HRSetEmbeddingControl(HRReference hrRef, ControlRef controlRef);
 
  OSStatus
  HRActivate(HRReference hrRef);
 
  OSStatus
  HRDeactivate(HRReference hrRef);
 
  OSStatus
  HRDraw(HRReference hrRef, RgnHandle updateRgnH);
 
  OSStatus
  HRDrawInPort(HRReference hrRef, RgnHandle updateRgnH, CGrafPtr grafPtr);
 
  OSStatus
  HRSetRenderingRect(HRReference hrRef, const Rect *renderingRect);
 
  OSStatus
  HRGetRenderedImageSize(HRReference hrRef, Point *renderingSize);
 
  OSStatus
  HRGetRenderedImageSize32(HRReference hrRef, UInt32 *height, UInt32 *width);
 
  OSStatus
  HRScrollToLocation(HRReference hrRef, Point *location);
 
  OSStatus
  HRScrollToImageLocation32(HRReference hrRef, SInt32 h, SInt32 v);
 
  OSStatus
  HRForceQuickdraw(HRReference hrRef, Boolean forceQuickdraw);
 
  typedef SInt16 HRScrollbarState;
  enum
  {
    eHRScrollbarOn = 0,
    eHRScrollbarOff = 1,
    eHRScrollbarAuto = 2
  };
 
  OSStatus
  HRSetScrollbarState(HRReference hrRef, HRScrollbarState hScrollbarState,
                      HRScrollbarState vScrollbarState);
 
  OSStatus
  HRSetDrawBorder(HRReference hrRef, Boolean drawBorder);
 
  OSStatus
  HRSetGrowboxCutout(HRReference hrRef, Boolean allowCutout);
 
  OSStatus
  HRGoToFile(HRReference hrRef, const FSSpec *fsspec, Boolean addToHistory,
             Boolean forceRefresh);
 
  OSStatus
  HRGoToURL(HRReference hrRef, const char *url, Boolean addToHistory,
            Boolean forceRefresh);
 
  OSStatus
  HRGoToAnchor(HRReference hrRef, const char *anchorName);
 
  OSStatus
  HRGoToPtr(HRReference hrRef, char *buffer, UInt32 bufferSize,
            Boolean addToHistory, Boolean forceRefresh);
 
  OSStatus
  HRGoToFSRef(HRReference hrRef, const FSRef *fref, Boolean addToHistory,
              Boolean forceRefresh);
 
  OSStatus
  HRGoToCFURL(HRReference hrRef, CFURLRef url, Boolean addToHistory,
              Boolean forceRefresh);
 
  OSStatus
  HRGoToAnchorCFString(HRReference hrRef, CFStringRef anchorName);
 
  OSStatus
  HRGoToData(HRReference hrRef, CFDataRef data, Boolean addToHistory,
             Boolean forceRefresh);
 
  OSStatus
  HRGetRootURL(HRReference hrRef, Handle rootURLH);
 
  OSStatus
  HRGetBaseURL(HRReference hrRef, Handle baseURLH);
 
  OSStatus
  HRGetHTMLURL(HRReference hrRef, Handle HTMLURLH);
 
  OSStatus
  HRGetTitle(HRReference hrRef, StringPtr title);
 
  OSStatus
  HRGetHTMLFile(HRReference hrRef, FSSpec *fsspec);
 
  OSStatus
  HRGetRootURLAsCFString(HRReference hrRef, CFStringRef *rootString);
 
  OSStatus
  HRGetBaseURLAsCFString(HRReference hrRef, CFStringRef *baseString);
 
  OSStatus
  HRGetHTMLURLAsCFURL(HRReference hrRef, CFURLRef *theURL);
 
  OSStatus
  HRGetTitleAsCFString(HRReference hrRef, CFStringRef *title);
 
  OSStatus
  HRGetHTMLFileAsFSRef(HRReference hrRef, FSRef *fref);
 
  OSStatus
  HRUtilCreateFullURL(const char *rootURL, const char *linkURL, Handle fullURLH);
 
  OSStatus
  HRUtilGetFSSpecFromURL(const char *rootURL, const char *linkURL,
                         FSSpec *destSpec);
 
  OSStatus
  HRUtilGetURLFromFSSpec(const FSSpec *fsspec, Handle urlHandle);
 
  OSStatus
  HRUtilCreateFullCFURL(CFStringRef rootString, CFStringRef linkString,
                        CFURLRef *url);
 
  OSStatus
  HRUtilGetFSRefFromURL(CFStringRef rootString, CFStringRef linkString,
                        FSRef *destRef);
 
  OSStatus
  HRUtilGetURLFromFSRef(const FSRef *fileRef, CFURLRef *url);
 
  typedef CALLBACK_API(Boolean, HRWasURLVisitedProcPtr)(const char *url,
                                                        void *refCon);
  typedef STACK_UPP_TYPE(HRWasURLVisitedProcPtr) HRWasURLVisitedUPP;
  void
  HRRegisterWasURLVisitedUPP(HRWasURLVisitedUPP inWasURLVisitedUPP,
                             HRReference hrRef, void *inRefCon);
 
  void
  HRUnregisterWasURLVisitedUPP(HRReference hrRef);
 
  typedef CALLBACK_API(Boolean, HRWasCFURLVisitedProcPtr)(CFURLRef url,
                                                          void *refCon);
  typedef TVECTOR_UPP_TYPE(HRWasCFURLVisitedProcPtr) HRWasCFURLVisitedUPP;
  void
  HRRegisterWasCFURLVisitedUPP(HRWasCFURLVisitedUPP inWasCFURLVisitedUPP,
                               HRReference hrRef, void *inRefCon);
 
  void
  HRUnregisterWasCFURLVisitedUPP(HRReference hrRef);
 
  typedef CALLBACK_API(OSStatus,
                       HRNewURLProcPtr)(const char *url, const char *targetFrame,
                                        Boolean addToHistory, void *refCon);
  typedef STACK_UPP_TYPE(HRNewURLProcPtr) HRNewURLUPP;
  void
  HRRegisterNewURLUPP(HRNewURLUPP inNewURLUPP, HRReference hrRef, void *inRefCon);
 
  void
  HRUnregisterNewURLUPP(HRReference hrRef);
 
  typedef CALLBACK_API(OSStatus,
                       HRNewCFURLProcPtr)(CFURLRef url, CFStringRef targetString,
                                          Boolean addToHistory, void *refCon);
  typedef TVECTOR_UPP_TYPE(HRNewCFURLProcPtr) HRNewCFURLUPP;
  void
  HRRegisterNewCFURLUPP(HRNewCFURLUPP inURLUPP, HRReference hrRef,
                        void *inRefCon);
 
  void
  HRUnregisterNewCFURLUPP(HRReference hrRef);
 
  typedef UInt16 URLSourceType;
  enum
  {
    kHRLookingForHTMLSource = 1,
    kHRLookingForImage = 2,
    kHRLookingForEmbedded = 3,
    kHRLookingForImageMap = 4,
    kHRLookingForFrame = 5
  };
 
  typedef CALLBACK_API(OSStatus,
                       HRURLToFSSpecProcPtr)(const char *rootURL,
                                             const char *linkURL, FSSpec *fsspec,
                                             URLSourceType urlSourceType,
                                             void *refCon);
  typedef STACK_UPP_TYPE(HRURLToFSSpecProcPtr) HRURLToFSSpecUPP;
  void
  HRRegisterURLToFSSpecUPP(HRURLToFSSpecUPP inURLToFSSpecUPP, HRReference hrRef,
                           void *inRefCon);
 
  void
  HRUnregisterURLToFSSpecUPP(HRReference hrRef);
 
  typedef CALLBACK_API(OSStatus, HRURLToFSRefProcPtr)(CFStringRef rootString,
                                                      CFStringRef linkString,
                                                      FSRef *fref,
                                                      URLSourceType urlSourceType,
                                                      void *refCon);
  typedef TVECTOR_UPP_TYPE(HRURLToFSRefProcPtr) HRURLToFSRefUPP;
  void
  HRRegisterURLToFSRefUPP(HRURLToFSRefUPP inURLToFSRefUPP, HRReference hrRef,
                          void *inRefCon);
 
  void
  HRUnregisterURLToFSRefUPP(HRReference hrRef);
 
  HRWasURLVisitedUPP
  NewHRWasURLVisitedUPP(HRWasURLVisitedProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppHRWasURLVisitedProcInfo = 0x000003D0
  }; 
#ifdef __cplusplus
  inline HRWasURLVisitedUPP
  NewHRWasURLVisitedUPP(HRWasURLVisitedProcPtr userRoutine)
  {
    return (HRWasURLVisitedUPP)NewRoutineDescriptor((ProcPtr)(userRoutine),
                                                    uppHRWasURLVisitedProcInfo,
                                                    GetCurrentArchitecture());
  }
#else
#define NewHRWasURLVisitedUPP(userRoutine)                                     \
  (HRWasURLVisitedUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppHRWasURLVisitedProcInfo, \
                           GetCurrentArchitecture())
#endif
#endif
 
  HRWasCFURLVisitedUPP
  NewHRWasCFURLVisitedUPP(HRWasCFURLVisitedProcPtr userRoutine);
 
  HRNewURLUPP
  NewHRNewURLUPP(HRNewURLProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppHRNewURLProcInfo = 0x000037F0
  }; 
#ifdef __cplusplus
  inline HRNewURLUPP NewHRNewURLUPP(HRNewURLProcPtr userRoutine)
  {
    return (HRNewURLUPP)NewRoutineDescriptor(
        (ProcPtr)(userRoutine), uppHRNewURLProcInfo, GetCurrentArchitecture());
  }
#else
#define NewHRNewURLUPP(userRoutine)   \
  (HRNewURLUPP) NewRoutineDescriptor( \
      (ProcPtr)(userRoutine), uppHRNewURLProcInfo, GetCurrentArchitecture())
#endif
#endif
 
  HRNewCFURLUPP
  NewHRNewCFURLUPP(HRNewCFURLProcPtr userRoutine);
 
  HRURLToFSSpecUPP
  NewHRURLToFSSpecUPP(HRURLToFSSpecProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppHRURLToFSSpecProcInfo = 0x0000EFF0
  }; 
#ifdef __cplusplus
  inline HRURLToFSSpecUPP NewHRURLToFSSpecUPP(HRURLToFSSpecProcPtr userRoutine)
  {
    return (HRURLToFSSpecUPP)NewRoutineDescriptor((ProcPtr)(userRoutine),
                                                  uppHRURLToFSSpecProcInfo,
                                                  GetCurrentArchitecture());
  }
#else
#define NewHRURLToFSSpecUPP(userRoutine)                                     \
  (HRURLToFSSpecUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppHRURLToFSSpecProcInfo, \
                           GetCurrentArchitecture())
#endif
#endif
 
  HRURLToFSRefUPP
  NewHRURLToFSRefUPP(HRURLToFSRefProcPtr userRoutine);
 
  void
  DisposeHRWasURLVisitedUPP(HRWasURLVisitedUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeHRWasURLVisitedUPP(HRWasURLVisitedUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeHRWasURLVisitedUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  DisposeHRWasCFURLVisitedUPP(HRWasCFURLVisitedUPP userUPP);
 
  void
  DisposeHRNewURLUPP(HRNewURLUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeHRNewURLUPP(HRNewURLUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeHRNewURLUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  DisposeHRNewCFURLUPP(HRNewCFURLUPP userUPP);
 
  void
  DisposeHRURLToFSSpecUPP(HRURLToFSSpecUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeHRURLToFSSpecUPP(HRURLToFSSpecUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeHRURLToFSSpecUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  DisposeHRURLToFSRefUPP(HRURLToFSRefUPP userUPP);
 
  Boolean
  InvokeHRWasURLVisitedUPP(const char *url, void *refCon,
                           HRWasURLVisitedUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline Boolean InvokeHRWasURLVisitedUPP(const char *url, void *refCon,
                                          HRWasURLVisitedUPP userUPP)
  {
    return (Boolean)CALL_TWO_PARAMETER_UPP(userUPP, uppHRWasURLVisitedProcInfo,
                                           url, refCon);
  }
#else
#define InvokeHRWasURLVisitedUPP(url, refCon, userUPP)                    \
  (Boolean) CALL_TWO_PARAMETER_UPP((userUPP), uppHRWasURLVisitedProcInfo, \
                                   (url), (refCon))
#endif
#endif
 
  Boolean
  InvokeHRWasCFURLVisitedUPP(CFURLRef url, void *refCon,
                             HRWasCFURLVisitedUPP userUPP);
 
  OSStatus
  InvokeHRNewURLUPP(const char *url, const char *targetFrame,
                    Boolean addToHistory, void *refCon, HRNewURLUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline OSStatus InvokeHRNewURLUPP(const char *url, const char *targetFrame,
                                    Boolean addToHistory, void *refCon,
                                    HRNewURLUPP userUPP)
  {
    return (OSStatus)CALL_FOUR_PARAMETER_UPP(userUPP, uppHRNewURLProcInfo, url,
                                             targetFrame, addToHistory, refCon);
  }
#else
#define InvokeHRNewURLUPP(url, targetFrame, addToHistory, refCon, userUPP)  \
  (OSStatus) CALL_FOUR_PARAMETER_UPP((userUPP), uppHRNewURLProcInfo, (url), \
                                     (targetFrame), (addToHistory), (refCon))
#endif
#endif
 
  OSStatus
  InvokeHRNewCFURLUPP(CFURLRef url, CFStringRef targetString,
                      Boolean addToHistory, void *refCon, HRNewCFURLUPP userUPP);
 
  OSStatus
  InvokeHRURLToFSSpecUPP(const char *rootURL, const char *linkURL, FSSpec *fsspec,
                         URLSourceType urlSourceType, void *refCon,
                         HRURLToFSSpecUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline OSStatus InvokeHRURLToFSSpecUPP(const char *rootURL, const char *linkURL,
                                         FSSpec *fsspec,
                                         URLSourceType urlSourceType,
                                         void *refCon, HRURLToFSSpecUPP userUPP)
  {
    return (OSStatus)CALL_FIVE_PARAMETER_UPP(userUPP, uppHRURLToFSSpecProcInfo,
                                             rootURL, linkURL, fsspec,
                                             urlSourceType, refCon);
  }
#else
#define InvokeHRURLToFSSpecUPP(rootURL, linkURL, fsspec, urlSourceType,       \
                               refCon, userUPP)                               \
  (OSStatus)                                                                  \
      CALL_FIVE_PARAMETER_UPP((userUPP), uppHRURLToFSSpecProcInfo, (rootURL), \
                              (linkURL), (fsspec), (urlSourceType), (refCon))
#endif
#endif
 
  OSStatus
  InvokeHRURLToFSRefUPP(CFStringRef rootString, CFStringRef linkString,
                        FSRef *fref, URLSourceType urlSourceType, void *refCon,
                        HRURLToFSRefUPP userUPP);
 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
#define NewHRWasURLVisitedProc(userRoutine) NewHRWasURLVisitedUPP(userRoutine)
#define NewHRNewURLProc(userRoutine) NewHRNewURLUPP(userRoutine)
#define NewHRURLToFSSpecProc(userRoutine) NewHRURLToFSSpecUPP(userRoutine)
#define CallHRWasURLVisitedProc(userRoutine, url, refCon) \
  InvokeHRWasURLVisitedUPP(url, refCon, userRoutine)
#define CallHRNewURLProc(userRoutine, url, targetFrame, addToHistory, refCon) \
  InvokeHRNewURLUPP(url, targetFrame, addToHistory, refCon, userRoutine)
#define CallHRURLToFSSpecProc(userRoutine, rootURL, linkURL, fsspec,      \
                              urlSourceType, refCon)                      \
  InvokeHRURLToFSSpecUPP(rootURL, linkURL, fsspec, urlSourceType, refCon, \
                         userRoutine)
#endif 
#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