Back to index

lightning-sunbird  0.9+nobinonly
nsISeekableStream.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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 FastLoad 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) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 
00039 /*
00040  * nsISeekableStream
00041  *
00042  * Note that a stream might not implement all methods (e.g., a readonly stream 
00043  * won't implement setEOF)
00044  * 
00045  * @status UNDER_REVIEW
00046  */
00047 
00048 #include "nsISupports.idl"
00049 
00050 [scriptable, uuid(8429d350-1040-4661-8b71-f2a6ba455980)]
00051 interface nsISeekableStream : nsISupports
00052 {
00053     /* 
00054      * Sets the stream pointer to the value of the 'offset' parameter 
00055      */
00056     const PRInt32 NS_SEEK_SET = 0;
00057 
00058     /*  
00059      * Sets the stream pointer to its current location plus the value 
00060      * of the offset parameter. 
00061      */
00062     const PRInt32 NS_SEEK_CUR = 1;
00063 
00064     /* 
00065      * Sets the stream pointer to the size of the stream plus the value 
00066      * of the offset parameter. 
00067      */
00068     const PRInt32 NS_SEEK_END = 2;
00069 
00085     void seek(in long whence, in long long offset);
00086 
00093     long long tell();
00094 
00095 
00101     void setEOF();
00102 };