WebArchive Class Reference

#import <WebArchive.h>

Inheritance diagram for WebArchive:

Instance Methods
(instancetype)	- initWithMainResource:subresources:subframeArchives:
(instancetype)	- initWithData:
(virtual HRESULT STDMETHODCALLTYPE)	- QueryInterface
(virtual ULONG STDMETHODCALLTYPE)	- AddRef
(virtual ULONG STDMETHODCALLTYPE)	- Release
(virtual HRESULT STDMETHODCALLTYPE)	- initWithMainResource
(virtual HRESULT STDMETHODCALLTYPE)	- initWithData
(virtual HRESULT STDMETHODCALLTYPE)	- initWithNode
(virtual HRESULT STDMETHODCALLTYPE)	- mainResource
(virtual HRESULT STDMETHODCALLTYPE)	- subResources
(virtual HRESULT STDMETHODCALLTYPE)	- subframeArchives
(virtual HRESULT STDMETHODCALLTYPE)	- data
Instance Methods inherited from IWebArchive
HRESULT	initWithMainResource ([in] IWebResource *mainResource, [in, size_is(cSubResources)] IWebResource **subResources, [in] int cSubResources, [in, size_is(cSubFrameArchives)] IWebArchive **subFrameArchives, [in] int cSubFrameArchives)
HRESULT	initWithData ([in] IStream *data)
HRESULT	initWithNode ([in] IDOMNode *node)
HRESULT	mainResource ([out, retval] IWebResource **resource)
HRESULT	subResources ([out, retval] IEnumVARIANT **enumResources)
HRESULT	subframeArchives ([out, retval] IEnumVARIANT **enumSubframes)
HRESULT	data ([out, retval] IStream **stream)

Class Methods
(static WebArchive *)	+ createInstance
(static WebArchive *)	+ createInstance

Protected Member Functions
()	- WebArchive
()	- ~WebArchive

Protected Attributes
package WebArchivePrivate *	_private
ULONG	m_refCount { 0 }
RefPtr< WebCore::LegacyWebArchive >	m_archive

Properties
WebResource *	mainResource
NSArray *	subresources
NSArray *	subframeArchives
NSData *	data

Detailed Description

WebArchive represents a main resource as well as all the subresources and subframes associated with the main resource. The main resource can be an entire web page, a portion of a web page, or some other kind of data such as an image. This class can be used for saving standalone web pages, representing portions of a web page on the pasteboard, or any other application where one class is needed to represent rich web content.

Constructor & Destructor Documentation

WebArchive()

- WebArchive

(PassRefPtr< WebCore::LegacyWebArchive >)

coreArchive

~WebArchive()

- ~WebArchive

Method Documentation

AddRef()

- (ULONG) AddRef

(void)

createInstance() [1/2]

+ (WebArchive *) createInstance

createInstance() [2/2]

+ (WebArchive *) createInstance

(PassRefPtr< WebCore::LegacyWebArchive >)

coreArchive

data()

- (HRESULT) data

(_COM_Outptr_opt_ IStream **)

stream

initWithData()

- (HRESULT) initWithData

(_In_opt_ IStream *)

initWithData:()

- (instancetype) initWithData:

(NSData *)

data

initWithData: The initializer for creating a WebArchive from data.

Parameters

data	The data representing the archive. This can be obtained using WebArchive's data method.

Returns

An initialized WebArchive.

initWithMainResource()

- (HRESULT) initWithMainResource		(_In_opt_ IWebResource *)	mainResource
		(__inout_ecount_full(cSubResources) IWebResource **)	subResources
		(int)	cSubResources
		(__inout_ecount_full(cSubFrameArchives) IWebArchive **)	subFrameArchives
		(int)	cSubFrameArchives

initWithMainResource:subresources:subframeArchives:()

- (instancetype) initWithMainResource:		(WebResource *)	mainResource
subresources:		(NSArray *)	subresources
subframeArchives:		(NSArray *)	subframeArchives

initWithMainResource:subresources:subframeArchives: The initializer for WebArchive.

Parameters

mainResource	The main resource of the archive.
subresources	The subresources of the archive (can be nil).
subframeArchives	The archives representing the subframes of the archive (can be nil).

Returns

An initialized WebArchive.

initWithNode()

- (HRESULT) initWithNode

(_In_opt_ IDOMNode *)

node

mainResource()

- (HRESULT) mainResource

(_COM_Outptr_opt_ IWebResource **)

result

QueryInterface()

- (HRESULT) QueryInterface		(_In_ REFIID)	riid
		(_COM_Outptr_ void **)	ppvObject

Release()

- (ULONG) Release

(void)

subframeArchives()

- (HRESULT) subframeArchives

(_COM_Outptr_opt_ IEnumVARIANT **)

result

subResources()

- (HRESULT) subResources

(_COM_Outptr_opt_ IEnumVARIANT **)

result

Member Data Documentation

_private

- (package WebArchivePrivate*) _private

protected

m_archive

- (LegacyWebArchive>) WebArchive:

protected

m_refCount

- (ULONG) m_refCount { 0 }

protected

Property Documentation

data

- (NSData *) data

readnonatomiccopy

The data representation of the archive. The data returned by this method can be used to save a web archive to a file or to place a web archive on the pasteboard using WebArchivePboardType. To create a WebArchive using the returned data, call initWithData:.

mainResource

- (WebResource *) mainResource

readnonatomicstrong

The main resource of the archive.

subframeArchives

- (NSArray *) subframeArchives

readnonatomiccopy

The archives representing the subframes of the archive (can be nil).

subresources

- (NSArray *) subresources

readnonatomiccopy

The subresource of the archive (can be nil).

---

The documentation for this class was generated from the following files:

• Source/WebKit/mac/WebView/WebArchive.h
• Source/WebKit/mac/WebView/WebArchive.mm
• Source/WebKit/win/WebArchive.cpp