layout/base/nsImageLoader.h

   1 /* -*- Mode: C++; tab-width: 2; 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 mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 2001
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Stuart Parmenter <pavlov@netscape.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 /* class to notify frames of background image loads */
  41
  42 #include "nsStubImageDecoderObserver.h"
  43
  44 class nsPresContext;
  45 class nsIFrame;
  46 class nsIURI;
  47
  48 #include "imgIRequest.h"
  49 #include "nsCOMPtr.h"
  50
  51 class nsImageLoader : public nsStubImageDecoderObserver
  52 {
  53 public:
  54   nsImageLoader();
  55   virtual ~nsImageLoader();
  56
  57   NS_DECL_ISUPPORTS
  58
  59   // imgIDecoderObserver (override nsStubImageDecoderObserver)
  60   NS_IMETHOD OnStartContainer(imgIRequest *aRequest, imgIContainer *aImage);
  61   NS_IMETHOD OnStopFrame(imgIRequest *aRequest, gfxIImageFrame *aFrame);
  62   // Do not override OnDataAvailable since background images are not
  63   // displayed incrementally; they are displayed after the entire image
  64   // has been loaded.
  65   // Note: Images referenced by the <img> element are displayed
  66   // incrementally in nsImageFrame.cpp.
  67
  68   // imgIContainerObserver (override nsStubImageDecoderObserver)
  69   NS_IMETHOD FrameChanged(imgIContainer *aContainer, gfxIImageFrame *newframe,
  70                           nsRect * dirtyRect);
  71
  72   void Init(nsIFrame *aFrame, nsPresContext *aPresContext,
  73             PRBool aReflowOnLoad);
  74   nsresult Load(imgIRequest *aImage);
  75
  76   void Destroy();
  77
  78   nsIFrame *GetFrame() { return mFrame; }
  79   imgIRequest *GetRequest() { return mRequest; }
  80
  81 private:
  82   void RedrawDirtyFrame(const nsRect* aDamageRect);
  83
  84 private:
  85   nsIFrame *mFrame;
  86   nsPresContext *mPresContext;
  87   nsCOMPtr<imgIRequest> mRequest;
  88   PRBool mReflowOnLoad;
  89 };