dom/webidl/ScrollBoxObject.webidl
author Mike de Boer <mdeboer@mozilla.com>
Fri, 10 Apr 2015 13:23:14 +0200
changeset 267072 719d7e41abeac7fee33b6d7ab4676ed6b537c3af
parent 236870 8d3304b7e0e0b2b8fd607c8320436b415e8d4cae
child 482628 058b07756df6e4e2530aa1847936dae16dddd58c
permissions -rw-r--r--
Bug 1132301 - Part 5: Add unit tests for the Social Sharing feature of Loop. r=Standard8, a=lizzard

/* -*- 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 http://mozilla.org/MPL/2.0/.
 */

[NoInterfaceObject]
interface ScrollBoxObject : BoxObject {

  /**
   * Scroll to the given coordinates, in css pixels.
   * (0,0) will put the top left corner of the scrolled element's padding-box
   * at the top left corner of the scrollport (which is its inner-border-box).
   * Values will be clamped to legal values.
   */
  [Throws]
  void scrollTo(long x, long y);

  /**
   * Scroll the given amount of device pixels to the right and down.
   * Values will be clamped to make the resuling position legal.
   */
  [Throws]
  void scrollBy(long dx, long dy);
  [Throws]
  void scrollByLine(long dlines);
  [Throws]
  void scrollByIndex(long dindexes);
  [Throws]
  void scrollToLine(long line);
  [Throws]
  void scrollToElement(Element child);
  [Throws]
  void scrollToIndex(long index);

  /**
   * Get the current scroll position in css pixels.
   * @see scrollTo for the definition of x and y.
   */
  [Pure, Throws]
  readonly attribute long positionX;
  [Pure, Throws]
  readonly attribute long positionY;
  [Pure, Throws]
  readonly attribute long scrolledWidth;
  [Pure, Throws]
  readonly attribute long scrolledHeight;

  /**
   * DEPRECATED: Please use positionX and positionY
   *
   * Get the current scroll position in css pixels.
   * @see scrollTo for the definition of x and y.
   */
  [Throws]
  void getPosition(object x, object y);

  /**
   * DEPRECATED: Please use scrolledWidth and scrolledHeight
   */
  [Throws]
  void getScrolledSize(object width, object height);

  [Throws]
  void ensureElementIsVisible(Element child);
  [Throws]
  void ensureIndexIsVisible(long index);
  [Throws]
  void ensureLineIsVisible(long line);
};