third_party/WebKit/Source/core/frame/History.idl

   1 /*
   2  * Copyright (C) 2007, 2008 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 // https://html.spec.whatwg.org/#the-history-interface
  27
  28 enum ScrollRestoration {"auto", "manual"};
  29
  30 [
  31     GarbageCollected,
  32 ] interface History {
  33     readonly attribute unsigned long length;
  34     // TODO(philipj): The SerializedScriptValue type should be any.
  35     [CachedAttribute=stateChanged] readonly attribute SerializedScriptValue state;
  36     [CallWith=ExecutionContext] void go(optional long delta = 0);
  37     [CallWith=ExecutionContext] void back();
  38     [CallWith=ExecutionContext] void forward();
  39     // TODO(philipj): The SerializedScriptValue types should be any.
  40     // TODO(philipj): The title arguments should simply be 'DOMString title'.
  41     [RaisesException] void pushState(SerializedScriptValue data, [TreatUndefinedAs=NullString] DOMString? title, optional DOMString? url = null);
  42     [RaisesException] void replaceState(SerializedScriptValue data, [TreatUndefinedAs=NullString] DOMString? title, optional DOMString? url = null);
  43
  44     // Experimental Scroll Restoration API
  45     // https://www.chromestatus.com/features/5657284784947200
  46     [RuntimeEnabled=ScrollRestoration] attribute ScrollRestoration scrollRestoration;
  47 };