author Honza Bambas <>
Tue, 10 Aug 2010 20:11:57 -0700
changeset 49375 18cd465199df7cc9fe5d64666162f3a569aeb268
parent 42263 7ef2a4732afe3ebc09763d3d0e2fa070328e5a5f
child 52149 fd33aa85de93cd0ff059b48f40b28d67438804b8
permissions -rw-r--r--
Bug 536294 - e10s HTTP: redirects. r=jduell

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 * The Original Code is code.
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2001
 * the Initial Developer. All Rights Reserved.
 * Contributor(s):
 *   Stuart Parmenter <>
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"
#include "nsIRequest.idl"

interface imgIContainer;
interface imgIDecoderObserver;
interface nsIURI;
interface nsIPrincipal;

 * imgIRequest interface
 * @author Stuart Parmenter <>
 * @version 0.1
 * @see imagelib2
[scriptable, uuid(ebde51c9-cc11-4b6a-99c3-d7f568c7481b)]
interface imgIRequest : nsIRequest
   * the image container...
   * @return the image object associated with the request.
   * @attention NEED DOCS
  readonly attribute imgIContainer image;

   * Bits set in the return value from imageStatus
   * @name statusflags
   * Meanings:
   * STATUS_NONE: Nothing to report.
   * STATUS_SIZE_AVAILABLE: We received enough image data
   * from the network or filesystem that we know the width
   * and height of the image, and have thus called SetSize()
   * on the container.
   * STATUS_LOAD_PARTIAL: Used internally by imgRequest to
   * flag that a request is being cancelled as a result of
   * a failure of a proxy holder and not an internal failure.
   * At least I think that's what it does. Regardless, there's
   * no reason for this flag to be public, and it should either
   * go away or become a private state flag within imgRequest.
   * Don't rely on it.
   * STATUS_LOAD_COMPLETE: The data has been fully loaded
   * to memory, but not necessarily fully decoded.
   * STATUS_ERROR: An error occurred loading the image.
   * STATUS_FRAME_COMPLETE: The first frame has been
   * completely decoded.
   * STATUS_DECODE_COMPLETE: The whole image has been decoded.
  const long STATUS_NONE             = 0x0;
  const long STATUS_SIZE_AVAILABLE   = 0x1;
  const long STATUS_LOAD_PARTIAL     = 0x2;
  const long STATUS_LOAD_COMPLETE    = 0x4;
  const long STATUS_ERROR            = 0x8;
  const long STATUS_FRAME_COMPLETE   = 0x10;
  const long STATUS_DECODE_COMPLETE  = 0x20;

   * Status flags of the STATUS_* variety.
  readonly attribute unsigned long imageStatus;

   * The URI the image load was started with.  Note that this might not be the
   * actual URI for the image (e.g. if HTTP redirects happened during the
   * load).
  readonly attribute nsIURI URI;

  readonly attribute imgIDecoderObserver decoderObserver;

  readonly attribute string mimeType;

   * Clone this request; the returned request will have aObserver as the
   * observer.  aObserver will be notified synchronously (before the clone()
   * call returns) with all the notifications that have already been dispatched
   * for this image load.
  imgIRequest clone(in imgIDecoderObserver aObserver);

   * The principal gotten from the channel the image was loaded from.
  readonly attribute nsIPrincipal imagePrincipal;

   * Cancels this request as in nsIRequest::Cancel(); further, also nulls out
   * decoderObserver so it gets no further notifications from us.
   * NOTE: You should not use this in any new code; instead, use cancel(). Note
   * that cancel() is asynchronous, which means that some time after you call
   * it, the listener/observer will get an OnStopRequest(). This means that, if
   * you're the observer, you can't call cancel() from your destructor.
  void cancelAndForgetObserver(in nsresult aStatus);

   * Requests a decode for the image.
   * imgIContainer has a requestDecode() method, but callers may want to request
   * a decode before the container has necessarily been instantiated. Calling
   * requestDecode() on the imgIRequest simply forwards along the request if the
   * container already exists, or calls it once it gets OnStartContainer if the
   * container does not yet exist.
  void requestDecode();

   * Locks an image. If the image does not exist yet, locks it once it becomes
   * available. The lock persists for the lifetime of the imgIRequest (until
   * unlockImage is called) even if the underlying image changes.
   * If you don't call unlockImage() by the time this imgIRequest goes away, it
   * will be called for you automatically.
   * @see imgIContainer::lockImage for documentation of the underlying call.
  void lockImage();

   * Unlocks an image.
   * @see imgIContainer::unlockImage for documentation of the underlying call.
  void unlockImage();

   * If this request is for an animated image, the method creates a new
   * request which contains the current frame of the image.
   * Otherwise returns the same request.
  imgIRequest getStaticRequest();