docshell/base/nsITextScroll.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsISupports.idl"
   8
   9 /**
  10  * The nsITextScroll is an interface that can be implemented by a control that
  11  * supports text scrolling.
  12  */
  13
  14 [scriptable, uuid(067B28A0-877F-11d3-AF7E-00A024FFC08C)]
  15 interface nsITextScroll : nsISupports
  16 {
  17   /**
  18    * Scroll the view up or down by aNumLines lines. positive
  19    * values move down in the view. Prevents scrolling off the
  20    * end of the view.
  21    * @param numLines number of lines to scroll the view by
  22    */
  23         void scrollByLines(in long numLines);
  24
  25         /**
  26    * Scroll the view up or down by numPages pages. a page
  27    * is considered to be the amount displayed by the clip view.
  28    * positive values move down in the view. Prevents scrolling
  29    * off the end of the view.
  30    * @param numPages number of pages to scroll the view by
  31    */
  32         void scrollByPages(in long numPages);
  33 };