Back to index

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

import "nsISHistory.idl";

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

List of all members.

Public Member Functions

nsIHistoryEntry getEntryAtIndex (in long index, in boolean modifyIndex)
 Called to obtain handle to the history entry at a given index.
void PurgeHistory (in long numEntries)
 Called to purge older documents from history.
void addSHistoryListener (in nsISHistoryListener aListener)
 Called to register a listener for the session history component.
void removeSHistoryListener (in nsISHistoryListener aListener)
 Called to remove a listener for the session history component.

Public Attributes

readonly attribute long count
 A readonly property of the interface that returns the number of toplevel documents currently available in session history.
readonly attribute long index
 A readonly property of the interface that returns the index of the current document in session history.
attribute long maxLength
 A read/write property of the interface, used to Get/Set the maximum number of toplevel documents, session history can hold for each instance.
readonly attribute
nsISimpleEnumerator 
SHistoryEnumerator
 Called to obtain a enumerator for all the documents stored in session history.

Detailed Description

Definition at line 66 of file nsISHistory.idl.


Member Function Documentation

Called to register a listener for the session history component.

Listeners are notified when pages are loaded or purged from history.

Parameters:
aListenerListener object to be notified for all page loads that initiate in session history.
Note:
A listener object must implement nsISHistoryListener and nsSupportsWeakReference
See also:
nsISHistoryListener
nsSupportsWeakReference

Called to obtain handle to the history entry at a given index.

Parameters:
indexThe index value whose entry is requested.
modifyIndexA boolean flag that indicates if the current index of session history should be modified to the parameter index.
Returns:
NS_OK history entry for the index is obtained successfully. NS_ERROR_FAILURE Error in obtaining history entry for the given index.

Called to purge older documents from history.

Documents can be removed from session history for various reasons. For example to control memory usage of the browser, to prevent users from loading documents from history, to erase evidence of prior page loads etc...

Parameters:
numEntriesThe number of toplevel documents to be purged from history. During purge operation, the latest documents are maintained and older 'numEntries' documents are removed from history.
Exceptions:
<code>NS_SUCCESS_LOSS_OF_INSIGNIFICANT_DATA</code>Purge was vetod.
<code>NS_ERROR_FAILURE</code>numEntries is invalid or out of bounds with the size of history.

Here is the caller graph for this function:

Called to remove a listener for the session history component.

Listeners are notified when pages are loaded from history.

Parameters:
aListenerListener object to be removed from session history.
Note:
A listener object must implement nsISHistoryListener and nsSupportsWeakReference
See also:
nsISHistoryListener
nsSupportsWeakReference

Member Data Documentation

A readonly property of the interface that returns the number of toplevel documents currently available in session history.

Definition at line 73 of file nsISHistory.idl.

A readonly property of the interface that returns the index of the current document in session history.

Definition at line 79 of file nsISHistory.idl.

A read/write property of the interface, used to Get/Set the maximum number of toplevel documents, session history can hold for each instance.

Definition at line 86 of file nsISHistory.idl.

Called to obtain a enumerator for all the documents stored in session history.

The enumerator object thus returned by this method can be traversed using nsISimpleEnumerator.

Note:
To access individual history entries of the enumerator, perform the following steps: 1) Call nsISHistory->GetSHistoryEnumerator() to obtain handle the nsISimpleEnumerator object. 2) Use nsISimpleEnumerator->GetNext() on the object returned by step #1 to obtain handle to the next object in the list. The object returned by this step is of type nsISupports. 3) Perform a QueryInterface on the object returned by step #2 to nsIHistoryEntry. 4) Use nsIHistoryEntry to access properties of each history entry.
See also:
nsISimpleEnumerator
nsIHistoryEntry
QueryInterface()
do_QueryInterface()

Definition at line 173 of file nsISHistory.idl.


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