dom/webidl/ChildSHistory.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  */
   6
   7 interface nsISHistory;
   8
   9 /**
  10  * The ChildSHistory interface represents the child side of a browsing
  11  * context's session history.
  12  */
  13 [ChromeOnly]
  14 interface ChildSHistory {
  15   [Pure]
  16   readonly attribute long count;
  17   [Pure]
  18   readonly attribute long index;
  19
  20   boolean canGo(long aOffset);
  21   [Throws]
  22   void go(long aOffset);
  23
  24   /**
  25    * Reload the current entry. The flags which should be passed to this
  26    * function are documented and defined in nsIWebNavigation.idl
  27    */
  28   [Throws]
  29   void reload(unsigned long aReloadFlags);
  30
  31   /**
  32    * Getter for the legacy nsISHistory implementation.
  33    *
  34    * This getter _will be going away_, but is needed while we finish
  35    * implementing all of the APIs which we will need in the content
  36    * process on ChildSHistory.
  37    */
  38   readonly attribute nsISHistory legacySHistory;
  39 };