nsISHistoryInternal

IID:494fac3c-64f4-41b8-b209-b4ada899613b
Inherits From:nsISupports

This interface is implemented by the following components:


Properties

readonly PRInt32 historyMaxTotalViewers

Max number of total cached content viewers. If the pref browser.sessionhistory.max_total_viewers is negative, then this value is calculated based on the total amount of memory. Otherwise, it comes straight from the pref.

readonly nsISHistoryListener listener

Get handle to the history listener

nsIDocShell rootDocShell

The toplevel docshell object to which this SHistory object belongs to.

readonly nsISHTransaction rootTransaction

Get the root transaction


Methods

void addEntry ( nsISHEntry entry , PRBool persist ) void evictContentViewers ( PRInt32 previousIndex , PRInt32 index ) void replaceEntry ( PRInt32 index , nsISHEntry replaceEntry ) void updateIndex ( )

void addEntry ( nsISHEntry entry , PRBool persist )

Add a new Entry to the History List

Arguments:
entry: - The entry to add
persist: - If true this specifies that the entry should persist in the list. If false, this means that when new entries are added this element will not appear in the session history list.

void evictContentViewers ( PRInt32 previousIndex , PRInt32 index )

Evict content viewers until the number of content viewers per tab is no more than gHistoryMaxViewers. Also, count total number of content viewers globally and evict one if we are over our total max. This is always called in Show(), after we destroy the previous viewer.

Arguments:
previousIndex
index

void replaceEntry ( PRInt32 index , nsISHEntry replaceEntry )

Replace the nsISHEntry at a particular index

Arguments:
index: - The index at which the entry shoud be replaced
replaceEntry: - The replacement entry for the index.

void updateIndex ( )

Update the index maintained by sessionHistory

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com