gecko/dom/interfaces/xul/nsIDOMXULContainerElement.idl

102 lines
3.6 KiB
Plaintext
Raw Normal View History

/* -*- Mode: IDL; 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
* Mozilla Foundation.
* Portions created by the Initial Developer are Copyright (C) 2007
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Alexander Surkov <surkov.alexander@gmail.com> (original author)
*
* Alternatively, the contents of this file may be used under the terms of
* either of 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 "nsIDOMXULElement.idl"
interface nsIDOMXULContainerElement;
[scriptable, uuid(608d604f-79b4-4fe0-8a2c-49a007496642)]
interface nsIDOMXULContainerItemElement : nsIDOMXULElement
{
/**
* Returns the parent container if any.
*/
readonly attribute nsIDOMXULContainerElement parentContainer;
};
[scriptable, uuid(73acdda3-c6a5-4a89-a01a-0f776eba870d)]
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);
};