gecko-dev/dom/interfaces/base/nsIDOMHistory.idl

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2000
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Vidur Apparao <vidur@netscape.com> (original author)
 *   Johnny Stenback <jst@netscape.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "domstubs.idl"

%{ C++
struct JSContext;
%}

interface nsIVariant;

[scriptable, uuid(d5a3006b-dd6b-4ba3-81be-6559f8889e60)]
interface nsIDOMHistory : nsISupports
{
  readonly attribute long             length;
  readonly attribute DOMString        current;
  readonly attribute DOMString        previous;
  readonly attribute DOMString        next;

  void                       back();
  void                       forward();

  void                       go([optional] in long aDelta);
  DOMString                  item(in unsigned long index);
  [implicit_jscontext]
  void                       pushState(in nsIVariant aData,
                                       in DOMString aTitle,
                                       [optional] in DOMString aURL);
  [implicit_jscontext]
  void                       replaceState(in nsIVariant aData,
                                          in DOMString aTitle,
                                          [optional] in DOMString aURL);

  readonly attribute nsIVariant state;
};