Back to index

lightning-sunbird  0.9+nobinonly
nsICollection.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Scott Collins <scc@mozilla.org>: |do_QueryElementAt|
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsISerializable.idl"
00040 #include "nsIEnumerator.idl"
00041 
00042 [scriptable, uuid(83b6019c-cbc4-11d2-8cca-0060b0fc14a3)]
00043 interface nsICollection : nsISerializable
00044 {
00045 
00046   PRUint32 Count();
00047   nsISupports GetElementAt(in PRUint32 index);
00048   void QueryElementAt(in PRUint32 index, in nsIIDRef uuid, 
00049                       [iid_is(uuid),retval] out nsQIResult result);
00050   void SetElementAt(in PRUint32 index, in nsISupports item);
00051   void AppendElement(in nsISupports item);
00052   void RemoveElement(in nsISupports item);
00053 
00054   nsIEnumerator Enumerate();
00055 
00056   void Clear();
00057 
00058 };
00059 
00060 %{C++
00061 
00062 #ifndef nsCOMPtr_h__
00063 #include "nsCOMPtr.h"
00064 #endif
00065 
00066 class NS_COM nsQueryElementAt : public nsCOMPtr_helper
00067   {
00068     public:
00069       nsQueryElementAt( nsICollection* aCollection, PRUint32 aIndex, nsresult* aErrorPtr )
00070           : mCollection(aCollection),
00071             mIndex(aIndex),
00072             mErrorPtr(aErrorPtr)
00073         {
00074           // nothing else to do here
00075         }
00076 
00077       virtual nsresult NS_FASTCALL operator()( const nsIID& aIID, void** ) const;
00078 
00079     private:
00080       nsICollection*  mCollection;
00081       PRUint32        mIndex;
00082       nsresult*       mErrorPtr;
00083   };
00084 
00085 inline
00086 const nsQueryElementAt
00087 do_QueryElementAt( nsICollection* aCollection, PRUint32 aIndex, nsresult* aErrorPtr = 0 )
00088   {
00089     return nsQueryElementAt(aCollection, aIndex, aErrorPtr);
00090   }
00091 
00092 %}