pjs/extensions/xforms/nsIModelElementPrivate.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 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 "nsIXFormsModelElement.idl"

interface nsIXFormsControl;
interface nsISchemaType;
interface nsIInstanceElementPrivate;
interface nsXFormsMDGEngine;

/**
 * Private interface implemented by the model element for other
 * elements to use.
 */
[uuid(b21b65d3-3305-4ce0-a604-3648cff61aca)]
interface nsIModelElementPrivate : nsIXFormsModelElement
{
  /**
   * Called by form control elements when they are bound to or unbound from
   * this model.  These form controls will be refreshed when refresh() is
   * called on the model.
   */
  void addFormControl(in nsIXFormsControl control);
  void removeFormControl(in nsIXFormsControl control);

  /**
   * Determine the type for a form control based on the schema included by
   * this model.
   */
  nsISchemaType getTypeForControl(in nsIXFormsControl control);

  /**
   * Notification that an instance element has started or finished loading
   * its instance data.  Model contstruction cannot complete until all of
   * the instances have loaded their data.
   */
  void instanceLoadStarted();
  void instanceLoadFinished(in boolean success);

  /**
   * Locate the instance element child with the given id.
   */
  nsIInstanceElementPrivate findInstanceElement(in AString id);

  /**
   * The model's MDG.
   *
   * @bug nsXFormsMDGEngine is not an interface.
   *      @see https://bugzilla.mozilla.org/show_bug.cgi?id=278370
   */
  readonly attribute nsXFormsMDGEngine MDG;
};