xpcom/ds/nsIEnumerator.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISimpleEnumerator.idl"
  39
  40 %{C++
  41 #define NS_ENUMERATOR_FALSE 1
  42 %}
  43 /*
  44  * DO NOT USE THIS INTERFACE.  IT IS HORRIBLY BROKEN, USES NS_COMFALSE
  45  * AND IS BASICALLY IMPOSSIBLE TO USE CORRECTLY THROUGH PROXIES OR
  46  * XPCONNECT.  IF YOU SEE NEW USES OF THIS INTERFACE IN CODE YOU ARE
  47  * REVIEWING, YOU SHOULD INSIST ON nsISimpleEnumerator.
  48  *
  49  * DON'T MAKE ME COME OVER THERE.
  50  */
  51 [scriptable, uuid(ad385286-cbc4-11d2-8cca-0060b0fc14a3)]
  52 interface nsIEnumerator : nsISupports {
  53   /** First will reset the list. will return NS_FAILED if no items
  54    */
  55   void first();
  56
  57   /** Next will advance the list. will return failed if already at end
  58    */
  59   void next();
  60
  61   /** CurrentItem will return the CurrentItem item it will fail if the
  62    *  list is empty
  63    */
  64   nsISupports currentItem();
  65
  66   /** return if the collection is at the end.  that is the beginning following
  67    *  a call to Prev and it is the end of the list following a call to next
  68    */
  69   void isDone();
  70 };
  71
  72 [uuid(75f158a0-cadd-11d2-8cca-0060b0fc14a3)]
  73 interface nsIBidirectionalEnumerator : nsIEnumerator {
  74
  75   /** Last will reset the list to the end. will return NS_FAILED if no items
  76    */
  77   void last();
  78
  79   /** Prev will decrement the list. will return failed if already at beginning
  80    */
  81   void prev();
  82 };