|
Mac OS 9
|
HTML Rendering Library Interfaces. More...
#include <MacTypes.h>#include <Quickdraw.h>#include <Events.h>#include <Files.h>#include <CodeFragments.h>#include <Controls.h>#include <CFData.h>#include <CFString.h>#include <CFURL.h>Go to the source code of this file.
Macros | |
| #define | NewHRWasURLVisitedUPP(userRoutine) |
| #define | NewHRNewURLUPP(userRoutine) |
| #define | NewHRURLToFSSpecUPP(userRoutine) |
| #define | DisposeHRWasURLVisitedUPP(userUPP) DisposeRoutineDescriptor(userUPP) |
| #define | DisposeHRNewURLUPP(userUPP) DisposeRoutineDescriptor(userUPP) |
| #define | DisposeHRURLToFSSpecUPP(userUPP) DisposeRoutineDescriptor(userUPP) |
| #define | InvokeHRWasURLVisitedUPP(url, refCon, userUPP) |
| #define | InvokeHRNewURLUPP(url, targetFrame, addToHistory, refCon, userUPP) |
| #define | InvokeHRURLToFSSpecUPP(rootURL, linkURL, fsspec, urlSourceType, refCon, userUPP) |
| #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) |
Typedefs | |
| typedef struct OpaqueHRReference * | HRReference |
| typedef SInt16 | HRScrollbarState |
| typedef void * | refCon |
| typedef const char * | targetFrame |
| typedef const char Boolean | addToHistory |
| typedef CFStringRef | targetString |
| typedef UInt16 | URLSourceType |
| typedef const char * | linkURL |
| typedef const char FSSpec * | fsspec |
| typedef const char FSSpec URLSourceType | urlSourceType |
| typedef CFStringRef | linkString |
| typedef CFStringRef FSRef * | fref |
Functions | |
| OSStatus | HRGetHTMLRenderingLibVersion (NumVersion *returnVers) |
| 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) |
| 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 |
| 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 |
| 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 |
| 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 |
| typedef | TVECTOR_UPP_TYPE (HRNewCFURLProcPtr) HRNewCFURLUPP |
| void | HRRegisterNewCFURLUPP (HRNewCFURLUPP inURLUPP, HRReference hrRef, void *inRefCon) |
| void | HRUnregisterNewCFURLUPP (HRReference hrRef) |
| typedef | CALLBACK_API (OSStatus, HRURLToFSSpecProcPtr)(const char *rootURL |
| 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 |
| typedef | TVECTOR_UPP_TYPE (HRURLToFSRefProcPtr) HRURLToFSRefUPP |
| void | HRRegisterURLToFSRefUPP (HRURLToFSRefUPP inURLToFSRefUPP, HRReference hrRef, void *inRefCon) |
| void | HRUnregisterURLToFSRefUPP (HRReference hrRef) |
| HRWasURLVisitedUPP | NewHRWasURLVisitedUPP (HRWasURLVisitedProcPtr userRoutine) |
| HRWasCFURLVisitedUPP | NewHRWasCFURLVisitedUPP (HRWasCFURLVisitedProcPtr userRoutine) |
| HRNewURLUPP | NewHRNewURLUPP (HRNewURLProcPtr userRoutine) |
| HRNewCFURLUPP | NewHRNewCFURLUPP (HRNewCFURLProcPtr userRoutine) |
| HRURLToFSSpecUPP | NewHRURLToFSSpecUPP (HRURLToFSSpecProcPtr userRoutine) |
| HRURLToFSRefUPP | NewHRURLToFSRefUPP (HRURLToFSRefProcPtr userRoutine) |
| void | DisposeHRWasURLVisitedUPP (HRWasURLVisitedUPP userUPP) |
| void | DisposeHRWasCFURLVisitedUPP (HRWasCFURLVisitedUPP userUPP) |
| void | DisposeHRNewURLUPP (HRNewURLUPP userUPP) |
| void | DisposeHRNewCFURLUPP (HRNewCFURLUPP userUPP) |
| void | DisposeHRURLToFSSpecUPP (HRURLToFSSpecUPP userUPP) |
| void | DisposeHRURLToFSRefUPP (HRURLToFSRefUPP userUPP) |
| Boolean | InvokeHRWasURLVisitedUPP (const char *url, void *refCon, HRWasURLVisitedUPP userUPP) |
| Boolean | InvokeHRWasCFURLVisitedUPP (CFURLRef url, void *refCon, HRWasCFURLVisitedUPP userUPP) |
| OSStatus | InvokeHRNewURLUPP (const char *url, const char *targetFrame, Boolean addToHistory, void *refCon, HRNewURLUPP userUPP) |
| 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) |
| OSStatus | InvokeHRURLToFSRefUPP (CFStringRef rootString, CFStringRef linkString, FSRef *fref, URLSourceType urlSourceType, void *refCon, HRURLToFSRefUPP userUPP) |
HTML Rendering Library Interfaces.
For bug reports, consult the following page on the World Wide Web:
http://developer.apple.com/bugreporter/
| #define CallHRURLToFSSpecProc | ( | userRoutine, | |
| rootURL, | |||
| linkURL, | |||
| fsspec, | |||
| urlSourceType, | |||
| refCon | |||
| ) |
| #define InvokeHRNewURLUPP | ( | url, | |
| targetFrame, | |||
| addToHistory, | |||
| refCon, | |||
| userUPP | |||
| ) |
| #define InvokeHRURLToFSSpecUPP | ( | rootURL, | |
| linkURL, | |||
| fsspec, | |||
| urlSourceType, | |||
| refCon, | |||
| userUPP | |||
| ) |
| #define InvokeHRWasURLVisitedUPP | ( | url, | |
| refCon, | |||
| userUPP | |||
| ) |
| #define NewHRNewURLUPP | ( | userRoutine | ) |
pascal 4_bytes Func(4_bytes, 4_bytes, 1_byte, 4_bytes)
| #define NewHRURLToFSSpecUPP | ( | userRoutine | ) |
pascal 4_bytes Func(4_bytes, 4_bytes, 4_bytes, 2_bytes, 4_bytes)
| #define NewHRWasURLVisitedProc | ( | userRoutine | ) | NewHRWasURLVisitedUPP(userRoutine) |
support for pre-Carbon UPP routines: New...Proc and Call...Proc
| #define NewHRWasURLVisitedUPP | ( | userRoutine | ) |
pascal 1_byte Func(4_bytes, 4_bytes)
| typedef UInt16 URLSourceType |
URL to FSSpec function
If you register a function here, it will be called every time the renderer is going to locate a file. The function will be passed an enum indicating the type of file being asked for.
| typedef CALLBACK_API | ( | Boolean | , |
| HRWasCFURLVisitedProcPtr | |||
| ) |
Use these API from a Carbon App instead of using HRRegisterWasURLVisitedUPP, HRUnregisterWasURLVisitedUPP. These APIs are same in behavior with their old counter parts. The only difference is that they take CFURLRef as parameters.
| typedef CALLBACK_API | ( | Boolean | , |
| HRWasURLVisitedProcPtr | |||
| ) | const |
Visited links
If you register a function here, it will be called to determine whether or not the given URL has been visited. It should return true if the URL has been visited.
In addition to the URLs that the application may add to the list of visited links, it should also add URLs that the user clicks on. These URLs can be caught by the "add URL to history" callback below.
| typedef CALLBACK_API | ( | OSStatus | , |
| HRNewCFURLProcPtr | |||
| ) |
Use these API from a Carbon App instead of using HRRegisterNewURLUPP, HRUnregisterNewURLUPP. These APIs are same in behavior with their old counter parts. The only difference is that they take CFURLRef as parameters.
| typedef CALLBACK_API | ( | OSStatus | , |
| HRNewURLProcPtr | |||
| ) | const |
New URL
If you register a function here, it will be called every time the renderer is going to display a new URL. A few examples of how you might use this include...
(a) maintaining a history of URLs (b) maintainging a list of visited links (c) setting a window title based on the new URL
| typedef CALLBACK_API | ( | OSStatus | , |
| HRURLToFSRefProcPtr | |||
| ) |
Use these API from a Carbon App instead of using HRRegisterURLToFSSpecUPP, HRUnregisterURLToFSSpecUPP. These APIs are same in behavior with their old counter parts. The only difference is that they take FSRef as parameters.
| void DisposeHRNewCFURLUPP | ( | HRNewCFURLUPP | userUPP | ) |
| void DisposeHRNewURLUPP | ( | HRNewURLUPP | userUPP | ) |
| void DisposeHRURLToFSRefUPP | ( | HRURLToFSRefUPP | userUPP | ) |
| void DisposeHRURLToFSSpecUPP | ( | HRURLToFSSpecUPP | userUPP | ) |
| void DisposeHRWasCFURLVisitedUPP | ( | HRWasCFURLVisitedUPP | userUPP | ) |
| void DisposeHRWasURLVisitedUPP | ( | HRWasURLVisitedUPP | userUPP | ) |
| OSStatus HRActivate | ( | HRReference | hrRef | ) |
| OSStatus HRDeactivate | ( | HRReference | hrRef | ) |
| OSStatus HRDisposeReference | ( | HRReference | hrRef | ) |
| OSStatus HRDraw | ( | HRReference | hrRef, |
| RgnHandle | updateRgnH | ||
| ) |
Discussion: Use this API from a Carbon App. All the drawing will now happen in the specified port. This is the API you want to use to draw in an offscreen port, for example when printing. You could also use this API to draw in an on screen port.
Parameters:
hrRef: Reference to the renderer object.
updateRgnH: Region to be updated.
grafPtr: A graf pointer to render HTML into.
| OSStatus HRForceQuickdraw | ( | HRReference | hrRef, |
| Boolean | forceQuickdraw | ||
| ) |
| SInt32 HRFreeMemory | ( | Size | inBytesNeeded | ) |
| OSStatus HRGetBaseURL | ( | HRReference | hrRef, |
| Handle | baseURLH | ||
| ) |
url of <base> tag HRGetBaseURL()
| OSStatus HRGetBaseURLAsCFString | ( | HRReference | hrRef, |
| CFStringRef * | baseString | ||
| ) |
Discussion: Use these API from a Carbon App instead of using HRGetRootURL, HRGetBaseURL, HRGetHTMLURL, HRGetTitle and HRGetHTMLFile. These APIs are same in behavior with their old counter parts. The only difference is that they take CFString, CFURLRef, and FSRef as parameters.
Parameters:
hrRef: Reference to the renderer object.
baseString: Get CFString equivalent for the base url.
| OSStatus HRGetHTMLFile | ( | HRReference | hrRef, |
| FSSpec * | fsspec | ||
| ) |
| OSStatus HRGetHTMLFileAsFSRef | ( | HRReference | hrRef, |
| FSRef * | fref | ||
| ) |
Discussion: Use these API from a Carbon App instead of using HRGetRootURL, HRGetBaseURL, HRGetHTMLURL, HRGetTitle and HRGetHTMLFile. These APIs are same in behavior with their old counter parts. The only difference is that they take CFString, CFURLRef, and FSRef as parameters.
Parameters:
hrRef: Reference to the renderer object.
fref: Get currently displayed HTML as a FSRef.
| OSStatus HRGetHTMLRenderingLibVersion | ( | NumVersion * | returnVers | ) |
HRGetHTMLRenderingLibVersion()
| OSStatus HRGetHTMLURL | ( | HRReference | hrRef, |
| Handle | HTMLURLH | ||
| ) |
file url HRGetHTMLURL()
| OSStatus HRGetHTMLURLAsCFURL | ( | HRReference | hrRef, |
| CFURLRef * | theURL | ||
| ) |
Discussion: Use these API from a Carbon App instead of using HRGetRootURL, HRGetBaseURL, HRGetHTMLURL, HRGetTitle and HRGetHTMLFile. These APIs are same in behavior with their old counter parts. The only difference is that they take CFString, CFURLRef, and FSRef as parameters.
Parameters:
hrRef: Reference to the renderer object.
theURL: Get currently displayed HTML as a CFURL.
| OSStatus HRGetRenderedImageSize | ( | HRReference | hrRef, |
| Point * | renderingSize | ||
| ) |
| OSStatus HRGetRenderedImageSize32 | ( | HRReference | hrRef, |
| UInt32 * | height, | ||
| UInt32 * | width | ||
| ) |
Discussion: Use this API when the rendered image could have coordinates larger than what SInt16 can hold.
Parameters:
hrRef: Reference to the renderer object.
height: Height of the image is returned in this parameter.
width: Width of the image is returned in this parameter.
| OSStatus HRGetRootURL | ( | HRReference | hrRef, |
| Handle | rootURLH | ||
| ) |
Accessors either file url or url of <base> tag HRGetRootURL()
| OSStatus HRGetRootURLAsCFString | ( | HRReference | hrRef, |
| CFStringRef * | rootString | ||
| ) |
Discussion: Use these API from a Carbon App instead of using HRGetRootURL, HRGetBaseURL, HRGetHTMLURL, HRGetTitle and HRGetHTMLFile. These APIs are same in behavior with their old counter parts. The only difference is that they take CFString, CFURLRef, and FSRef as parameters.
Parameters:
hrRef: Reference to the renderer object.
rootString: Get CFString equivalent for the root url.
| OSStatus HRGetTitle | ( | HRReference | hrRef, |
| StringPtr | title | ||
| ) |
| OSStatus HRGetTitleAsCFString | ( | HRReference | hrRef, |
| CFStringRef * | title | ||
| ) |
Discussion: Use these API from a Carbon App instead of using HRGetRootURL, HRGetBaseURL, HRGetHTMLURL, HRGetTitle and HRGetHTMLFile. These APIs are same in behavior with their old counter parts. The only difference is that they take CFString, CFURLRef, and FSRef as parameters.
Parameters:
hrRef: Reference to the renderer object.
title: Get title of the currently displayed HTML as a CFString.
| OSStatus HRGoToAnchor | ( | HRReference | hrRef, |
| const char * | anchorName | ||
| ) |
| OSStatus HRGoToAnchorCFString | ( | HRReference | hrRef, |
| CFStringRef | anchorName | ||
| ) |
Discussion: Use these API from a Carbon App instead of using HRGoToFile, HRGoToURL, HRGoToAnchor and HRGoToPtr. These APIs are same in behavior with their old counter parts. The only difference is that they take FSRef, CFURLRef, CFString, and CFData as parameters.
Parameters:
hrRef: Reference to the renderer object.
anchorName: Name of the anchor to be displayed.
| OSStatus HRGoToCFURL | ( | HRReference | hrRef, |
| CFURLRef | url, | ||
| Boolean | addToHistory, | ||
| Boolean | forceRefresh | ||
| ) |
Discussion: Use these API from a Carbon App instead of using HRGoToFile, HRGoToURL, HRGoToAnchor and HRGoToPtr. These APIs are same in behavior with their old counter parts. The only difference is that they take FSRef, CFURLRef, CFString, and CFData as parameters.
Parameters:
hrRef: Reference to the renderer object.
url: Reference to url that is be rendered.
addToHistory: true if this URL should be added to history.
forceRefresh: true if the rendering area should be refreshed.
| OSStatus HRGoToData | ( | HRReference | hrRef, |
| CFDataRef | data, | ||
| Boolean | addToHistory, | ||
| Boolean | forceRefresh | ||
| ) |
Discussion: Use these API from a Carbon App instead of using HRGoToFile, HRGoToURL, HRGoToAnchor and HRGoToPtr. These APIs are same in behavior with their old counter parts. The only difference is that they take FSRef, CFURLRef, CFString, and CFData as parameters.
Parameters:
hrRef: Reference to the renderer object.
data: Reference to data in the memory that is be rendered.
addToHistory: true if this file URL should be added to history.
forceRefresh: true if the rendering area should be refreshed.
| OSStatus HRGoToFile | ( | HRReference | hrRef, |
| const FSSpec * | fsspec, | ||
| Boolean | addToHistory, | ||
| Boolean | forceRefresh | ||
| ) |
Navigation HRGoToFile()
| OSStatus HRGoToFSRef | ( | HRReference | hrRef, |
| const FSRef * | fref, | ||
| Boolean | addToHistory, | ||
| Boolean | forceRefresh | ||
| ) |
Discussion: Use these API from a Carbon App instead of using HRGoToFile, HRGoToURL, HRGoToAnchor and HRGoToPtr. These APIs are same in behavior with their old counter parts. The only difference is that they take FSRef, CFURLRef, CFString, and CFData as parameters.
Parameters:
hrRef: Reference to the renderer object.
fref: Reference to HTML file that is be opened and rendered.
addToHistory: true if this file URL should be added to history.
forceRefresh: true if the rendering area should be refreshed.
| OSStatus HRGoToPtr | ( | HRReference | hrRef, |
| char * | buffer, | ||
| UInt32 | bufferSize, | ||
| Boolean | addToHistory, | ||
| Boolean | forceRefresh | ||
| ) |
| OSStatus HRGoToURL | ( | HRReference | hrRef, |
| const char * | url, | ||
| Boolean | addToHistory, | ||
| Boolean | forceRefresh | ||
| ) |
| Boolean HRIsHREvent | ( | const EventRecord * | eventRecord | ) |
| OSStatus HRNewReference | ( | HRReference * | hrRef, |
| OSType | rendererType, | ||
| GrafPtr | grafPtr | ||
| ) |
| OSStatus HRNewReferenceInWindow | ( | HRReference * | hrRef, |
| OSType | rendererType, | ||
| WindowRef | inWindowRef | ||
| ) |
Discussion: Use this API from a Carbon App. All the contrrols created by the HTML renderer will be embedded in the root control of the window specified by the window ref.
Parameters:
hrRef: Pointer to the new reference created and returned by the renderer.
rendererType: Type of the renderer e.g. kHRRendererHTML32Type. Only this type is supported for now.
inWindowRef: Reference to the window for which rendering area will be specified.
| void HRRegisterNewCFURLUPP | ( | HRNewCFURLUPP | inURLUPP, |
| HRReference | hrRef, | ||
| void * | inRefCon | ||
| ) |
| void HRRegisterNewURLUPP | ( | HRNewURLUPP | inNewURLUPP, |
| HRReference | hrRef, | ||
| void * | inRefCon | ||
| ) |
| void HRRegisterURLToFSRefUPP | ( | HRURLToFSRefUPP | inURLToFSRefUPP, |
| HRReference | hrRef, | ||
| void * | inRefCon | ||
| ) |
| void HRRegisterURLToFSSpecUPP | ( | HRURLToFSSpecUPP | inURLToFSSpecUPP, |
| HRReference | hrRef, | ||
| void * | inRefCon | ||
| ) |
| void HRRegisterWasCFURLVisitedUPP | ( | HRWasCFURLVisitedUPP | inWasCFURLVisitedUPP, |
| HRReference | hrRef, | ||
| void * | inRefCon | ||
| ) |
HRRegisterWasCFURLVisitedUPP()
| void HRRegisterWasURLVisitedUPP | ( | HRWasURLVisitedUPP | inWasURLVisitedUPP, |
| HRReference | hrRef, | ||
| void * | inRefCon | ||
| ) |
| void HRScreenConfigurationChanged | ( | void | ) |
System level notifications HRScreenConfigurationChanged()
| OSStatus HRScrollToImageLocation32 | ( | HRReference | hrRef, |
| SInt32 | h, | ||
| SInt32 | v | ||
| ) |
Discussion: Use this API when specifying location to scroll to. Location is specified in image space.
Parameters:
hrRef: Reference to the renderer object.
h: Horizontal location.
v: Vertical location.
| OSStatus HRScrollToLocation | ( | HRReference | hrRef, |
| Point * | location | ||
| ) |
| OSStatus HRSetDrawBorder | ( | HRReference | hrRef, |
| Boolean | drawBorder | ||
| ) |
| OSStatus HRSetEmbeddingControl | ( | HRReference | hrRef, |
| ControlRef | controlRef | ||
| ) |
Discussion: Use this API to tell the HTML Renderer to embed all the controls it has created so far and the new controls it creates after this call to be embedded in the given control. Useful if you wish to have an HTML displayed with in your dialog. e.g. Software Update needs this.
Parameters:
hrRef: Reference to the renderer object.
controlRef: all the future controls created by renderer are embeded in this controlRef.
| OSStatus HRSetGrafPtr | ( | HRReference | hrRef, |
| GrafPtr | grafPtr | ||
| ) |
Drawing HRSetGrafPtr()
| OSStatus HRSetGrowboxCutout | ( | HRReference | hrRef, |
| Boolean | allowCutout | ||
| ) |
| OSStatus HRSetRenderingRect | ( | HRReference | hrRef, |
| const Rect * | renderingRect | ||
| ) |
| OSStatus HRSetScrollbarState | ( | HRReference | hrRef, |
| HRScrollbarState | hScrollbarState, | ||
| HRScrollbarState | vScrollbarState | ||
| ) |
| OSStatus HRSetWindowRef | ( | HRReference | hrRef, |
| WindowRef | windowRef | ||
| ) |
Discussion: Use this API from a Carbon App. All the contrrols created by the HTML renderer will be moved in the root control of the window specified by the window ref. All the drawing will now happen in the specified window.
Parameters:
hrRef: Reference to the renderer object.
windowRef: new Reference to the window to be attached to the above hrRef.
| void HRUnregisterNewCFURLUPP | ( | HRReference | hrRef | ) |
| void HRUnregisterNewURLUPP | ( | HRReference | hrRef | ) |
| void HRUnregisterURLToFSRefUPP | ( | HRReference | hrRef | ) |
| void HRUnregisterURLToFSSpecUPP | ( | HRReference | hrRef | ) |
| void HRUnregisterWasCFURLVisitedUPP | ( | HRReference | hrRef | ) |
HRUnregisterWasCFURLVisitedUPP()
| void HRUnregisterWasURLVisitedUPP | ( | HRReference | hrRef | ) |
HRUnregisterWasURLVisitedUPP()
| OSStatus HRUtilCreateFullCFURL | ( | CFStringRef | rootString, |
| CFStringRef | linkString, | ||
| CFURLRef * | url | ||
| ) |
Discussion: Use these API from a Carbon App instead of using HRUtilCreateFullURL, HRUtilGetFSSpecFromURL, HRUtilGetURLFromFSSpec. These APIs are same in behavior with their old counter parts. The only difference is that they take CFURLRef, and FSRef as parameters.
Parameters:
rootString: a CFString for the root.
linkString: a CFString for a partial link.
url: Fully qualified URL is returned after attaching a link string to the root.
| OSStatus HRUtilCreateFullURL | ( | const char * | rootURL, |
| const char * | linkURL, | ||
| Handle | fullURLH | ||
| ) |
Utilities HRUtilCreateFullURL()
| OSStatus HRUtilGetFSRefFromURL | ( | CFStringRef | rootString, |
| CFStringRef | linkString, | ||
| FSRef * | destRef | ||
| ) |
Discussion: Use these API from a Carbon App instead of using HRUtilCreateFullURL, HRUtilGetFSSpecFromURL, HRUtilGetURLFromFSSpec. These APIs are same in behavior with their old counter parts. The only difference is that they take CFURLRef, and FSRef as parameters.
Parameters:
rootString: a CFString for the root.
linkString: a CFString for a partial link.
destRef: File reference is returned for the complete path created after attaching link string to the root. If File does not exist, fnfErr is returned as a function result.
| OSStatus HRUtilGetFSSpecFromURL | ( | const char * | rootURL, |
| const char * | linkURL, | ||
| FSSpec * | destSpec | ||
| ) |
| OSStatus HRUtilGetURLFromFSRef | ( | const FSRef * | fileRef, |
| CFURLRef * | url | ||
| ) |
Discussion: Use these API from a Carbon App instead of using HRUtilCreateFullURL, HRUtilGetFSSpecFromURL, HRUtilGetURLFromFSSpec. These APIs are same in behavior with their old counter parts. The only difference is that they take CFURLRef, and FSRef as parameters.
Parameters:
fileRef: Refernce to a file whose URL is desired.
url: a fully qualified URL is returned in this parameter. The returned URL gives the path of the file specified in the above parameter.
| OSStatus HRUtilGetURLFromFSSpec | ( | const FSSpec * | fsspec, |
| Handle | urlHandle | ||
| ) |
urlHandle should be valid on input HRUtilGetURLFromFSSpec()
| OSStatus InvokeHRNewCFURLUPP | ( | CFURLRef | url, |
| CFStringRef | targetString, | ||
| Boolean | addToHistory, | ||
| void * | refCon, | ||
| HRNewCFURLUPP | userUPP | ||
| ) |
| OSStatus InvokeHRNewURLUPP | ( | const char * | url, |
| const char * | targetFrame, | ||
| Boolean | addToHistory, | ||
| void * | refCon, | ||
| HRNewURLUPP | userUPP | ||
| ) |
| OSStatus InvokeHRURLToFSRefUPP | ( | CFStringRef | rootString, |
| CFStringRef | linkString, | ||
| FSRef * | fref, | ||
| URLSourceType | urlSourceType, | ||
| void * | refCon, | ||
| HRURLToFSRefUPP | userUPP | ||
| ) |
| OSStatus InvokeHRURLToFSSpecUPP | ( | const char * | rootURL, |
| const char * | linkURL, | ||
| FSSpec * | fsspec, | ||
| URLSourceType | urlSourceType, | ||
| void * | refCon, | ||
| HRURLToFSSpecUPP | userUPP | ||
| ) |
| Boolean InvokeHRWasCFURLVisitedUPP | ( | CFURLRef | url, |
| void * | refCon, | ||
| HRWasCFURLVisitedUPP | userUPP | ||
| ) |
| Boolean InvokeHRWasURLVisitedUPP | ( | const char * | url, |
| void * | refCon, | ||
| HRWasURLVisitedUPP | userUPP | ||
| ) |
| HRNewCFURLUPP NewHRNewCFURLUPP | ( | HRNewCFURLProcPtr | userRoutine | ) |
| HRNewURLUPP NewHRNewURLUPP | ( | HRNewURLProcPtr | userRoutine | ) |
| HRURLToFSRefUPP NewHRURLToFSRefUPP | ( | HRURLToFSRefProcPtr | userRoutine | ) |
| HRURLToFSSpecUPP NewHRURLToFSSpecUPP | ( | HRURLToFSSpecProcPtr | userRoutine | ) |
| HRWasCFURLVisitedUPP NewHRWasCFURLVisitedUPP | ( | HRWasCFURLVisitedProcPtr | userRoutine | ) |
| HRWasURLVisitedUPP NewHRWasURLVisitedUPP | ( | HRWasURLVisitedProcPtr | userRoutine | ) |