IWebDataSource Interface Reference

import"IWebDataSource.idl";

Inheritance diagram for IWebDataSource:

Public Member Functions
HRESULT	initWithRequest ([in] IWebURLRequest *request)
HRESULT	data ([out, retval] IStream **stream)
HRESULT	representation ([out, retval] IWebDocumentRepresentation **rep)
HRESULT	webFrame ([out, retval] IWebFrame **frame)
HRESULT	initialRequest ([out, retval] IWebURLRequest **request)
HRESULT	request ([out, retval] IWebMutableURLRequest **request)
HRESULT	response ([out, retval] IWebURLResponse **response)
HRESULT	textEncodingName ([out, retval] BSTR *name)
HRESULT	isLoading ([out, retval] BOOL *loading)
HRESULT	pageTitle ([out, retval] BSTR *title)
HRESULT	unreachableURL ([out, retval] BSTR *url)
HRESULT	webArchive ([out, retval] IWebArchive **archive)
HRESULT	mainResource ([out, retval] IWebResource **resource)
HRESULT	subresources ([out, retval] IEnumVARIANT **enumResources)
HRESULT	subresourceForURL ([in] BSTR url, [out, retval] IWebResource **resource)
HRESULT	addSubresource ([in] IWebResource *subresource)

Member Function Documentation

addSubresource()

HRESULT IWebDataSource::addSubresource

(

[in] IWebResource *

subresource

)

addSubresource: Adds a subresource to the data source.

Parameters

subresource

The subresource to be added. addSubresource: adds a subresource to the data source's list of subresources. Later, if something causes the data source to load the URL of the subresource, the data source will load the data from the subresource instead of from the network. For example, if one wants to add an image that is already downloaded to a web page, addSubresource: can be called so that the data source uses the downloaded image rather than accessing the network. NOTE: If the data source already has a subresource with the same URL, addSubresource: will replace it. (void)addSubresource:(WebResource *)subresource;

data()

HRESULT IWebDataSource::data

(

[out, retval] IStream **

stream

)

data The data will be incomplete until the datasource has completely loaded.

Returns

Returns the raw data associated with the datasource. Returns nil if the datasource hasn't loaded any data.

• (NSData *)data;

initialRequest()

HRESULT IWebDataSource::initialRequest

(

[out, retval] IWebURLRequest **

request

)

initialRequest

Returns

Returns a reference to the original request that created the datasource. This request will be unmodified by WebKit.

• (NSURLRequest *)initialRequest;

initWithRequest()

HRESULT IWebDataSource::initWithRequest

(

[in] IWebURLRequest *

request

)

initWithRequest: The designated initializer for WebDataSource.

Parameters

request

The request to use in creating a datasource.

Returns

Returns an initialized WebDataSource.

• (id)initWithRequest:(NSURLRequest *)request;

isLoading()

HRESULT IWebDataSource::isLoading

(

[out, retval] BOOL *

loading

)

isLoading Returns YES if there are any pending loads.

• (BOOL)isLoading;

mainResource()

HRESULT IWebDataSource::mainResource

(

[out, retval] IWebResource **

resource

)

mainResource

Returns

A WebResource representing the data source. This method constructs a WebResource using the original downloaded data. This method can be used to construct a WebArchive in case the archive returned by WebDataSource's webArchive isn't sufficient.

• (WebResource *)mainResource;

pageTitle()

HRESULT IWebDataSource::pageTitle

(

[out, retval] BSTR *

title

)

pageTitle

Returns

Returns nil or the page title.

• (NSString *)pageTitle;

representation()

HRESULT IWebDataSource::representation

(

[out, retval] IWebDocumentRepresentation **

rep

)

representation A representation holds a type specific representation of the datasource's data. The representation class is determined by mapping a MIME type to a class. The representation is created once the MIME type of the datasource content has been determined.

Returns

Returns the representation associated with this datasource. Returns nil if the datasource hasn't created it's representation.

• (id <WebDocumentRepresentation>)representation;

request()

HRESULT IWebDataSource::request

(

[out, retval] IWebMutableURLRequest **

request

)

request

Returns

Returns the request that was used to create this datasource.

• (NSMutableURLRequest *)request;

response()

HRESULT IWebDataSource::response

(

[out, retval] IWebURLResponse **

response

)

response

Returns

returns the WebResourceResponse for the data source.

• (NSURLResponse *)response;

subresourceForURL()

HRESULT IWebDataSource::subresourceForURL	(	[in] BSTR	url,
		[out, retval] IWebResource **	resource
	)

method subresourceForURL: Returns a subresource for a given URL.

Parameters

URL	The URL of the subresource. Returns non-nil if the data source has fully downloaded a subresource with the given URL. (WebResource *)subresourceForURL:(NSURL *)URL;

subresources()

HRESULT IWebDataSource::subresources

(

[out, retval] IEnumVARIANT **

enumResources

)

subresources Returns all the subresources associated with the data source. The returned array only contains subresources that have fully downloaded.

• (NSArray *)subresources;

textEncodingName()

HRESULT IWebDataSource::textEncodingName

(

[out, retval] BSTR *

name

)

textEncodingName

Returns

Returns either the override encoding, as set on the WebView for this dataSource or the encoding from the response.

• (NSString *)textEncodingName;

unreachableURL()

HRESULT IWebDataSource::unreachableURL

(

[out, retval] BSTR *

url

)

unreachableURL This will be non-nil only for dataSources created by calls to the WebFrame method loadAlternateHTMLString:baseURL:forUnreachableURL:.

Returns

returns the unreachableURL for which this dataSource is showing alternate content, or nil

• (NSURL *)unreachableURL;

webArchive()

HRESULT IWebDataSource::webArchive

(

[out, retval] IWebArchive **

archive

)

webArchive

Returns

A WebArchive representing the data source, its subresources and child frames. This method constructs a WebArchive using the original downloaded data. In the case of HTML, if the current state of the document is preferred, webArchive should be called on the DOM document instead.

• (WebArchive *)webArchive;

webFrame()

HRESULT IWebDataSource::webFrame

(

[out, retval] IWebFrame **

frame

)

webFrame

Returns

Return the frame that represents this data source.

• (WebFrame *)webFrame;

---

The documentation for this interface was generated from the following file:

• Source/WebKit/win/Interfaces/IWebDataSource.idl