nsIBrowserHistory Interface Reference

import "nsIBrowserHistory.idl";

Inherits nsIGlobalHistory2.

Collaboration diagram for nsIBrowserHistory:

[legend]

List of all members.

Public Member Functions
void	addPageWithDetails (in nsIURI aURI, in wstring aTitle, in long long aLastVisited)
void	removePage (in nsIURI aURI)
void	removePages ([array, size_is(aLength)] in nsIURI aURIs, in unsigned long aLength, in boolean aDoBatchNotify)
void	removePagesFromHost (in AUTF8String aHost, in boolean aEntireDomain)
void	removePagesByTimeframe (in long long aBeginTime, in long long aEndTime)
void	removeAllPages ()
void	hidePage (in nsIURI aURI)
void	markPageAsTyped (in nsIURI aURI)
Public Attributes
readonly attribute AUTF8String	lastPageVisited
readonly attribute PRUint32	count

---

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 nsIBrowserHistory::hidePage

(

in nsIURI

aURI

)

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

void nsIBrowserHistory::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 nsIBrowserHistory::removeAllPages

(

)

removeAllPages

Remove all pages from global history

void nsIBrowserHistory::removePage

(

in nsIURI

aURI

)

removePage

Remove a page from history

void nsIBrowserHistory::removePages	(	[array, size_is(aLength)] in nsIURI	aURIs,
		in unsigned long	aLength,
		in boolean	aDoBatchNotify
	)

removePages

Remove a bunch of pages from history Notice that this does not call observers for performance reasons, instead setting aDoBatchNotify true will send Begin/EndUpdateBatch

void nsIBrowserHistory::removePagesByTimeframe	(	in long long	aBeginTime,
		in long long	aEndTime
	)

removePagesByTimeframe

Remove all pages for a given timeframe. Limits are included: aBeginTime <= timeframe <= aEndTime Notice that this does not call observers for single deleted uris, instead it will send Begin/EndUpdateBatch

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. Notice that this does not call observers for single deleted uris, instead it will send Begin/EndUpdateBatch

---

Member Data Documentation

readonly attribute PRUint32 nsIBrowserHistory::count

count

Indicate if there are entries in global history For performance reasons this does not return the real number of entries

Definition at line 69 of file nsIBrowserHistory.idl.

readonly attribute AUTF8String nsIBrowserHistory::lastPageVisited

lastPageVisited

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

Definition at line 61 of file nsIBrowserHistory.idl.

---

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

• /Users/dietrich/moz/trunk/mozilla/toolkit/components/places/public/nsIBrowserHistory.idl