PageRenderTime 82ms CodeModel.GetById 41ms app.highlight 1ms RepoModel.GetById 39ms app.codeStats 0ms

/gecko_api/include/nsArrayEnumerator.h

http://firefox-mac-pdf.googlecode.com/
C++ Header | 65 lines | 13 code | 7 blank | 45 comment | 0 complexity | 3a8c6116a16da796825bc12c9bc757cc MD5 | raw file
 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 XPCOM Array implementation.
16 *
17 * The Initial Developer of the Original Code is
18 * Netscape Communications Corp.
19 * Portions created by the Initial Developer are Copyright (C) 2002
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *   Alec Flett <alecf@netscape.com>
24 *   Benjamin Smedberg <benjamin@smedbergs.us>
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * either the GNU General Public License Version 2 or later (the "GPL"), or
28 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 * in which case the provisions of the GPL or the LGPL are applicable instead
30 * of those above. If you wish to allow use of your version of this file only
31 * under the terms of either the GPL or the LGPL, and not to allow others to
32 * use your version of this file under the terms of the MPL, indicate your
33 * decision by deleting the provisions above and replace them with the notice
34 * and other provisions required by the GPL or the LGPL. If you do not delete
35 * the provisions above, a recipient may use your version of this file under
36 * the terms of any one of the MPL, the GPL or the LGPL.
37 *
38 * ***** END LICENSE BLOCK ***** */
39
40#ifndef nsArrayEnumerator_h__
41#define nsArrayEnumerator_h__
42
43// enumerator implementation for nsIArray
44
45#include "nscore.h"
46
47class nsISimpleEnumerator;
48class nsIArray;
49class nsCOMArray_base;
50
51// Create an enumerator for an existing nsIArray implementation
52// The enumerator holds an owning reference to the array.
53NS_COM_GLUE nsresult
54NS_NewArrayEnumerator(nsISimpleEnumerator* *result,
55                      nsIArray* array);
56
57// create an enumerator for an existing nsCOMArray<T> implementation
58// The enumerator will hold an owning reference to each ELEMENT in
59// the array. This means that the nsCOMArray<T> can safely go away
60// without its objects going away.
61NS_COM_GLUE nsresult
62NS_NewArrayEnumerator(nsISimpleEnumerator* *aResult,
63                      const nsCOMArray_base& aArray);
64
65#endif