Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsISHEntry_MOZILLA_1_8_BRANCH2 Interface Reference

import "nsISHEntry.idl";

Inheritance diagram for nsISHEntry_MOZILLA_1_8_BRANCH2:
Inheritance graph
[legend]
Collaboration diagram for nsISHEntry_MOZILLA_1_8_BRANCH2:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void create_MOZILLA_1_8_BRANCH (in nsIURI URI, in AString title, in nsIInputStream inputStream, in nsILayoutHistoryState layoutHistoryState, in nsISupports cacheKey, in ACString contentType, in nsISupports owner)
void setURI (in nsIURI aURI)
 URI for the document.
void getViewerBounds (in 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.
void setViewerBounds ([const ] in nsRect bounds)
void addChildShell (in nsIDocShellTreeItem shell)
 Saved child docshells corresponding to contentViewer.
nsIDocShellTreeItem childShellAt (in long index)
 Get the child shell at |index|; returns null if |index| is out of bounds.
void clearChildShells ()
 Clear the child shell list.
void syncPresentationState ()
 Ensure that the cached presentation members are self-consistent.
void setTitle (in AString aTitle)
 Title for the document.
void setScrollPosition (in long x, in long y)
 Set/Get scrollers' positon in anchored pages.
void getScrollPosition (out long x, out long y)
void create (in nsIURI URI, in AString title, in nsIInputStream inputStream, in nsILayoutHistoryState layoutHistoryState, in nsISupports cacheKey, in ACString contentType)
 Additional ways to create an entry.
nsISHEntry clone ()
void setIsSubFrame (in boolean aFlag)
 Attribute that indicates if this entry is for a subframe navigation.
nsIContentViewer getAnyContentViewer (out nsISHEntry ownerEntry)
 Return any content viewer present in or below this node in the nsSHEntry tree.

Public Attributes

attribute nsIURI ownerURI
 A URI representation of the owner, if that's possible.
readonly attribute nsISupports owner
 Get the owner, if any, that was associated with the channel that the document that was loaded to create this history entry came from.
attribute nsIURI referrerURI
 Referrer URI.
attribute nsIContentViewer contentViewer
 Content viewer, for fast restoration of presentation.
attribute boolean sticky
 Whether the content viewer is marked "sticky".
attribute nsISupports windowState
 Saved state of the global window object.
attribute nsISupportsArray refreshURIList
 Saved refresh URI list for the content viewer.
attribute nsIInputStream postData
 Post Data for the document.
attribute nsILayoutHistoryState layoutHistoryState
 LayoutHistoryState for scroll position and form values.
attribute nsISHEntry parent
 parent of this entry
attribute unsigned long loadType
 The loadType for this entry.
attribute unsigned long ID
 An ID to help identify this entry from others during subframe navigation.
attribute unsigned long 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).
attribute nsISupports cacheKey
 attribute to set and get the cache key for the entry
attribute boolean saveLayoutStateFlag
 attribute to indicate whether layoutHistoryState should be saved
attribute boolean expirationStatus
 attribute to indicate whether the page is already expired in cache
attribute ACString contentType
 attribute to indicate the content-type of the document that this is a session history entry for
readonly attribute nsIURI URI
 A readonly property that returns the URI of the current entry.
readonly attribute wstring title
 A readonly property that returns the title of the current entry.
readonly attribute boolean isSubFrame
 A readonly property that returns a boolean flag which indicates if the entry was created as a result of a subframe navigation.

Detailed Description

Definition at line 204 of file nsISHEntry.idl.


Member Function Documentation

Saved child docshells corresponding to contentViewer.

The child shells are restored as children of the parent docshell, in this order, when the parent docshell restores a saved presentation. Append a child shell to the end of our list.

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

Clear the child shell list.

nsISHEntry nsISHEntry::clone ( ) [inherited]
void nsISHEntry::create ( in nsIURI  URI,
in AString  title,
in nsIInputStream  inputStream,
in nsILayoutHistoryState  layoutHistoryState,
in nsISupports  cacheKey,
in ACString  contentType 
) [inherited]

