mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-08 20:47:44 +00:00
81 lines
2.6 KiB
C++
81 lines
2.6 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
*
|
|
* The contents of this file are subject to the Netscape Public License
|
|
* Version 1.0 (the "NPL"); you may not use this file except in
|
|
* compliance with the NPL. You may obtain a copy of the NPL at
|
|
* http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
|
* for the specifzic language governing rights and limitations under the
|
|
* NPL.
|
|
*
|
|
* The Initial Developer of this code under the NPL is Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
|
* Reserved.
|
|
*/
|
|
#ifndef nsICollection_h___
|
|
#define nsICollection_h___
|
|
|
|
#include "nsISupports.h"
|
|
|
|
class nsIEnumerator;
|
|
|
|
// IID for the nsICollection interface
|
|
#define NS_ICOLLECTION_IID \
|
|
{ /* 83b6019c-cbc4-11d2-8cca-0060b0fc14a3 */ \
|
|
0x83b6019c, \
|
|
0xcbc4, \
|
|
0x11d2, \
|
|
{0x8c, 0xca, 0x00, 0x60, 0xb0, 0xfc, 0x14, 0xa3} \
|
|
}
|
|
|
|
// IID for the nsICollection Factory interface
|
|
#define NS_ICOLLECTIONFACTORY_IID \
|
|
{ 0xf8052641, 0x8768, 0x11d2, \
|
|
{ 0x8f, 0x39, 0x0, 0x60, 0x8, 0x31, 0x1, 0x94 } }
|
|
|
|
//----------------------------------------------------------------------
|
|
|
|
/** nsICollection Interface
|
|
* this may be ordered or not. a list or array, the implementation is opaque
|
|
*/
|
|
class nsICollection : public nsISupports {
|
|
public:
|
|
|
|
static const nsIID& GetIID(void) { static nsIID iid = NS_ICOLLECTION_IID; return iid; }
|
|
|
|
/** Return the count of elements in the collection.
|
|
*/
|
|
NS_IMETHOD_(PRUint32) Count(void) const = 0;
|
|
|
|
/**
|
|
* AppendElement will take an ISupports and keep track of it
|
|
* @param aItem is the Item to be added WILL BE ADDREFFED
|
|
* @return NS_OK if successfully added
|
|
* @return NS_ERROR_FAILURE otherwise
|
|
*/
|
|
NS_IMETHOD AppendElement(nsISupports *aItem) = 0;
|
|
|
|
/** RemoveElement will take an nsISupports and remove it from the collection
|
|
* @param aItem is the item to be removed WILL BE RELEASED
|
|
* @return NS_OK if successfully added
|
|
* @return NS_ERROR_FAILURE otherwise
|
|
*/
|
|
NS_IMETHOD RemoveElement(nsISupports *aItem) = 0;
|
|
|
|
/** Return an enumeration for the collection.
|
|
*/
|
|
NS_IMETHOD Enumerate(nsIEnumerator* *result) = 0;
|
|
|
|
/** Clear will clear all items from list
|
|
*/
|
|
NS_IMETHOD Clear(void) = 0;
|
|
|
|
};
|
|
|
|
|
|
#endif /* nsICollection_h___ */
|
|
|