Back to index

lightning-sunbird  0.9+nobinonly
nsIUnicharStreamLoader.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; 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) 2002
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *    Darin Fisher <darin@netscape.com>  (original author)
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 
00041 interface nsIUnicharInputStream;
00042 interface nsIUnicharStreamLoader;
00043 interface nsIChannel;
00044 
00045 [scriptable, uuid(e06e8b08-8cdd-4503-a0a0-6f3b943602af)]
00046 interface nsIUnicharStreamLoaderObserver : nsISupports
00047 {
00058   ACString onDetermineCharset(in nsIUnicharStreamLoader aLoader,
00059                               in nsISupports aContext,
00060                               [size_is(aLength)] in string aFirstSegment,
00061                               in unsigned long aLength);
00062 
00072   void onStreamComplete(in nsIUnicharStreamLoader aLoader,
00073                         in nsISupports aContext,
00074                         in nsresult aStatus,
00075                         in nsIUnicharInputStream aUnicharData);
00076 };
00077 
00078 [scriptable, uuid(8a3eca16-167e-443d-9485-7e84ed822e95)]
00079 interface nsIUnicharStreamLoader : nsISupports
00080 {
00081   const unsigned long DEFAULT_SEGMENT_SIZE = 4096;
00082 
00094   void init(in nsIChannel aChannel,
00095             in nsIUnicharStreamLoaderObserver aObserver,
00096             in nsISupports aContext,
00097             in unsigned long aSegmentSize);
00098 
00103   readonly attribute nsIChannel channel;
00104 
00109   readonly attribute ACString charset;
00110 };