Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIBrowserHistory Interface Reference

import "nsIBrowserHistory.idl";

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

List of all members.

Public Member Functions

void addPageWithDetails (in nsIURI aURI, in wstring aTitle, in long long aLastVisited)
 addPageWithDetails Adds a page to history with specific time stamp information.
void removePage (in nsIURI aURI)
 remove a page from history
void removePagesFromHost (in AUTF8String aHost, in boolean aEntireDomain)
 removePagesFromHost Remove all pages from the given host.
void removeAllPages ()
 removeAllPages Remove all pages from global history
void hidePage (in nsIURI aURI)
 hidePage Hide the specified URL from being enumerated (and thus displayed in the UI)
void markPageAsTyped (in nsIURI aURI)
 markPageAsTyped Designate the url as having been explicitly typed in by the user, so it's okay to be an autocomplete result.
void removePage (in nsIURI aURI)
 remove a page from history
void removePagesFromHost (in AUTF8String aHost, in boolean aEntireDomain)
 removePagesFromHost Remove all pages from the given host.
void removeAllPages ()
 removeAllPages Remove all pages from global history
void hidePage (in nsIURI aURI)
 hidePage Hide the specified URL from being enumerated (and thus displayed in the UI)
void markPageAsTyped (in nsIURI aURI)
 markPageAsTyped Designate the url as having been explicitly typed in by the user, so it's okay to be an autocomplete result.
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.

Public Attributes

readonly attribute AUTF8String lastPageVisited
 lastPageVisited The last page that was visited in a top-level window.
readonly attribute PRUint32 count
 count The number of entries in global history
readonly attribute unsigned long count
 count The number of entries in global history

Detailed Description

Definition at line 46 of file nsIBrowserHistory.idl.


Member Function Documentation

void nsIBrowserHistory::addPageWithDetails ( in nsIURI  aURI,
in wstring  aTitle,
in long long  aLastVisited 
)

addPageWithDetails Adds a page to history with specific time stamp information.

This is used in the History migrator.

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.

hidePage Hide the specified URL from being enumerated (and thus displayed in the UI)

if the page hasn't been visited yet, then it will be added as if it was visited, and then marked as hidden

hidePage Hide the specified URL from being enumerated (and thus displayed in the UI)

if the page hasn't been visited yet, then it will be added as if it was visited, and then marked as hidden

Checks to see whether the given URI is in history.

Parameters:
aURIthe uri to the page
Returns:
true if a URI has been visited

markPageAsTyped Designate the url as having been explicitly typed in by the user, so it's okay to be an autocomplete result.

markPageAsTyped Designate the url as having been explicitly typed in by the user, so it's okay to be an autocomplete result.

removeAllPages Remove all pages from global history

removeAllPages Remove all pages from global history

remove a page from history

remove a page from history

void nsIBrowserHistory::removePagesFromHost ( in AUTF8String  aHost,
in boolean  aEntireDomain 
)

removePagesFromHost Remove all pages from the given host.

If aEntireDomain is true, will assume aHost is a domain, and remove all pages from the entire domain.

void nsIBrowserHistory::removePagesFromHost ( in AUTF8String  aHost,
in boolean  aEntireDomain 
)

removePagesFromHost Remove all pages from the given host.

If aEntireDomain is true, will assume aHost is a domain, and remove all pages from the entire domain.

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

Member Data Documentation

count The number of entries in global history

Definition at line 63 of file nsIBrowserHistory.idl.

count The number of entries in global history

Definition at line 65 of file nsIBrowserHistory.idl.

lastPageVisited The last page that was visited in a top-level window.

Definition at line 59 of file nsIBrowserHistory.idl.


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