author shindli <>
Sun, 21 Jan 2018 23:57:26 +0200
changeset 400156 5faab9e619901b1513fd4ca137747231be550def
parent 349869 77f83a554db1bd66e4331983ca9895c28dc9e124
child 412750 7dadb3852649b5184bf5960b7565b0f15bee9b09
permissions -rw-r--r--
Merge inbound to mozilla-central. a=merge

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at */

 * interface for container for information saved in session history when
 * the document is not

#include "nsISupports.idl"

interface nsPresState;

[ptr] native nsPresStatePtr(nsPresState);
[ref] native nsCString(const nsCString);
native constBool(const bool);

#include "nsStringFwd.h"

template<typename> struct already_AddRefed;

[scriptable, uuid(aef27cb3-4df9-4eeb-b0b0-ac56cf861d04)]
interface nsILayoutHistoryState : nsISupports
  * Whether this LayoutHistoryState contains any PresStates.
  readonly attribute boolean hasStates;

  * Get the keys of all PresStates held by this LayoutHistoryState.
  * Note: Check hasStates first.
  void getKeys([optional] out uint32_t aCount,
               [array, size_is(aCount), retval] out string aKeys);

  * Attempts to get the data of the PresState corresponding to
  * the passed key. Throws if no data could be found.
  void getPresState(in ACString aKey,
                    out float aScrollX, out float aScrollY,
                    out boolean aAllowScrollOriginDowngrade,
                    out float aRes, out boolean aScaleToRes);

   * Constructs a new nsPresState object based on the supplied data
   * and adds it to the LayoutHistoryState.
  void addNewPresState(in ACString aKey,
                   in float aScrollX, in float aScrollY,
                   in boolean aAllowScrollOriginDowngrade,
                   in float aRes, in boolean aScaleToRes);

  // Native only interface, converted from the original nsILayoutHistoryState.h

   * Set |aState| as the state object for |aKey|.
   * This _transfers_ownership_ of |aState| to the LayoutHistoryState.
   * It will be freed when RemoveState() is called or when the
   * LayoutHistoryState is destroyed.
  [noscript, notxpcom, nostdcall] void AddState(in nsCString aKey, in nsPresStatePtr aState);

   * Look up the state object for |aKey|.
  [noscript, notxpcom, nostdcall] nsPresStatePtr GetState(in nsCString aKey);

   * Remove the state object for |aKey|.
  [noscript, notxpcom, nostdcall] void RemoveState(in nsCString aKey);

   * Check whether this history has any states in it
  [noscript, notxpcom, nostdcall] boolean HasStates();

   * Sets whether this history can contain only scroll position history
   * or all possible history
  [noscript, notxpcom, nostdcall] void SetScrollPositionOnly(in constBool aFlag);

   * Resets nsPresState::GetScrollState of all nsPresState objects to 0,0.
  [noscript, notxpcom, nostdcall] void ResetScrollState();