1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
2 *
3 * ***** BEGIN LICENSE BLOCK *****
4 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 1.1 (the "License"); you may not use this file except in compliance with
8 * the License. You may obtain a copy of the License at
9 * http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * The Original Code is the Mozilla browser.
17 *
18 * The Initial Developer of the Original Code is
19 * Netscape Communications, Inc.
20 * Portions created by the Initial Developer are Copyright (C) 1999
21 * the Initial Developer. All Rights Reserved.
22 *
23 * Contributor(s):
24 * Travis Bogard <travis@netscape.com>
25 * Steve Clark <buster@netscape.com>
26 *
27 * Alternatively, the contents of this file may be used under the terms of
28 * either of the GNU General Public License Version 2 or later (the "GPL"),
29 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
30 * in which case the provisions of the GPL or the LGPL are applicable instead
31 * of those above. If you wish to allow use of your version of this file only
32 * under the terms of either the GPL or the LGPL, and not to allow others to
33 * use your version of this file under the terms of the MPL, indicate your
34 * decision by deleting the provisions above and replace them with the notice
35 * and other provisions required by the GPL or the LGPL. If you do not delete
36 * the provisions above, a recipient may use your version of this file under
37 * the terms of any one of the MPL, the GPL or the LGPL.
38 *
39 * ***** END LICENSE BLOCK ***** */
40
41 #include "nsISupports.idl"
42
43 /**
44 * The nsITextScroll is an interface that can be implemented by a control that
45 * supports text scrolling.
46 */
47
48 [scriptable, uuid(067B28A0-877F-11d3-AF7E-00A024FFC08C)]
49 interface nsITextScroll : nsISupports
50 {
51 /**
52 * Scroll the view up or down by aNumLines lines. positive
53 * values move down in the view. Prevents scrolling off the
54 * end of the view.
55 * @param numLines number of lines to scroll the view by
56 */
57 void scrollByLines(in long numLines);
58
59 /**
60 * Scroll the view up or down by numPages pages. a page
61 * is considered to be the amount displayed by the clip view.
62 * positive values move down in the view. Prevents scrolling
63 * off the end of the view.
64 * @param numPages number of pages to scroll the view by
65 */
66 void scrollByPages(in long numPages);
67 };