Back to index

lightning-sunbird  0.9+nobinonly
nsIStringStream.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; 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) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   mcmullen@netscape.com (original author)
00024  *   scc@mozilla.org
00025  *   davidm@netscape.com
00026  *   darin@netscape.com
00027  *
00028  * Alternatively, the contents of this file may be used under the terms of
00029  * either of the GNU General Public License Version 2 or later (the "GPL"),
00030  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00031  * in which case the provisions of the GPL or the LGPL are applicable instead
00032  * of those above. If you wish to allow use of your version of this file only
00033  * under the terms of either the GPL or the LGPL, and not to allow others to
00034  * use your version of this file under the terms of the MPL, indicate your
00035  * decision by deleting the provisions above and replace them with the notice
00036  * and other provisions required by the GPL or the LGPL. If you do not delete
00037  * the provisions above, a recipient may use your version of this file under
00038  * the terms of any one of the MPL, the GPL or the LGPL.
00039  *
00040  * ***** END LICENSE BLOCK ***** */
00041 
00046 #include "nsIInputStream.idl"
00047 
00054 [scriptable, uuid(450cd2d4-f0fd-424d-b365-b1251f80fd53)]
00055 interface nsIStringInputStream : nsIInputStream
00056 {
00066     void setData(in string data, in long dataLen);
00067 
00081     [noscript] void adoptData(in charPtr data, in long dataLen);
00082 
00091     [noscript] void shareData(in string data, in long dataLen);
00092 };
00093 
00094 %{C++
00095 
00096 //-----------------------------------------------------------------------------
00097 // C++ factory methods
00098 //-----------------------------------------------------------------------------
00099 
00100 #include "nsIInputStream.h"
00101 #include "nsString.h"
00102 
00103 //-----------------------------------------------------------------------------
00104 // Factory method to get an nsInputStream from an nsAString.  Result will
00105 // implement nsIStringInputStream and nsISeekableStream
00106 extern "C" NS_COM nsresult
00107 NS_NewStringInputStream(nsIInputStream** aStreamResult,
00108                         const nsAString& aStringToRead);
00109 
00110 //-----------------------------------------------------------------------------
00111 // Factory method to get an nsInputStream from an nsACString.  Result will
00112 // implement nsIStringInputStream and nsISeekableStream 
00113 extern "C" NS_COM nsresult
00114 NS_NewCStringInputStream(nsIInputStream** aStreamResult,
00115                          const nsACString& aStringToRead);
00116 
00117 //-----------------------------------------------------------------------------
00118 // Factory method to get an nsInputStream from a string.  Result will
00119 // implement nsIStringInputStream and nsISeekableStream
00120 extern "C" NS_COM nsresult
00121 NS_NewCharInputStream(nsIInputStream** aStreamResult,
00122                       const char* aStringToRead);
00123 
00124 //-----------------------------------------------------------------------------
00125 // Factory method to get an nsInputStream from a byte buffer.  Result will
00126 // implement nsIStringInputStream and nsISeekableStream
00127 extern "C" NS_COM nsresult
00128 NS_NewByteInputStream(nsIInputStream** aStreamResult,
00129                       const char* aStringToRead,
00130                       PRInt32 aLength);
00131 %}