extensions/xforms/nsIXFormsContextControl.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) 2004
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Allan Beaufour <abeaufour@novell.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39
  40 #include "nsIXFormsControlBase.idl"
  41
  42 interface nsIDOMNode;
  43 interface nsIDOMElement;
  44 interface nsIXFormsControl;
  45
  46 /**
  47  * Interface for elements that sets the XPath context of its children.
  48  */
  49 [uuid(35660a75-86f0-4eaf-9da9-f47e2f5466da)]
  50 interface nsIXFormsContextControl : nsIXFormsControlBase
  51 {
  52   /**
  53    * Used by children to retrieve the context of their parent.
  54    *
  55    * @param aModelID          The modelID
  56    * @param aContextNode      The context node
  57    * @param aContextPosition  The context position
  58    * @param aContextSize      The context size
  59    *
  60    * @note The actual model ID must be returned. An empty |aModelID| should
  61    * only be returned if the default model has an id="".
  62    */
  63   void getContext(out AString aModelID, out nsIDOMNode aContextNode,
  64                   out long aContextPosition, out long aContextSize);
  65
  66   /**
  67    * Used by parents to set the context for children.
  68    *
  69    * @param aContextNode      The context node
  70    * @param aContextPosition  The context position
  71    * @param aContextSize      The context size
  72    */
  73   void setContext(in nsIDOMNode aContextNode, in long aContextPosition,
  74                   in long aContextSize);
  75
  76   /**
  77    * Each context control maintains an 'aborted bind' list.  This list is
  78    * used to track xforms controls that this context control contains
  79    * which have tried to bind but couldn't because this context control
  80    * wasn't bound yet, either.
  81    *
  82    * @param aControl          The XForms control that couldn't bind because
  83    *                          this context control wasn't ready.
  84    * @param addControl        If true, aControl is added to the list.  If false
  85    *                          aControl will be removed from the list and also
  86    *                          aControl will lose its link to this control.
  87    */
  88   void addRemoveAbortedControl(in nsIXFormsControl aControl,
  89                                in boolean aAddControl);
  90
  91 };