/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsIDOMXULElement.idl"
interface nsIDOMXULContainerElement;

[scriptable, uuid(800a68c7-b854-4597-a436-3055ce5c5c96)]
interface nsIDOMXULContainerItemElement : nsISupports
{
  /**
   * Returns the parent container if any.
   */
  readonly attribute nsIDOMXULContainerElement parentContainer;
};

[scriptable, uuid(b2bc96b8-31fc-42f4-937a-bd27291af40b)]
interface nsIDOMXULContainerElement : nsIDOMXULContainerItemElement
{
  /**
   * Creates an item for the given label and value and appends it to the
   * container.
   *
   * @param aLabel - the label for the new item
   * @param aValue - the value of the new item
   */
  nsIDOMXULElement appendItem(in DOMString aLabel, in DOMString aValue);

  /**
   * Creates an item for the given label and value and inserts it into the
   * container at the specified position.
   *
   * @param aIndex - the index where the new item will be inserted
   * @param aLabel - the label for the new item
   * @param aValue - the value of the new item
   */
  nsIDOMXULElement insertItemAt(in long aIndex, in DOMString aLabel,
                                in DOMString aValue);

  /**
   * Removes an item from the container.
   *
   * @param aIndex - index of the item to remove
   */
  nsIDOMXULElement removeItemAt(in long aIndex);

  /**
   * Returns a count of items in the container.
   */
  readonly attribute unsigned long itemCount;

  /**
   * Returns the index of an item or -1 if the item is not in the container.
   *
   * @param aItem - the item to determine the index of
   */
  long getIndexOfItem(in nsIDOMXULElement aItem);

  /**
   * Returns the item at a given index or null if the item is not is the
   * container.
   *
   * @param aIndex - the index of the item to return
   */
  nsIDOMXULElement getItemAtIndex(in long aIndex);
};