Back to index

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

import "nsIGlobalHistory2.idl";

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

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.

Detailed Description

Definition at line 57 of file nsIGlobalHistory2.idl.


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

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: