| /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ |
| /* ***** BEGIN LICENSE BLOCK ***** |
| * Version: MPL 1.1/GPL 2.0/LGPL 2.1 |
| * |
| * The contents of this file are subject to the Mozilla Public License Version |
| * 1.1 (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * http://www.mozilla.org/MPL/ |
| * |
| * Software distributed under the License is distributed on an "AS IS" basis, |
| * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License |
| * for the specific language governing rights and limitations under the |
| * License. |
| * |
| * The Original Code is XPCOM Array interface. |
| * |
| * The Initial Developer of the Original Code is |
| * Netscape Communications Corp. |
| * Portions created by the Initial Developer are Copyright (C) 2002 |
| * the Initial Developer. All Rights Reserved. |
| * |
| * Contributor(s): |
| * Alec Flett <alecf@netscape.com> |
| * |
| * Alternatively, the contents of this file may be used under the terms of |
| * either the GNU General Public License Version 2 or later (the "GPL"), or |
| * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), |
| * in which case the provisions of the GPL or the LGPL are applicable instead |
| * of those above. If you wish to allow use of your version of this file only |
| * under the terms of either the GPL or the LGPL, and not to allow others to |
| * use your version of this file under the terms of the MPL, indicate your |
| * decision by deleting the provisions above and replace them with the notice |
| * and other provisions required by the GPL or the LGPL. If you do not delete |
| * the provisions above, a recipient may use your version of this file under |
| * the terms of any one of the MPL, the GPL or the LGPL. |
| * |
| * ***** END LICENSE BLOCK ***** */ |
| |
| #include "nsIArray.idl" |
| |
| /** |
| * nsIMutableArray |
| * A separate set of methods that will act on the array. Consumers of |
| * nsIArray should not QueryInterface to nsIMutableArray unless they |
| * own the array. |
| * |
| * As above, it is legal to add null elements to the array. Note also |
| * that null elements can be created as a side effect of |
| * insertElementAt(). Conversely, if insertElementAt() is never used, |
| * and null elements are never explicitly added to the array, then it |
| * is guaranteed that queryElementAt() will never return a null value. |
| * |
| * Any of these methods may throw NS_ERROR_OUT_OF_MEMORY when the |
| * array must grow to complete the call, but the allocation fails. |
| * |
| * @status FROZEN |
| */ |
| [scriptable, uuid(af059da0-c85b-40ec-af07-ae4bfdc192cc)] |
| interface nsIMutableArray : nsIArray |
| { |
| /** |
| * appendElement() |
| * |
| * Append an element at the end of the array. |
| * |
| * @param element The element to append. |
| * @param weak Whether or not to store the element using a weak |
| * reference. |
| * @throws NS_ERROR_FAILURE when a weak reference is requested, |
| * but the element does not support |
| * nsIWeakReference. |
| */ |
| void appendElement(in nsISupports element, in boolean weak); |
| |
| /** |
| * removeElementAt() |
| * |
| * Remove an element at a specific position, moving all elements |
| * stored at a higher position down one. |
| * To remove a specific element, use indexOf() to find the index |
| * first, then call removeElementAt(). |
| * |
| * @param index the position of the item |
| * |
| */ |
| void removeElementAt(in unsigned long index); |
| |
| /** |
| * insertElementAt() |
| * |
| * Insert an element at the given position, moving the element |
| * currently located in that position, and all elements in higher |
| * position, up by one. |
| * |
| * @param element The element to insert |
| * @param index The position in the array: |
| * If the position is lower than the current length |
| * of the array, the elements at that position and |
| * onwards are bumped one position up. |
| * If the position is equal to the current length |
| * of the array, the new element is appended. |
| * An index lower than 0 or higher than the current |
| * length of the array is invalid and will be ignored. |
| * |
| * @throws NS_ERROR_FAILURE when a weak reference is requested, |
| * but the element does not support |
| * nsIWeakReference. |
| */ |
| void insertElementAt(in nsISupports element, in unsigned long index, |
| in boolean weak); |
| |
| /** |
| * replaceElementAt() |
| * |
| * Replace the element at the given position. |
| * |
| * @param element The new element to insert |
| * @param index The position in the array |
| * If the position is lower than the current length |
| * of the array, an existing element will be replaced. |
| * If the position is equal to the current length |
| * of the array, the new element is appended. |
| * If the position is higher than the current length |
| * of the array, empty elements are appended followed |
| * by the new element at the specified position. |
| * An index lower than 0 is invalid and will be ignored. |
| * |
| * @param weak Whether or not to store the new element using a weak |
| * reference. |
| * |
| * @throws NS_ERROR_FAILURE when a weak reference is requested, |
| * but the element does not support |
| * nsIWeakReference. |
| */ |
| void replaceElementAt(in nsISupports element, in unsigned long index, |
| in boolean weak); |
| |
| |
| /** |
| * clear() |
| * |
| * clear the entire array, releasing all stored objects |
| */ |
| void clear(); |
| }; |