Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
nsHistory Class Reference

#include <nsHistory.h>

Inheritance diagram for nsHistory:
Inheritance graph
Collaboration diagram for nsHistory:
Collaboration graph

List of all members.

Public Member Functions

 nsHistory (nsIDocShell *aDocShell)
virtual ~nsHistory ()
SetDocShell (nsIDocShell *aDocShell)
void back ()
void forward ()
void go (in long aDelta)
DOMString item (in unsigned long index)
void go ()
 go() can be called with an integer argument or no arguments (a nop) from JS

Public Attributes

readonly attribute long length
readonly attribute DOMString current
readonly attribute DOMString previous
readonly attribute DOMString next

Protected Member Functions

nsresult GetSessionHistoryFromDocShell (nsIDocShell *aDocShell, nsISHistory **aReturn)

Protected Attributes


Detailed Description

Definition at line 50 of file nsHistory.h.

Constructor & Destructor Documentation

Definition at line 64 of file nsHistory.cpp.

                                           : mDocShell(aDocShell)
nsHistory::~nsHistory ( ) [virtual]

Definition at line 68 of file nsHistory.cpp.


Member Function Documentation

void nsIDOMHistory::back ( ) [inherited]
void nsIDOMHistory::forward ( ) [inherited]
nsresult nsHistory::GetSessionHistoryFromDocShell ( nsIDocShell aDocShell,
nsISHistory **  aReturn 
) [protected]

Definition at line 340 of file nsHistory.cpp.


  /* The docshell we have may or may not be
   * the root docshell. So, get a handle to
   * SH from the root docshell
  // QI mDocShell to nsIDocShellTreeItem
  nsCOMPtr<nsIDocShellTreeItem> dsTreeItem(do_QueryInterface(mDocShell));

  // Get the root DocShell from it
  nsCOMPtr<nsIDocShellTreeItem> root;
  //QI root to nsIWebNavigation
  nsCOMPtr<nsIWebNavigation>   webNav(do_QueryInterface(root));

  //Get  SH from nsIWebNavigation
  return webNav->GetSessionHistory(aReturn);

Here is the call graph for this function:

void nsIDOMNSHistory::go ( ) [inherited]

go() can be called with an integer argument or no arguments (a nop) from JS

void nsIDOMHistory::go ( in long  aDelta) [inherited]
DOMString nsIDOMHistory::item ( in unsigned long  index) [inherited]

Definition at line 87 of file nsHistory.cpp.

  mDocShell = aDocShell; // Weak Reference

Member Data Documentation

readonly attribute DOMString nsIDOMHistory::current [inherited]

Definition at line 46 of file nsIDOMHistory.idl.

readonly attribute long nsIDOMHistory::length [inherited]

Definition at line 45 of file nsIDOMHistory.idl.

Definition at line 72 of file nsHistory.h.

readonly attribute DOMString nsIDOMHistory::next [inherited]

Definition at line 48 of file nsIDOMHistory.idl.

readonly attribute DOMString nsIDOMHistory::previous [inherited]

Definition at line 47 of file nsIDOMHistory.idl.

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