1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corporation.
19 * Portions created by the Initial Developer are Copyright (C) 2003
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Jan Varga <varga@ku.sk>
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either the GNU General Public License Version 2 or later (the "GPL"), or
27 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
36 *
37 * ***** END LICENSE BLOCK ***** */
38
39 #include "nsISupports.idl"
40
41 /**
42 * @status UNDER_DEVELOPMENT
43 */
44
45 interface imgIRequest;
46
47 [scriptable, uuid(7b80eebc-c98e-4461-8bdb-6e3b6e828890)]
48 interface nsIImageDocument : nsISupports {
49
50 /* Whether the pref for image resizing has been set. */
51 readonly attribute boolean imageResizingEnabled;
52
53 /* Whether the image is overflowing visible area. */
54 readonly attribute boolean imageIsOverflowing;
55
56 /* Whether the image has been resized to fit visible area. */
57 readonly attribute boolean imageIsResized;
58
59 /* The image request being displayed in the content area */
60 readonly attribute imgIRequest imageRequest;
61
62 /* Resize the image to fit visible area. */
63 void shrinkToFit();
64
65 /* Restore image original size. */
66 void restoreImage();
67
68 /* Restore the image, trying to keep a certain pixel in the same position.
69 * The coordinate system is that of the shrunken image.
70 */
71 void restoreImageTo(in long x, in long y);
72
73 /* A helper method for switching between states.
74 * The switching logic is as follows. If the image has been resized
75 * restore image original size, otherwise if the image is overflowing
76 * current visible area resize the image to fit the area.
77 */
78 void toggleImageSize();
79 };