2001-09-29 00:14:13 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
|
1999-02-24 11:46:00 +03:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* The contents of this file are subject to the Netscape Public License
|
|
|
|
* Version 1.1 (the "License"); you may not use this file except in
|
|
|
|
* compliance with the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/NPL/
|
1999-02-24 11:46:00 +03:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
1999-02-24 11:46:00 +03:00
|
|
|
*
|
1999-11-06 06:43:54 +03:00
|
|
|
* The Original Code is mozilla.org code.
|
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
1999-11-06 06:43:54 +03:00
|
|
|
*
|
2001-09-29 00:14:13 +04:00
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the NPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the NPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
1999-05-07 04:17:58 +04:00
|
|
|
|
1999-02-24 11:46:00 +03:00
|
|
|
#include "nsISupports.idl"
|
|
|
|
|
1999-10-28 07:16:48 +04:00
|
|
|
%{C++
|
|
|
|
#define NS_ENUMERATOR_FALSE 1
|
|
|
|
%}
|
1999-10-15 03:52:59 +04:00
|
|
|
/*
|
|
|
|
* DO NOT USE THIS INTERFACE. IT IS HORRIBLY BROKEN, USES NS_COMFALSE
|
|
|
|
* AND IS BASICALLY IMPOSSIBLE TO USE CORRECTLY THROUGH PROXIES OR
|
|
|
|
* XPCONNECT. IF YOU SEE NEW USES OF THIS INTERFACE IN CODE YOU ARE
|
|
|
|
* REVIEWING, YOU SHOULD INSIST ON nsISimpleEnumerator.
|
|
|
|
*
|
|
|
|
* DON'T MAKE ME COME OVER THERE.
|
|
|
|
*/
|
|
|
|
[scriptable, uuid(ad385286-cbc4-11d2-8cca-0060b0fc14a3)]
|
1999-02-24 11:46:00 +03:00
|
|
|
interface nsIEnumerator : nsISupports {
|
1999-05-07 04:17:58 +04:00
|
|
|
/** First will reset the list. will return NS_FAILED if no items
|
|
|
|
*/
|
1999-10-15 03:52:59 +04:00
|
|
|
void first();
|
1999-05-07 04:17:58 +04:00
|
|
|
|
|
|
|
/** Next will advance the list. will return failed if already at end
|
|
|
|
*/
|
1999-10-15 03:52:59 +04:00
|
|
|
void next();
|
1999-05-07 04:17:58 +04:00
|
|
|
|
|
|
|
/** CurrentItem will return the CurrentItem item it will fail if the
|
|
|
|
* list is empty
|
|
|
|
*/
|
1999-10-15 03:52:59 +04:00
|
|
|
nsISupports currentItem();
|
1999-05-07 04:17:58 +04:00
|
|
|
|
|
|
|
/** return if the collection is at the end. that is the beginning following
|
|
|
|
* a call to Prev and it is the end of the list following a call to next
|
|
|
|
*/
|
1999-10-15 03:52:59 +04:00
|
|
|
void isDone();
|
1999-02-24 11:46:00 +03:00
|
|
|
};
|
|
|
|
|
|
|
|
[uuid(75f158a0-cadd-11d2-8cca-0060b0fc14a3)]
|
|
|
|
interface nsIBidirectionalEnumerator : nsIEnumerator {
|
1999-05-07 04:17:58 +04:00
|
|
|
|
|
|
|
/** Last will reset the list to the end. will return NS_FAILED if no items
|
|
|
|
*/
|
2000-05-15 11:03:46 +04:00
|
|
|
void last();
|
1999-05-07 04:17:58 +04:00
|
|
|
|
|
|
|
/** Prev will decrement the list. will return failed if already at beginning
|
|
|
|
*/
|
2000-05-15 11:03:46 +04:00
|
|
|
void prev();
|
1999-02-24 11:46:00 +03:00
|
|
|
};
|
1999-05-07 04:17:58 +04:00
|
|
|
|
|
|
|
%{C++
|
2001-10-31 01:07:28 +03:00
|
|
|
#include "nsISimpleEnumerator.h"
|
|
|
|
|
1999-05-07 04:17:58 +04:00
|
|
|
extern "C" NS_COM nsresult
|
|
|
|
NS_NewEmptyEnumerator(nsISimpleEnumerator** aResult);
|
|
|
|
|
|
|
|
// Construct and return an implementation of a "conjoining enumerator." This
|
|
|
|
// enumerator lets you string together two other enumerators into one sequence.
|
|
|
|
// The result is an nsIBidirectionalEnumerator, but if either input is not
|
|
|
|
// also bidirectional, the Last and Prev operations will fail.
|
|
|
|
extern "C" NS_COM nsresult
|
|
|
|
NS_NewConjoiningEnumerator(nsIEnumerator* first, nsIEnumerator* second,
|
|
|
|
nsIBidirectionalEnumerator* *aInstancePtrResult);
|
|
|
|
|
|
|
|
// Construct and return an implementation of a "union enumerator." This
|
|
|
|
// enumerator will only return elements that are found in both constituent
|
|
|
|
// enumerators.
|
|
|
|
extern "C" NS_COM nsresult
|
|
|
|
NS_NewUnionEnumerator(nsIEnumerator* first, nsIEnumerator* second,
|
|
|
|
nsIEnumerator* *aInstancePtrResult);
|
|
|
|
|
|
|
|
// Construct and return an implementation of an "intersection enumerator." This
|
|
|
|
// enumerator will return elements that are found in either constituent
|
|
|
|
// enumerators, eliminating duplicates.
|
|
|
|
extern "C" NS_COM nsresult
|
|
|
|
NS_NewIntersectionEnumerator(nsIEnumerator* first, nsIEnumerator* second,
|
|
|
|
nsIEnumerator* *aInstancePtrResult);
|
|
|
|
|
|
|
|
%}
|