nsIGlobalHistory3 Interface Reference

import "nsIGlobalHistory3.idl";

Collaboration diagram for nsIGlobalHistory3:

List of all members.

Public Member Functions

void addDocumentRedirect (in nsIChannel aOldChannel, in nsIChannel aNewChannel, in PRInt32 aFlags, in boolean aTopLevel)

unsigned long getURIGeckoFlags (in nsIURI aURI)

void setURIGeckoFlags (in nsIURI aURI, in unsigned long aFlags)

Detailed Description

Provides information about global history to gecko, extending GlobalHistory2

Definition at line 54 of file nsIGlobalHistory3.idl.

Member Function Documentation

void nsIGlobalHistory3::addDocumentRedirect	(	in nsIChannel	aOldChannel,
		in nsIChannel	aNewChannel,
		in PRInt32	aFlags,
		in boolean	aTopLevel
	)

Notifies the history system that the page loading via aOldChannel redirected to aNewChannel. Implementations should generally add the URI for aOldChannel to history for link coloring, but are advised not to expose it in the history user interface. This function is preferred if nsIGlobalHistory3 is available. Otherwise, nsIGlobalHistory2.addURI should be called with redirect=true.

This function is preferred to nsIGlobalHistory2.addURI because it provides more information (including the redirect destination, channels involved, and redirect flags) to the history implementation.

For implementors of nsIGlobalHistory3: The history implementation is responsible for sending NS_LINK_VISITED_EVENT_TOPIC to observers for redirect pages. This notification must be sent for history consumers for all non-redirect pages.

Parameters:

aToplevel

whether the URI is loaded in a top-level window. If false, the load is in a subframe.

The other params to this function are the same as those for nsIChannelEventSink::OnChannelRedirect.

Note: Implementors who wish to implement this interface but rely on nsIGlobalHistory2.addURI for redirect processing may throw NS_ERROR_NOT_IMPLEMENTED from this method. If they do so, then callers must call nsIGlobalHistory2.addURI upon getting the NS_ERROR_NOT_IMPLEMENTED result.

unsigned long nsIGlobalHistory3::getURIGeckoFlags ( in nsIURI aURI )

Get the Gecko flags for this URI. These flags are used by Gecko as hints to optimize page loading. Not all histories have them; this need not be supported (just return NS_ERROR_NOT_IMPLEMENTED. These flags are opaque and should not be interpreted by the history engine.

void nsIGlobalHistory3::setURIGeckoFlags	(	in nsIURI	aURI,
		in unsigned long	aFlags
	)

Set the Gecko flags for this URI. May fail if the history entry doesn't have any flags or if there is no entry for the URI.

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

/Users/dietrich/moz/trunk/mozilla/docshell/base/nsIGlobalHistory3.idl


Public Member Functions
void	addDocumentRedirect (in nsIChannel aOldChannel, in nsIChannel aNewChannel, in PRInt32 aFlags, in boolean aTopLevel)
unsigned long	getURIGeckoFlags (in nsIURI aURI)
void	setURIGeckoFlags (in nsIURI aURI, in unsigned long aFlags)