Back to index

lightning-sunbird  0.9+nobinonly
nsIImageDocument.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2003
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Jan Varga <varga@ku.sk>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISupports.idl"
00040 
00045 interface imgIRequest;
00046 
00047 [scriptable, uuid(7b80eebc-c98e-4461-8bdb-6e3b6e828890)]
00048 interface nsIImageDocument : nsISupports {
00049 
00050   /* Whether the pref for image resizing has been set. */
00051   readonly attribute boolean imageResizingEnabled;
00052 
00053   /* Whether the image is overflowing visible area. */
00054   readonly attribute boolean imageIsOverflowing;
00055 
00056   /* Whether the image has been resized to fit visible area. */
00057   readonly attribute boolean imageIsResized;
00058 
00059   /* The image request being displayed in the content area */
00060   readonly attribute imgIRequest imageRequest;
00061 
00062   /* Resize the image to fit visible area. */
00063   void shrinkToFit();
00064 
00065   /* Restore image original size. */
00066   void restoreImage();
00067 
00068   /* Restore the image, trying to keep a certain pixel in the same position.
00069    * The coordinate system is that of the shrunken image.
00070    */
00071   void restoreImageTo(in long x, in long y);
00072 
00073   /* A helper method for switching between states.
00074    * The switching logic is as follows. If the image has been resized
00075    * restore image original size, otherwise if the image is overflowing
00076    * current visible area resize the image to fit the area.
00077    */
00078   void toggleImageSize();
00079 };