Back to index

lightning-sunbird  0.9+nobinonly
nsISupportsIterators.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) 2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Scott Collins <scc@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or 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 /* nsISupportsIterators.idl --- IDL defining general purpose iterators */
00040 
00041 
00042 #include "nsISupports.idl"
00043 
00044 
00045   /*
00046     ...
00047   */
00048 
00049 
00053 [scriptable, uuid(7330650e-1dd2-11b2-a0c2-9ff86ee97bed)]
00054 interface nsIOutputIterator : nsISupports
00055   {
00066     void putElement( in nsISupports anElementToPut );
00067 
00071     void stepForward();
00072   };
00073 
00077 [scriptable, uuid(85585e12-1dd2-11b2-a930-f6929058269a)]
00078 interface nsIInputIterator : nsISupports
00079   {
00088     nsISupports getElement();
00089 
00093     void stepForward();
00094 
00103     boolean isEqualTo( in nsISupports anotherIterator );
00104 
00111     nsISupports clone();
00112   };
00113 
00117 [scriptable, uuid(8da01646-1dd2-11b2-98a7-c7009045be7e)]
00118 interface nsIForwardIterator : nsISupports
00119   {
00128     nsISupports getElement();
00129 
00140     void putElement( in nsISupports anElementToPut );
00141 
00145     void stepForward();
00146 
00155     boolean isEqualTo( in nsISupports anotherIterator );
00156 
00163     nsISupports clone();
00164   };
00165 
00169 [scriptable, uuid(948defaa-1dd1-11b2-89f6-8ce81f5ebda9)]
00170 interface nsIBidirectionalIterator : nsISupports
00171   {
00180     nsISupports getElement();
00181 
00192     void putElement( in nsISupports anElementToPut );
00193 
00197     void stepForward();
00198 
00202     void stepBackward();
00203 
00212     boolean isEqualTo( in nsISupports anotherIterator );
00213 
00220     nsISupports clone();
00221   };
00222 
00226 [scriptable, uuid(9bd6fdb0-1dd1-11b2-9101-d15375968230)]
00227 interface nsIRandomAccessIterator : nsISupports
00228   {
00237     nsISupports getElement();
00238 
00249     nsISupports getElementAt( in PRInt32 anOffset );
00250 
00261     void putElement( in nsISupports anElementToPut );
00262 
00275     void putElementAt( in PRInt32 anOffset, in nsISupports anElementToPut );
00276 
00280     void stepForward();
00281 
00289     void stepForwardBy( in PRInt32 anOffset );
00290 
00294     void stepBackward();
00295 
00303     void stepBackwardBy( in PRInt32 anOffset );
00304 
00313     boolean isEqualTo( in nsISupports anotherIterator );
00314 
00321     nsISupports clone();
00322   };
00323 
00324 %{C++
00325 %}