Interface nsIWebPageDescriptorType

The nsIWebPageDescriptor interface allows content being displayed in one window to be loaded into another window without refetching it from the network.

Hierarchy

Properties

currentDescriptor

Methods

AddRef QueryInterface Release loadPageAsViewSource

Properties

Readonly currentDescriptor

currentDescriptor: nsISupports

Retrieves the page descriptor for the curent document. @note, currentDescriptor is currently always an nsISHEntry object or null.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

loadPageAsViewSource

  • Tells the object to load the page that otherDocShell is currently loading, or has loaded already, as view source, with the url being aURL.

    Throws

    NS_ERROR_FAILURE - NS_ERROR_INVALID_POINTER

    Parameters

    • otherDocShell: nsIDocShell
    • aURL: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc