gecko-dev/extensions/xforms/nsIXFormsSelectChild.idl

/* -*- 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 XForms support.
 *
 * The Initial Developer of the Original Code is
 * IBM Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2004
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Brian Ryner <bryner@brianryner.com>
 *
 * 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 "nsISupports.idl"

interface nsIDOMNode;
interface nsIDOMElement;
interface nsIArray;
%{C++
class nsStringArray;
%}

[ref] native constStringArray(const nsStringArray);

/**
 * nsIXFormsSelectChild is implemented by elements that can be children
 * of an XForms select element (choices, item, itemset).
 */

[scriptable, uuid(9fac2f59-4ec8-456f-ad06-4e28cd7d5b2c)]
interface nsIXFormsSelectChild : nsISupports
{
  /*
   * selectItemByValue is used in \<select1\>. If the XFormsSelectChild is or
   * contains an \<item\>, which has the same value as the parameter |value|,
   * this method returns that \<item\>.
   */
  nsIDOMNode selectItemByValue(in AString value);

  /*
   * selectItemByNode is used in \<select1\> and \<select\>. If the
   * XFormsSelectChild is or contains an \<item\>, which has a node 'equal' the
   * parameter |aNode|, this method returns the first \<item\> that matches.
   */
  nsIDOMNode selectItemByNode(in nsIDOMNode aNode);
};