Apple Developer Connection
Member Login Log In | Not a Member? Contact ADC

< Previous PageNext Page > Hide TOC

Legacy Documentclose button

Important: The HTML Rendering Library is deprecated as of Mac OS X v10.4. A much more complete solution for displaying HTML and web content in your application is provided by the Web Kit. See Web Kit Objective-C Programming Guide for guidelines on using the Web Kit.

Deprecated HTML Rendering Library Reference (Not Recommended) Functions

A function identified as deprecated has been superseded and may become unsupported in the future.

Deprecated in Mac OS X v10.4

DisposeHRNewCFURLUPP

(Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

void DisposeHRNewCFURLUPP (
   HRNewCFURLUPP userUPP
);

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

DisposeHRNewURLUPP

Disposes of a previously obtained UPP. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

void DisposeHRNewURLUPP (
   HRNewURLUPP userUPP
);

Parameters
userUPP

A Universal Procedure Pointer (UPP) that you previously obtained by calling the function NewHRNewURLUPP.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

DisposeHRURLToFSRefUPP

(Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

void DisposeHRURLToFSRefUPP (
   HRURLToFSRefUPP userUPP
);

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

DisposeHRURLToFSSpecUPP

Disposes of a previously obtained UPP. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

void DisposeHRURLToFSSpecUPP (
   HRURLToFSSpecUPP userUPP
);

Parameters
userUPP

A Universal Procedure Pointer (UPP) that you previously obtained by calling the function NewHRURLToFSSpecUPP.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

DisposeHRWasCFURLVisitedUPP

(Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

void DisposeHRWasCFURLVisitedUPP (
   HRWasCFURLVisitedUPP userUPP
);

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

DisposeHRWasURLVisitedUPP

Disposes of a previously obtained UPP. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

void DisposeHRWasURLVisitedUPP (
   HRWasURLVisitedUPP userUPP
);

Parameters
userUPP

A Universal Procedure Pointer (UPP) that you previously obtained by calling the function NewHRWasURLVisitedUPP.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRActivate

Activates the window associated with a given HRReference. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRActivate (
   HRReference hrRef
);

Parameters
hrRef

An HRReference value previously obtained by your application.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Call this function whenever the window associated with a given HRReference becomes active. This allows the HTML Rendering Library to activate scrollbars and handle events as appropriate.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRDeactivate

Deactivates the window associated with a given HRReference. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRDeactivate (
   HRReference hrRef
);

Parameters
hrRef

An HRReference value previously obtained by your application.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Call this function whenever the window associated with a given HRReference becomes inactive.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRDisposeReference

Disposes of a previously obtained HRReference. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRDisposeReference (
   HRReference hrRef
);

Parameters
hrRef

An HRReference value previously obtained by your application.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRDraw

Updates a specified region for a given HRReference. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRDraw (
   HRReference hrRef,
   RgnHandle updateRgnH
);

Parameters
hrRef

An HRReference value previously obtained by your application.

updateRgnH

A handle of type RgnHandle. This handle specifies the region that you want the HTML Rendering Library to update. Specify the region in the GrafPort’s local coordinates. If you pass NULL, the HTML Rendering Library updates the entire rectangle you previously specified with the function HRSetRenderingRect.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Be sure to specify the dimensions of the rendering area by calling the function HRSetRenderingRect at least once before you call the HRDraw function.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRDrawInPort

Updates a specified region for a given HRReference. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRDrawInPort (
   HRReference hrRef,
   RgnHandle updateRgnH,
   CGrafPtr grafPtr
);

Parameters
hrRef

A reference to the renderer object.

updateRgnH

The region to be updated.

grafPtr

A graf pointer to render HTML into.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

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.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRForceQuickdraw

Forces all images to be drawn with QuickDraw. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRForceQuickdraw (
   HRReference hrRef,
   Boolean forceQuickdraw
);

Parameters
hrRef

An HRReference value previously obtained by your application.

forceQuickdraw

Pass a value of true in this parameter to force all images to be drawn with QuickDraw.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

This function may be useful when working with print drivers that require QuickDraw for image capturing.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRFreeMemory

Attempts to release cache memory for use by your application. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

SInt32 HRFreeMemory (
   Size inBytesNeeded
);

Parameters
inBytesNeeded

A value indicating how many bytes of cache memory your application desires to obtain.

Return Value

A value indicating how many bytes of cache memory the HTML Rendering Library makes available to your application.

Discussion

Call the HRFreeMemory function to flush images and movies from the HTML Rendering Library cache. Be sure to check the function result to determine whether sufficient memory was made available to your application.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGetBaseURL

Obtains the base URL of a given HTML page. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGetBaseURL (
   HRReference hrRef,
   Handle baseURLH
);

Parameters
hrRef

A HRReference value previously obtained by your application.

baseURLH

A handle. Make sure you allocate a valid handle with the NewHandle function. On return, this handle (which may be resized) references a C string containing the root URL of the given file. If the current page does not contain a BASE tag, the handle is empty.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

The URL returned by this function begins with 'file:///'.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGetBaseURLAsCFString

Obtains the base URL of a given HTML page. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGetBaseURLAsCFString (
   HRReference hrRef,
   CFStringRef *baseString
);

Parameters
hrRef

A HRReference value previously obtained by your application.

baseString

On return, this handle references a CFString containing the root URL of the given file.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Use these API from a Carbon application instead of using HRGetRootURL, HRGetBaseURL, HRGetHTMLURL, HRGetTitleand 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.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGetHTMLFile

Obtains a file system specification record for a given HTML page. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGetHTMLFile (
   HRReference hrRef,
   FSSpec *fsspec
);

Parameters
hrRef

An HRReference value previously obtained by your application.

fsspec

A pointer to a file system specification record (FSSpec). On return, the FSSpec contains file specification data for the page specified in the hrRef parameter.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGetHTMLFileAsFSRef

Obtains an FSRef for a given HTML page. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGetHTMLFileAsFSRef (
   HRReference hrRef,
   FSRef *fref
);

Parameters
hrRef

An HRReference value previously obtained by your application.

fref

A pointer to an (FSRef). On return, the FSRef contains file specification data for the page specified in the hrRef parameter.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Use these API from a Carbon application instead of using HRGetRootURL, HRGetBaseURL, HRGetHTMLURL, HRGetTitleand 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.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGetHTMLRenderingLibVersion

Identifies which version of the HTML Rendering Library is available. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGetHTMLRenderingLibVersion (
   NumVersion *returnVers
);

Parameters
returnVers

A pointer to a NumVersion structure. On return, this structure contains a value identifying the installed version of the HTML Rendering Library.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGetHTMLURL

Obtains the URL for a given HTML page. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGetHTMLURL (
   HRReference hrRef,
   Handle HTMLURLH
);

Parameters
hrRef

An HRReference value previously obtained by your application.

HTMLURLH

A handle. Make sure you allocate a valid handle with the NewHandle function. On return, this handle (which may be resized) references a C string containing the URL of the given file.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGetHTMLURLAsCFURL

Obtains the URL for a given HTML page. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGetHTMLURLAsCFURL (
   HRReference hrRef,
   CFURLRef *theURL
);

Parameters
hrRef

An HRReference value previously obtained by your application.

theURL

On return, this references a CFURL containing the URL of the given file.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Use these API from a Carbon application instead of using HRGetRootURL, HRGetBaseURL, HRGetHTMLURL, HRGetTitleand 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.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGetRenderedImageSize

Reports the size of the rendered image. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGetRenderedImageSize (
   HRReference hrRef,
   Point *renderingSize
);

Parameters
hrRef

An HRReference value previously obtained by your application.

renderingSize

A pointer to a value of type Point. On return, the HTML Rendering Library uses this value to report the size of the entire HTML page; that is, the smallest rectangle that fully encloses the entire rendered page (as drawn without scrollbars).

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

The HTML Rendering Library attempts to limit the width of the rendered page to the width of the rectangle you specify by calling the function HRSetRenderingRect. The length of the page is calculated based on the resulting width.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGetRenderedImageSize32

Reports the size of the rendered image. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGetRenderedImageSize32 (
   HRReference hrRef,
   UInt32 *height,
   UInt32 *width
);

Parameters
hrRef

A reference to the renderer object.

height

On return, the height of the image.

width

On return, the width of the image.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Use this API when the rendered image could have coordinates larger than what SInt16 can hold.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGetRootURL

Obtains the root URL for all relative links on a given HTML page. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGetRootURL (
   HRReference hrRef,
   Handle rootURLH
);

Parameters
hrRef

An HRReference value previously obtained by your application.

rootURLH

A handle. Make sure you allocate a valid handle with the NewHandle function. On return, this handle (which may be resized) references a C string containing the root URL of the given file.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

The root URL is normally the URL of the page specified in the hrRef parameter, unless the page contains a <BASE> tag specifying a different root URL.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGetRootURLAsCFString

Obtains the root URL for all relative links on a given HTML page. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGetRootURLAsCFString (
   HRReference hrRef,
   CFStringRef *rootString
);

Parameters
hrRef

An HRReference value previously obtained by your application.

rootString

On return, this references a CFString containing the root URL of the given file.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Use these API from a Carbon application instead of using HRGetRootURL, HRGetBaseURL, HRGetHTMLURL, HRGetTitleand 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.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGetTitle

Obtains the title of a given HTML page. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGetTitle (
   HRReference hrRef,
   StringPtr title
);

Parameters
hrRef

An HRReference value previously obtained by your application.

title

A StringPtr. On return, the HTML Rendering Library stores the contents of the TITLE tag of the given page in the referenced string.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

This function converts any HTML entities into Mac OS characters before storing them in the string specified in the title parameter.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGetTitleAsCFString

Obtains the title of a given HTML page. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGetTitleAsCFString (
   HRReference hrRef,
   CFStringRef *title
);

Parameters
hrRef

An HRReference value previously obtained by your application.

title

A CFStringRef. On return, the HTML Rendering Library stores the contents of the TITLE tag of the given page in the referenced string.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Use these API from a Carbon application instead of using HRGetRootURL, HRGetBaseURL, HRGetHTMLURL, HRGetTitleand 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.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGoToAnchor

Specifies an HTML anchor to scroll into view. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGoToAnchor (
   HRReference hrRef,
   const char *anchorName
);

Parameters
hrRef

An HRReference value previously obtained by your application.

anchorName

A pointer to a C string containing the name of an anchor on the current HTML page.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Note that anchors are case sensitive.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGoToAnchorCFString

Specifies an HTML anchor to scroll into view. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGoToAnchorCFString (
   HRReference hrRef,
   CFStringRef anchorName
);

Parameters
hrRef

A reference to the renderer object.

anchorName

The name of the anchor to display.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Use these functions instead of using the functions HRGoToFile, HRGoToURL, HRGoToAnchorand HRGoToPtr. These functions are the same in behavior with their old counter parts. The only difference is that they take FSRef, CFURLRef, CFString, and CFData as parameters.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGoToCFURL

Renders a local file specified as a URL. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGoToCFURL (
   HRReference hrRef,
   CFURLRef url,
   Boolean addToHistory,
   Boolean forceRefresh
);

Parameters
hrRef

A reference to the renderer object.

url

A reference to the URL to render.

addToHistory

Pass true if this file URL should be added to the history.

forceRefresh

Pass true if the rendering area should be refreshed.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Use these functions instead of using the functions HRGoToFile, HRGoToURL, HRGoToAnchorand HRGoToPtr. These functions are the same in behavior with their old counter parts. The only difference is that they take FSRef, CFURLRef, CFString, and CFData as parameters.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGoToData

Specifies HTML data for rendering. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGoToData (
   HRReference hrRef,
   CFDataRef data,
   Boolean addToHistory,
   Boolean forceRefresh
);

Parameters
hrRef

A reference to the renderer object.

data

A reference to data in the memory to render.

addToHistory

Pass true if this file URL should be added to the history.

forceRefresh

Pass true if the rendering area should be refreshed.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Use these functions instead of using the functions HRGoToFile, HRGoToURL, HRGoToAnchorand HRGoToPtr. These functions are the same in behavior with their old counter parts. The only difference is that they take FSRef, CFURLRef, CFString, and CFData as parameters.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGoToFile

Specifies an HTML file for rendering. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGoToFile (
   HRReference hrRef,
   const FSSpec *fsspec,
   Boolean addToHistory,
   Boolean forceRefresh
);

Parameters
hrRef

An HRReference value previously obtained by your application.

fsspec

A pointer to a file system specification record (FSSpec) for the HTML file that you wish to have rendered by the HTML Rendering Library.

addToHistory

Pass true in this parameter if you wish to have this file added to the list of visited links.

forceRefresh

Pass true in this parameter if you wish to force a screen update.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Note that the HTML Rendering Library calls your HRNewURLProcPtr application-defined function (if you use one) with this FSSpec. If you need to pass a URL instead of an FSSpec, use the function HRGoToURL.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGoToFSRef

Renders a set of HTML data from a specified buffer. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGoToFSRef (
   HRReference hrRef,
   const FSRef *fref,
   Boolean addToHistory,
   Boolean forceRefresh
);

Parameters
hrRef

A reference to the renderer object.

fref

A reference to the HTML file that is to be opened and rendered.

addToHistory

Pass true if this file URL should be added to the history.

forceRefresh

Pass true if the rendering area should be refreshed.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Use these functions instead of using the functions HRGoToFile, HRGoToURL, HRGoToAnchorand HRGoToPtr. These functions are the same in behavior with their old counter parts. The only difference is that they take FSRef, CFURLRef, CFString, and CFData as parameters.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGoToPtr

Renders a set of HTML data from a specified buffer. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGoToPtr (
   HRReference hrRef,
   char *buffer,
   UInt32 bufferSize,
   Boolean addToHistory,
   Boolean forceRefresh
);

Parameters
hrRef

An HRReference value previously obtained by your application.

buffer

A pointer to a buffer containing HTML data.

bufferSize

A value specifying the number of bytes in the buffer.

addToHistory

Pass true in this parameter if you wish to have this data added to the list of visited links.

forceRefresh

Pass true in this parameter if you wish to force a screen update.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

The HTML Rendering Library displays the HTML source data pointed to by the handle. It does not copy the handle, so you should not dispose of it until you are sure you no longer need it. Note that any relative links you specify in the HTML data are relative to your application, as the HTML data has no associated URL.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRGoToURL

Renders a local file specified as a URL. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRGoToURL (
   HRReference hrRef,
   const char *url,
   Boolean addToHistory,
   Boolean forceRefresh
);

Parameters
hrRef

An HRReference value previously obtained by your application.

url

A pointer to a C string containing a Universal Resource Locator (URL).

addToHistory

Pass true in this parameter if you wish to have this file added to the list of visited links.

forceRefresh

Pass true in this parameter if you wish to force a screen update.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

Use this function for rendering local files. The URL should begin with 'file:///'. Note that the HTML Rendering Library calls your HRNewURLProcPtr application-defined function (if you use one) with this URL. If you need to pass an FSSpec instead of a URL, use the function HRGoToURL.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRIsHREvent

Gives the HTML Rendering Library an opportunity to handle events. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

Boolean HRIsHREvent (
   const EventRecord *eventRecord
);

Parameters
eventRecord

A pointer to an EventRecord.

Return Value

Returns true if the HTML Rendering Library handles the specified event; returns false otherwise.

Discussion

Call the HRIsHREvent function with every event received by your application. This ensures that the HTML Rendering Library has an opportunity to handle user clicks and cursor changes.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRNewReference

Obtains a new HRReference. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRNewReference (
   HRReference *hrRef,
   OSType rendererType,
   GrafPtr grafPtr
);

Parameters
hrRef

A pointer to a HRReference value. On return, your application uses this value to call other functions in the HTML Rendering Library.

rendererType

A value of type OSType identifying the type of HTML renderer available. Currently, the constant kHRRendererHTML32Type is the only value you may pass in this parameter.

grafPtr

A pointer to a valid GrafPort.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

When your application has no further need for a particular HRReference, dispose of it by calling the function HRDisposeReference.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRNewReferenceInWindow

Obtains a new HRReference. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

OSStatus HRNewReferenceInWindow (
   HRReference *hrRef,
   OSType rendererType,
   WindowRef inWindowRef
);

Parameters
hrRef

A pointer to the new reference created and returned by the renderer.

rendererType

The type of the renderer—for example kHRRendererHTML32Type. Only this type is supported for now.

inWindowRef

A reference to the window for which rendering area will be specified.

Return Value

A result code. See “HTML Rendering Library Result Codes.”

Discussion

All the controls created by the HTML renderer will be embedded in the root control of the window specified by the window reference.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRRegisterNewCFURLUPP

(Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

void HRRegisterNewCFURLUPP (
   HRNewCFURLUPP inURLUPP,
   HRReference hrRef,
   void *inRefCon
);

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRRegisterNewURLUPP

Registers an application-defined function that handles newly visited links. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

void HRRegisterNewURLUPP (
   HRNewURLUPP inNewURLUPP,
   HRReference hrRef,
   void *inRefCon
);

Parameters
inNewURLUPP

A Universal Procedure Pointer (UPP). You obtain this UPP by calling the function NewHRNewURLUPP.

hrRef

An HRReference value previously obtained by your application.

inRefCon

An arbitrary value set by your application. This value is passed by your application when you call the HRRegisterNewURLUPP function and passed back when the HTML Rendering Library calls your function HRNewURLProcPtr. You may find this value useful for referring to an object instance or a structure, for example.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRRegisterURLToFSRefUPP

(Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

void HRRegisterURLToFSRefUPP (
   HRURLToFSRefUPP inURLToFSRefUPP,
   HRReference hrRef,
   void *inRefCon
);

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRRegisterURLToFSSpecUPP

Registers an application-defined function that handles previously visited links. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

void HRRegisterURLToFSSpecUPP (
   HRURLToFSSpecUPP inURLToFSSpecUPP,
   HRReference hrRef,
   void *inRefCon
);

Parameters
inURLToFSSpecUPP

A Universal Procedure Pointer (UPP). You obtain this UPP by calling the function NewHRURLToFSSpecUPP.

hrRef

An HRReference value previously obtained by your application.

inRefCon

An arbitrary value set by your application. This value is passed by your application when you call the HRRegisterURLToFSSpecUPP function and passed back when the HTML Rendering Library calls your function HRURLToFSSpecProcPtr. You may find this value useful for referring to an object instance or a structure, for example.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRRegisterWasCFURLVisitedUPP

(Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

void HRRegisterWasCFURLVisitedUPP (
   HRWasCFURLVisitedUPP inWasCFURLVisitedUPP,
   HRReference hrRef,
   void *inRefCon
);

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability
Declared In
HTMLRendering.h

HRRegisterWasURLVisitedUPP

Registers an application-defined function that handles previously visited links. (Deprecated in Mac OS X v10.4. Use Web Kit instead; see Web Kit Objective-C Programming Guide.)

void HRRegisterWasURLVisitedUPP (
   HRWasURLVisitedUPP inWasURLVisitedUPP,
   HRReference hrRef,
   void *inRefCon
);

Parameters
inWasURLVisitedUPP

A Universal Procedure Pointer (UPP). You obtain this UPP by calling the function NewHRWasURLVisitedUPP.

hrRef

An HRReference value previously obtained by your application.

inRefCon

An arbitrary value set by your application. This value is passed by your application when you call the function and passed back when the HTML Rendering Library calls your MyHRWasURLVisitedProc function. You may find this value useful for referring to an object instance or a structure, for example.

Special Considerations

Because the Web Kit takes a completely different approach to displaying HTML and web content from that used by the HTML Rendering Library, you cannot make a one-to-one substitution of Web Kit methods for HTML Rendering Library functions. However, the basic features of the Web Kit can be implemented very quickly, and Web Kit offers much greater capability than the HTML Rendering Library. Although the Web Kit is an Objective-C interface, you can call it from a Carbon application. See Accessing the Web Kit From Carbon Applications for details.

Availability