Back to index

lightning-sunbird  0.9+nobinonly
nsMsgKeyArray.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 // nsMsgKeyArray.h: header file
00038 //
00039 
00040 #ifndef _nsMsgKeyArray_H_
00041 #define _nsMsgKeyArray_H_ 
00042 
00044 // nsMsgKeyArray - Growable Array of nsMsgKeys's - Can contain up to uint - 1 ids. 
00046 #include "nsUInt32Array.h"
00047 #include "MailNewsTypes.h"
00048 
00049 class NS_MSG_BASE nsMsgKeyArray : public nsUInt32Array
00050 {
00051 // constructors
00052 public:
00053        nsMsgKeyArray() : nsUInt32Array() {}
00054 
00055 // Public Operations on the nsMsgKey array - typesafe overrides
00056 public:
00057        nsMsgKey operator[](PRUint32 nIndex) const {
00058          return((nsMsgKey)nsUInt32Array::operator[](nIndex));
00059        }
00060        nsMsgKey GetKeyFromIndex(PRUint32 nIndex) {
00061          return(operator[](nIndex));
00062        }
00063        nsMsgKey GetAt(PRUint32 nIndex) const {
00064          return(operator[](nIndex));
00065        }
00066        void SetAt(PRUint32 nIndex, nsMsgKey key) {
00067          nsUInt32Array::SetAt(nIndex, (PRUint32)key);
00068        }
00069        void SetAtGrow(PRUint32 nIndex, nsMsgKey key) {
00070          nsUInt32Array::SetAtGrow(nIndex, (uint32)key);
00071        }
00072        void InsertAt(PRUint32 nIndex, nsMsgKey key, int nCount = 1) {
00073          nsUInt32Array::InsertAt(nIndex, (PRUint32)key, nCount);
00074        }
00075        void InsertAt(PRUint32 nIndex, const nsMsgKeyArray *idArray) {
00076          nsUInt32Array::InsertAt(nIndex, idArray);
00077        }
00078        PRUint32 Add(nsMsgKey key) {
00079          return(nsUInt32Array::Add((uint32)key));
00080        }
00081        PRUint32 Add(nsMsgKey *elementPtr, PRUint32 numElements) {
00082          return nsUInt32Array::Add((PRUint32 *) elementPtr, numElements);
00083        }
00084        void CopyArray(nsMsgKeyArray *oldA) { nsUInt32Array::CopyArray((nsUInt32Array*) oldA); }
00085        void CopyArray(nsMsgKeyArray &oldA) { nsUInt32Array::CopyArray(oldA); }
00086 // new operations
00087 public:
00088        nsMsgViewIndex                                   FindIndex(nsMsgKey key, PRUint32 startIndex = 0); // returns -1 if not found
00089        
00090        // use these next two carefully
00091        nsMsgKey*                          GetArray(void) {
00092          return((nsMsgKey*)m_pData);             // only valid until another function
00093                                                                       // called on the array (like
00094                                                                       // GetBuffer() in CString)
00095        }
00096        void                        SetArray(nsMsgKey* pData, int numElements,
00097                                                          int numAllocated);
00098 };
00100 #endif // _IDARRAY_H_