Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIGlobalHistory3 Interface Reference

Provides information about global history to gecko, extending GlobalHistory2. More...

import "nsIGlobalHistory3.idl";

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

List of all members.

Public Member Functions

void 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.
void addURI (in nsIURI aURI, in boolean aRedirect, in boolean aToplevel, in nsIURI aReferrer)
 Add a URI to global history.
boolean isVisited (in nsIURI aURI)
 Checks to see whether the given URI is in history.
void setPageTitle (in nsIURI aURI, in AString aTitle)
 Set the page title for the given uri.

Detailed Description

Provides information about global history to gecko, extending GlobalHistory2.

Definition at line 47 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:
aToplevelwhether 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.

void nsIGlobalHistory2::addURI ( in nsIURI  aURI,
in boolean  aRedirect,
in boolean  aToplevel,
in nsIURI  aReferrer 
) [inherited]

Add a URI to global history.

Parameters:
aURIthe URI of the page
aRedirectwhether the URI was redirected to another location; this is 'true' for the original URI which is redirected.
aToplevelwhether the URI is loaded in a top-level window
aReferrerthe URI of the referring page
Note:
Docshell will not filter out URI schemes like chrome: data: about: and view-source:. Embedders should consider filtering out these schemes and others, e.g. mailbox: for the main URI and the referrer.

Checks to see whether the given URI is in history.

Parameters:
aURIthe uri to the page
Returns:
true if a URI has been visited
void nsIGlobalHistory2::setPageTitle ( in nsIURI  aURI,
in AString  aTitle 
) [inherited]

Set the page title for the given uri.

URIs that are not already in global history will not be added.

Parameters:
aURIthe URI for which to set to the title
aTitlethe page title

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