author Tyler Downer <>
Tue, 07 Jul 2009 14:14:15 +0200
changeset 30054 eb4d03b6f5f9c723182500851ff1a91a3df48983
parent 27975 813b27ed116baab986dfc1f2efde74d2da8fd856
child 30479 b94bc4be53ca18e7d33b27f5c829131423137a0d
permissions -rw-r--r--
Bug 502499 - Remove extra "the" from core readme. r=bsmedberg

/** -*- 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 <>
 *   Federico Mena-Quintero <>
 * 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 "gfxidltypes.idl"
#include "gfxIFormats.idl"

interface gfxIImageFrame;
interface imgIContainerObserver;

 * gfxIImageContainer interface
 * @author Stuart Parmenter <>
 * @version 0.2
 * @see "gfx2"
[scriptable, uuid(a4e9df32-f5d7-479f-9082-70e1fead23d5)]
interface imgIContainer : nsISupports
   * "Disposal" method indicates how the image should be handled before the
   *  subsequent image is displayed.
   *  Don't change these without looking at the implementations using them,
   *  struct gif_struct::disposal_method and gif_write() in particular.
  const long kDisposeClearAll         = -1; // Clear the whole image, revealing
                                            // what was there before the gif displayed
  const long kDisposeNotSpecified     =  0; // Leave frame, let new frame draw on top
  const long kDisposeKeep             =  1; // Leave frame, let new frame draw on top
  const long kDisposeClear            =  2; // Clear the frame's area, revealing bg
  const long kDisposeRestorePrevious  =  3; // Restore the previous (composited) frame
   * "Blend" method indicates how the current image is combined with the
   * previous image.
  const long kBlendSource             =  0; // All color components of the frame, including alpha, 
                                            // overwrite the current contents of the frame's 
                                            // output buffer region
  const long kBlendOver               =  1; // The frame should be composited onto the output buffer 
                                            // based on its alpha, using a simple OVER operation
   * Create a new \a aWidth x \a aHeight sized image container.
   * @param aWidth The width of the container in which all the
   *               gfxIImageFrame children will fit.
   * @param aHeight The height of the container in which all the
   *                gfxIImageFrame children will fit.
   * @param aObserver Observer to send animation notifications to.
  void init(in PRInt32 aWidth,
            in PRInt32 aHeight,
            in imgIContainerObserver aObserver);

  /* this should probably be on the device context (or equiv) */
  readonly attribute gfx_format preferredAlphaChannelFormat;

   * The width of the container rectangle.
  readonly attribute PRInt32 width;

   * The height of the container rectangle.
  readonly attribute PRInt32 height;

   * Get the current frame that would be drawn if the image was to be drawn now
  readonly attribute gfxIImageFrame currentFrame;

  readonly attribute unsigned long numFrames;

   * Animation mode Constants
   *   0 = normal
   *   1 = don't animate
   *   2 = loop once
  const short kNormalAnimMode   = 0;
  const short kDontAnimMode     = 1;
  const short kLoopOnceAnimMode = 2;

  attribute unsigned short animationMode;

  gfxIImageFrame getFrameAt(in unsigned long index);

   * Adds \a item to the end of the list of frames.
   * @param item frame to add.
  void appendFrame(in gfxIImageFrame item);

  /* notification when the current frame is done decoding */
  void endFrameDecode(in unsigned long framenumber);
  /* notification that the entire image has been decoded */
  void decodingComplete();
  void startAnimation();

  void stopAnimation();

  void resetAnimation();

   * number of times to loop the image.
   * @note -1 means forever.
  attribute long loopCount;

  /* Methods to discard uncompressed images and restore them again */
  [noscript] void setDiscardable(in string aMimeType);
  [noscript] void addRestoreData([array, size_is(aCount), const] in char data,
                                 in unsigned long aCount);
  [noscript] void restoreDataDone();