Back to index

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

import "nsISHistoryInternal.idl";

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

List of all members.

Public Member Functions

void addEntry (in nsISHEntry aEntry, in boolean aPersist)
 Add a new Entry to the History List.
void updateIndex ()
 Update the index maintained by sessionHistory.
void replaceEntry (in long aIndex, in nsISHEntry aReplaceEntry)
 Replace the nsISHEntry at a particular index.
void evictContentViewers (in long previousIndex, in long index)
 Evict content viewers until the number of content viewers per tab is no more than gHistoryMaxViewers.

Public Attributes

readonly attribute nsISHTransaction rootTransaction
 Get the root transaction.
attribute nsIDocShell rootDocShell
 The toplevel docshell object to which this SHistory object belongs to.
readonly attribute
nsISHistoryListener 
listener
 Get handle to the history listener.
readonly attribute long historyMaxTotalViewers
 Max number of total cached content viewers.

Detailed Description

Definition at line 55 of file nsISHistoryInternal.idl.


Member Function Documentation

Add a new Entry to the History List.

Parameters:
aEntry- The entry to add
aPersist- 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 nsISHistoryInternal::evictContentViewers ( in long  previousIndex,
in long  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.

void nsISHistoryInternal::replaceEntry ( in long  aIndex,
in nsISHEntry  aReplaceEntry 
)

Replace the nsISHEntry at a particular index.

Parameters:
aIndex- The index at which the entry shoud be replaced
aReplaceEntry- The replacement entry for the index.

Update the index maintained by sessionHistory.


Member Data Documentation

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.

Definition at line 108 of file nsISHistoryInternal.idl.

Get handle to the history listener.

Definition at line 91 of file nsISHistoryInternal.idl.

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

Definition at line 74 of file nsISHistoryInternal.idl.

Get the root transaction.

Definition at line 69 of file nsISHistoryInternal.idl.


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