Additional ways to create an entry.

void nsISHEntry_MOZILLA_1_8_BRANCH::create_MOZILLA_1_8_BRANCH ( in nsIURI  URI,
in AString  title,
in nsIInputStream  inputStream,
in nsILayoutHistoryState  layoutHistoryState,
in nsISupports  cacheKey,
in ACString  contentType,
in nsISupports  owner 
) [inherited]

Return any content viewer present in or below this node in the nsSHEntry tree.

This will differ from contentViewer in the case where a child nsSHEntry has the content viewer for this tree.

void nsISHEntry::getScrollPosition ( out long  x,
out long  y 
) [inherited]
void nsISHEntry::getViewerBounds ( in nsRect  bounds) [inherited]

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.

void nsISHEntry::setIsSubFrame ( in boolean  aFlag) [inherited]

Attribute that indicates if this entry is for a subframe navigation.

void nsISHEntry::setScrollPosition ( in long  x,
in long  y 
) [inherited]

Set/Get scrollers' positon in anchored pages.

void nsISHEntry::setTitle ( in AString  aTitle) [inherited]

Title for the document.

void nsISHEntry::setURI ( in nsIURI  aURI) [inherited]

URI for the document.

void nsISHEntry::setViewerBounds ( [const ] in nsRect  bounds) [inherited]

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.


Member Data Documentation

attribute nsISupports nsISHEntry::cacheKey [inherited]

attribute to set and get the cache key for the entry

Definition at line 150 of file nsISHEntry.idl.

attribute ACString nsISHEntry::contentType [inherited]

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

Definition at line 162 of file nsISHEntry.idl.

Content viewer, for fast restoration of presentation.

Definition at line 68 of file nsISHEntry.idl.

attribute to indicate whether the page is already expired in cache

Definition at line 156 of file nsISHEntry.idl.

attribute unsigned long nsISHEntry::ID [inherited]

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

Definition at line 137 of file nsISHEntry.idl.

A readonly property that returns a boolean flag which indicates if the entry was created as a result of a subframe navigation.

This flag will be 'false' when a frameset page is visited for the first time. This flag will be 'true' for all history entries created as a result of a subframe navigation.

Definition at line 79 of file nsIHistoryEntry.idl.

LayoutHistoryState for scroll position and form values.

Definition at line 122 of file nsISHEntry.idl.

attribute unsigned long nsISHEntry::loadType [inherited]

The loadType for this entry.

This is typically loadHistory except when reload is pressed, it has the appropriate reload flag

Definition at line 131 of file nsISHEntry.idl.

readonly attribute nsISupports nsISHEntry_MOZILLA_1_8_BRANCH::owner [inherited]

Get the owner, if any, that was associated with the channel that the document that was loaded to create this history entry came from.

Definition at line 200 of file nsISHEntry.idl.

A URI representation of the owner, if that's possible.

Definition at line 209 of file nsISHEntry.idl.

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).

Definition at line 147 of file nsISHEntry.idl.

parent of this entry

Definition at line 125 of file nsISHEntry.idl.

Post Data for the document.

Definition at line 119 of file nsISHEntry.idl.

Referrer URI.

Definition at line 65 of file nsISHEntry.idl.

Saved refresh URI list for the content viewer.

Definition at line 104 of file nsISHEntry.idl.

attribute to indicate whether layoutHistoryState should be saved

Definition at line 153 of file nsISHEntry.idl.

Whether the content viewer is marked "sticky".

Definition at line 71 of file nsISHEntry.idl.

readonly attribute wstring nsIHistoryEntry::title [inherited]

A readonly property that returns the title of the current entry.

The object returned is a encoded string

Definition at line 68 of file nsIHistoryEntry.idl.

readonly attribute nsIURI nsIHistoryEntry::URI [inherited]

A readonly property that returns the URI of the current entry.

The object returned is of type nsIURI

Definition at line 61 of file nsIHistoryEntry.idl.

attribute nsISupports nsISHEntry::windowState [inherited]

Saved state of the global window object.

Definition at line 74 of file nsISHEntry.idl.


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