xpcom/ds/nsIStringEnumerator.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7
   8 interface nsIJSEnumerator;
   9
  10 /**
  11  * Used to enumerate over an ordered list of strings.
  12  */
  13
  14 /**
  15  * Base class for C++-implemented string iterators. JS implementors need not
  16  * be queryable to it.
  17  */
  18 [scriptable, uuid(f5213d15-a4d1-4fb7-8a48-d69ccb7fb0eb)]
  19 interface nsIStringEnumeratorBase : nsISupports
  20 {
  21     [symbol, binaryname(StringIterator)]
  22     nsIJSEnumerator iterator();
  23 };
  24
  25 [scriptable, uuid(50d3ef6c-9380-4f06-9fb2-95488f7d141c)]
  26 interface nsIStringEnumerator : nsIStringEnumeratorBase
  27 {
  28     boolean hasMore();
  29     AString getNext();
  30 };
  31
  32 [scriptable, uuid(9bdf1010-3695-4907-95ed-83d0410ec307)]
  33 interface nsIUTF8StringEnumerator : nsIStringEnumeratorBase
  34 {
  35     boolean hasMore();
  36     AUTF8String getNext();
  37 };