WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

@mozilla.org/browser/shistory;1

This component implements the following interfaces:

Constants

This flags defines the range of bits that may be specified.
PRUint32 nsIWebNavigation.LOAD_FLAGS_MASK = 65535
This is the default value for the load flags parameter.
PRUint32 nsIWebNavigation.LOAD_FLAGS_NONE = 0
This flag specifies that the load should have the semantics of an HTML Meta-refresh tag (i.e., that the cache should be bypassed). This flag is only applicable to loadURI. XXX the meaning of this flag is poorly defined. XXX no one uses this, so we should probably deprecate and remove it.
PRUint32 nsIWebNavigation.LOAD_FLAGS_IS_REFRESH = 16
This flag specifies that the load should have the semantics of a link click. This flag is only applicable to loadURI. XXX the meaning of this flag is poorly defined.
PRUint32 nsIWebNavigation.LOAD_FLAGS_IS_LINK = 32
This flag specifies that history should not be updated. This flag is only applicable to loadURI.
PRUint32 nsIWebNavigation.LOAD_FLAGS_BYPASS_HISTORY = 64
This flag specifies that any existing history entry should be replaced. This flag is only applicable to loadURI.
PRUint32 nsIWebNavigation.LOAD_FLAGS_REPLACE_HISTORY = 128
This flag specifies that the local web cache should be bypassed, but an intermediate proxy cache could still be used to satisfy the load.
PRUint32 nsIWebNavigation.LOAD_FLAGS_BYPASS_CACHE = 256
This flag specifies that any intermediate proxy caches should be bypassed (i.e., that the content should be loaded from the origin server).
PRUint32 nsIWebNavigation.LOAD_FLAGS_BYPASS_PROXY = 512
This flag specifies that a reload was triggered as a result of detecting an incorrect character encoding while parsing a previously loaded document.
PRUint32 nsIWebNavigation.LOAD_FLAGS_CHARSET_CHANGE = 1024
If this flag is set, Stop() will be called before the load starts and will stop both content and network activity (the default is to only stop network activity). Effectively, this passes the STOP_CONTENT flag to Stop(), in addition to the STOP_NETWORK flag.
PRUint32 nsIWebNavigation.LOAD_FLAGS_STOP_CONTENT = 2048
A hint this load was prompted by an external program: take care!
PRUint32 nsIWebNavigation.LOAD_FLAGS_FROM_EXTERNAL = 4096
This flag specifies that the URI may be submitted to a third-party server for correction. This should only be applied to non-sensitive URIs entered by users.
PRUint32 nsIWebNavigation.LOAD_FLAGS_ALLOW_THIRD_PARTY_FIXUP = 8192
This flag specifies that this is the first load in this object. Set with care, since setting incorrectly can cause us to assume that nothing was actually loaded in this object if the load ends up being handled by an external application.
PRUint32 nsIWebNavigation.LOAD_FLAGS_FIRST_LOAD = 16384
This flag specifies that the load should not be subject to popup blocking checks.
PRUint32 nsIWebNavigation.LOAD_FLAGS_ALLOW_POPUPS = 32768
This flag specifies that the URI classifier should not be checked for this load.
PRUint32 nsIWebNavigation.LOAD_FLAGS_BYPASS_CLASSIFIER = 65536
This flag specifies that all network activity should be stopped. This includes both active network loads and pending META-refreshes.
PRUint32 nsIWebNavigation.STOP_NETWORK = 1
This flag specifies that all content activity should be stopped. This includes animated images, plugins and pending Javascript timeouts.
PRUint32 nsIWebNavigation.STOP_CONTENT = 2
This flag specifies that all activity should be stopped.
PRUint32 nsIWebNavigation.STOP_ALL = 3

Properties

readonly PRBool nsIWebNavigation.canGoBack

Indicates if the object can go back. If true this indicates that there is back session history available for navigation.

readonly PRBool nsIWebNavigation.canGoForward

Indicates if the object can go forward. If true this indicates that there is forward session history available for navigation

readonly PRInt32 nsISHistory.count

A readonly property of the interface that returns the number of toplevel documents currently available in session history.

readonly nsIURI nsIWebNavigation.currentURI

The currently loaded URI or null.

readonly nsIDOMDocument nsIWebNavigation.document

Retrieves the current DOM document for the frame, or lazily creates a blank document if there is none. This attribute never returns null except for unexpected error situations.

readonly PRInt32 nsISHistory.index

A readonly property of the interface that returns the index of the current document in session history.

readonly nsISHistoryListener nsISHistoryInternal.listener

Get handle to the history listener

PRInt32 nsISHistory.maxLength

A read/write property of the interface, used to Get/Set the maximum number of toplevel documents, session history can hold for each instance.

readonly nsIURI nsIWebNavigation.referringURI

The referring URI for the currently loaded URI or null.

readonly PRInt32 nsISHistory.requestedIndex

A readonly property of the interface that returns the index of the last document that started to load.

nsIDocShell nsISHistoryInternal.rootDocShell

The toplevel docshell object to which this SHistory object belongs to.

readonly nsISHTransaction nsISHistoryInternal.rootTransaction

Get the root transaction

nsISHistory nsIWebNavigation.sessionHistory

The session history object used by this web navigation instance.

readonly nsISimpleEnumerator nsISHistory.SHistoryEnumerator

Called to obtain a enumerator for all the documents stored in session history. The enumerator object thus returned by this method can be traversed using nsISimpleEnumerator.

Methods

InterfaceMethod
nsISHistoryInternal void addEntry ( nsISHEntry entry , PRBool persist )
nsISHistory void addSHistoryListener ( nsISHistoryListener listener )
nsISHistoryInternal void evictContentViewers ( PRInt32 previousIndex , PRInt32 index )
nsISHistoryInternal void evictExpiredContentViewerForEntry ( nsISHEntry entry )
nsISHistory nsIHistoryEntry getEntryAtIndex ( PRInt32 index , PRBool modifyIndex )
nsIWebNavigation void goBack ( )
nsIWebNavigation void goForward ( )
nsIWebNavigation void gotoIndex ( PRInt32 index )
nsIWebNavigation void loadURI ( PRUnichar* URI , PRUint32 loadFlags , nsIURI referrer , nsIInputStream postData , nsIInputStream headers )
nsISHistory void PurgeHistory ( PRInt32 numEntries )
nsIWebNavigation void reload ( PRUint32 reloadFlags )
nsISHistory void removeSHistoryListener ( nsISHistoryListener listener )
nsISHistoryInternal void replaceEntry ( PRInt32 index , nsISHEntry replaceEntry )
nsIWebNavigation void stop ( PRUint32 stopFlags )
nsISHistoryInternal void updateIndex ( )

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com