nsISHEntry

IID:542a98b9-2889-4922-aaf4-02b6056f4136
Inherits From:nsIHistoryEntry

This interface is implemented by the following components:


Properties

nsISupports cacheKey

ACString contentType

Attribute to indicate the content-type of the document that this is a session history entry for

nsIContentViewer contentViewer

PRBool expirationStatus

PRUint32 ID

An ID to help identify this entry from others during subframe navigation

nsILayoutHistoryState layoutHistoryState

PRUint32 loadType

The loadType for this entry. This is typically loadHistory except when reload is pressed, it has the appropriate reload flag

PRUint32 pageIdentifier

PageIdentifier is an integer that should be the same for two entries attached to the same docshell only if the two entries are entries for the same page in the sense that one could go from the state represented by one to the state represented by the other simply by scrolling (so the entries are separated by an anchor traversal or a subframe navigation in some other frame).

nsISHEntry parent

nsIInputStream postData

nsIURI referrerURI

nsISupportsArray refreshURIList

PRBool saveLayoutStateFlag

PRBool sticky

nsISupports windowState


Methods

void addChildShell ( nsIDocShellTreeItem shell ) nsIDocShellTreeItem childShellAt ( PRInt32 index ) void clearChildShells ( ) nsISHEntry clone ( ) void create ( nsIURI URI , AString title , nsIInputStream inputStream , nsILayoutHistoryState layoutHistoryState , nsISupports cacheKey , ACString contentType ) nsIContentViewer getAnyContentViewer ( out nsISHEntry ownerEntry ) void getScrollPosition ( out PRInt32 x , out PRInt32 y ) [noscript] void getViewerBounds ( nsRect bounds ) void setIsSubFrame ( PRBool flag ) void setScrollPosition ( PRInt32 x , PRInt32 y ) void setTitle ( AString title ) void setURI ( nsIURI URI ) [noscript] void setViewerBounds ( nsRect bounds ) void syncPresentationState ( )

void addChildShell ( nsIDocShellTreeItem shell )

Arguments:
shell

nsIDocShellTreeItem childShellAt ( PRInt32 index )

Get the child shell at index; returns null if index is out of bounds.

Arguments:
index

void clearChildShells ( )

Clear the child shell list.


nsISHEntry clone ( )


void create ( nsIURI URI , AString title , nsIInputStream inputStream , nsILayoutHistoryState layoutHistoryState , nsISupports cacheKey , ACString contentType )

Arguments:
URI
title
inputStream
layoutHistoryState
cacheKey
contentType

nsIContentViewer getAnyContentViewer ( out nsISHEntry ownerEntry )

Return any content viewer present in or below this node in the nsSHEntry tree. This will differ from contentViewer in the case

Arguments:
ownerEntry

void getScrollPosition ( out PRInt32 x , out PRInt32 y )

Arguments:
x
y

void getViewerBounds ( nsRect bounds )

Saved position and dimensions of the content viewer; we must adjust the root view's widget accordingly if this has changed when the presentation is restored.

Arguments:
bounds

void setIsSubFrame ( PRBool flag )

Arguments:
flag

void setScrollPosition ( PRInt32 x , PRInt32 y )

Arguments:
x
y

void setTitle ( AString title )

Arguments:
title

void setURI ( nsIURI URI )

Arguments:
URI

void setViewerBounds ( nsRect bounds )

Arguments:
bounds

void syncPresentationState ( )

Ensure that the cached presentation members are self-consistent. If either contentViewer or windowState are null, then all of the following members are cleared/reset: contentViewer, sticky, windowState, viewerBounds, childShells, refreshURIList.


References

This interface is the type of the following properties:

nsIDocShellLoadInfo.SHEntry, nsISHEntry.parent, nsISHTransaction.sHEntry

This interface is passed as an argument to the following methods:

nsIContentViewer.close, nsIDocShell.internalLoad, nsIDocShellHistory.addChildSHEntry, nsISHContainer.AddChild, nsISHContainer.RemoveChild, nsISHEntry.getAnyContentViewer, nsISHTransaction.create, nsISHistoryInternal.addEntry, nsISHistoryInternal.replaceEntry

This interface is returned from the following methods:

nsIDocShellHistory.getChildSHEntry, nsISHContainer.GetChildAt, nsISHEntry.clone

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com