/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** 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 mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * The Mozilla Foundation.
 * Portions created by the Initial Developer are Copyright (C) 2011
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   David Bienvenu <bienvenu@mozilla.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 ***** */


/**
 * This interface wraps an nsTArray<nsMsgKey> so that we can pass arrays
 * back and forth between c++ and js (or via xpconnect generally).
 */

#include "nsISupports.idl"
#include "MailNewsTypes2.idl"

[scriptable, uuid(e8fcaada-64b7-4e39-9f1d-10ddb0f1de64)]
interface nsIMsgKeyArray : nsISupports {
  /**
   * Get the key at the specified 0-based array index.
   *
   * @param aIndex 0-based index.
   * @returns key at the specified index.
   */
  nsMsgKey getKeyAt(in long aIndex);

  readonly attribute unsigned long length;

  void setCapacity(in unsigned long aCapacity);
  /**
   * Adds a key to the end of the array
   * @param key to append to the array.
   */
  void appendElement(in nsMsgKey aMsgKey);

  /**
   * Sort the array by key.
   */
  void sort();

  /**
   * Retrieves the entire array in such a way that xpconnect can easily
   * create a js array of the keys.
   *
   * @returns array of the keys
   */
  void getArray(out unsigned long aCount,
           [array, size_is(aCount)] out nsMsgKey aKeys);
};

