xpcom/ds/nsIEnumerator.idl@6474c204b198 (annotated)
xpcom/ds/nsIEnumerator.idl
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | %{C++ |
| michael@0 | 9 | #define NS_ENUMERATOR_FALSE 1 |
| michael@0 | 10 | %} |
| michael@0 | 11 | /* |
| michael@0 | 12 | * DO NOT USE THIS INTERFACE. IT IS HORRIBLY BROKEN, USES NS_COMFALSE |
| michael@0 | 13 | * AND IS BASICALLY IMPOSSIBLE TO USE CORRECTLY THROUGH PROXIES OR |
| michael@0 | 14 | * XPCONNECT. IF YOU SEE NEW USES OF THIS INTERFACE IN CODE YOU ARE |
| michael@0 | 15 | * REVIEWING, YOU SHOULD INSIST ON nsISimpleEnumerator. |
| michael@0 | 16 | * |
| michael@0 | 17 | * DON'T MAKE ME COME OVER THERE. |
| michael@0 | 18 | */ |
| michael@0 | 19 | [scriptable, uuid(ad385286-cbc4-11d2-8cca-0060b0fc14a3)] |
| michael@0 | 20 | interface nsIEnumerator : nsISupports { |
| michael@0 | 21 | /** First will reset the list. will return NS_FAILED if no items |
| michael@0 | 22 | */ |
| michael@0 | 23 | void first(); |
| michael@0 | 24 | |
| michael@0 | 25 | /** Next will advance the list. will return failed if already at end |
| michael@0 | 26 | */ |
| michael@0 | 27 | void next(); |
| michael@0 | 28 | |
| michael@0 | 29 | /** CurrentItem will return the CurrentItem item it will fail if the |
| michael@0 | 30 | * list is empty |
| michael@0 | 31 | */ |
| michael@0 | 32 | nsISupports currentItem(); |
| michael@0 | 33 | |
| michael@0 | 34 | /** return if the collection is at the end. that is the beginning following |
| michael@0 | 35 | * a call to Prev and it is the end of the list following a call to next |
| michael@0 | 36 | */ |
| michael@0 | 37 | void isDone(); |
| michael@0 | 38 | }; |
| michael@0 | 39 | |
| michael@0 | 40 | [uuid(75f158a0-cadd-11d2-8cca-0060b0fc14a3)] |
| michael@0 | 41 | interface nsIBidirectionalEnumerator : nsIEnumerator { |
| michael@0 | 42 | |
| michael@0 | 43 | /** Last will reset the list to the end. will return NS_FAILED if no items |
| michael@0 | 44 | */ |
| michael@0 | 45 | void last(); |
| michael@0 | 46 | |
| michael@0 | 47 | /** Prev will decrement the list. will return failed if already at beginning |
| michael@0 | 48 | */ |
| michael@0 | 49 | void prev(); |
| michael@0 | 50 | }; |
