Public Member Functions

nsIGlobalHistory2 Interface Reference

import "nsIGlobalHistory2.idl";

Inheritance diagram for nsIGlobalHistory2:

List of all members.

Public Member Functions

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.

Member Function Documentation

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

Add a URI to global history.

Parameters:
aURI the URI of the page
aRedirect whether the URI was redirected to another location; this is 'true' for the original URI which is redirected.
aToplevel whether the URI is loaded in a top-level window
aReferrer the 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.
boolean nsIGlobalHistory2::isVisited ( in nsIURI  aURI  ) 

Checks to see whether the given URI is in history.

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

Set the page title for the given uri.

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

Parameters:
aURI the URI for which to set to the title
aTitle the page title

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