extensions/xforms/nsIXFormsUIWidget.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla XForms support.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Novell, Inc.
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Allan Beaufour <abeaufour@novell.com>
  24  *  Olli Pettay <Olli.Pettay@helsinki.fi>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsIDOMElement.idl"
  41
  42 /**
  43  * Interface implemented by XForms UI widgets.
  44  *
  45  * For more information on this interface please see
  46  * http://developer.mozilla.org/en/docs/XForms:Custom_Controls
  47  *
  48  */
  49 [scriptable, uuid(0448d5cd-c69c-4279-9dab-eeaee47dbc1a)]
  50 interface nsIXFormsUIWidget : nsIDOMElement
  51 {
  52   /**
  53    * Called, when UI Widget should refresh itself.
  54    */
  55   void refresh();
  56
  57   /**
  58    * Tries to focus the UI Widget. Returns true, if focusing succeeded.
  59    */
  60   boolean focus();
  61
  62   /**
  63    * The method focuses (or activates) element that accesskey is bound to. It is
  64    * called when accesskey is activated.
  65    */
  66   void performAccesskey();
  67
  68   /**
  69    * During submission, the \<submit\> should be disabled.
  70    */
  71   void disable(in boolean disable); // for <submit>
  72
  73   /**
  74    * Return "string" value of xforms element that element actually shows.
  75    *
  76    * From time to time current element value can be different from current value
  77    * of instance node that element is bound to. For example:
  78    * 1) When a XForms control has non-incremental update and its value is
  79    * changed due to user interaction, then getCurrentValue will return the
  80    * control's new value even though the bound node has not been updated yet.
  81    * 2) If instace value is out of range then xforms element can't show it.
  82    * Therefore it shows default value and getCurrentValue will return showed
  83    * value.
  84    */
  85   AString getCurrentValue();
  86 };
  87