dom/chrome-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  Exposed=Window]
  15 interface ChildSHistory {
  16   [Pure]
  17   readonly attribute long count;
  18   [Pure]
  19   readonly attribute long index;
  20
  21   boolean canGo(long aOffset);
  22   [Throws] undefined go(long aOffset, optional boolean aRequireUserInteraction = false, optional boolean aUserActivation = false);
  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   undefined reload(unsigned long aReloadFlags);
  30
  31   /**
  32    * Getter for the legacy nsISHistory implementation.
  33    *
  34    * legacySHistory has been deprecated. Don't use it, but instead handle
  35    * the interaction with nsISHistory in the parent process.
  36    */
  37   [Throws]
  38   readonly attribute nsISHistory legacySHistory;
  39 };