WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIWyciwygChannel

IID:89b0674a-9e2f-4124-9b59-481444be841d
Inherits From:nsIChannel

A channel to manage all cache-related interactions for layout when it is dealing with dynamic pages created through document.write(). This interface provides methods that will help layout save dynamic pages in cache for future retrievals.


Methods

void closeCacheEntry ( nsresult reason ) ACString getCharsetAndSource ( out PRInt32 source ) void setCharsetAndSource ( PRInt32 source , ACString charset ) void setSecurityInfo ( nsISupports securityInfo ) void writeToCacheEntry ( AString data )

void closeCacheEntry ( nsresult reason )

Close the cache entry; subsequent writes have undefined behavior.

Arguments:
reason

ACString getCharsetAndSource ( out PRInt32 source )

The return value is the charset. Throws if either the charset or the source cannot be retrieved. This is guaranteed to return a nonzero source and a nonempty charset if it does not throw.

Arguments:
source

void setCharsetAndSource ( PRInt32 source , ACString charset )

Store and read a charset and charset source on the wyciwyg channel. These are opaque values to the channel; consumers who set them should know what they mean.

Arguments:
source
charset

void setSecurityInfo ( nsISupports securityInfo )

Set the wyciwyg channels security info

Arguments:
securityInfo

void writeToCacheEntry ( AString data )

Append data to the cache entry; opens the cache entry if necessary.

Arguments:
data

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com