| /* -*- 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 |
| * http://www.mozilla.org/MPL/ |
| * |
| * 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 mozilla.org 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 <pavlov@netscape.com> |
| * |
| * 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" |
| |
| interface nsIInputStream; |
| interface imgILoad; |
| |
| /** |
| * imgIDecoder interface |
| * |
| * @author Stuart Parmenter <pavlov@netscape.com> |
| * @version 0.2 |
| * @see imagelib2 |
| */ |
| [scriptable, uuid(9eebf43a-1dd1-11b2-953e-f1782f4cbad3)] |
| interface imgIDecoder : nsISupports |
| { |
| /** |
| * Initialize an image decoder. |
| * @param aRequest the request that owns the decoder. |
| * |
| * @note The decode should QI \a aLoad to an imgIDecoderObserver |
| * and should send decoder notifications to the request. |
| * The decoder should always pass NULL as the first two parameters to |
| * all of the imgIDecoderObserver APIs. |
| */ |
| void init(in imgILoad aLoad); |
| |
| /** |
| * Closes the stream. |
| */ |
| void close(); |
| |
| /** |
| * Flushes the stream. |
| */ |
| void flush(); |
| |
| /** |
| * Writes data into the stream from an input stream. |
| * Implementer's note: This method is defined by this interface in order |
| * to allow the output stream to efficiently copy the data from the input |
| * stream into its internal buffer (if any). If this method was provide |
| * as an external facility, a separate char* buffer would need to be used |
| * in order to call the output stream's other Write method. |
| * @param fromStream the stream from which the data is read |
| * @param count the maximun number of bytes to write |
| * @return aWriteCount out parameter to hold the number of |
| * bytes written. if an error occurs, the writecount |
| * is undefined |
| */ |
| unsigned long writeFrom(in nsIInputStream inStr, |
| in unsigned long count); |
| |
| }; |