/* ***** 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 Verbosio markup language interfaces (XTF).
 *
 * The Initial Developer of the Original Code is
 * Alexander J. Vincent <ajvincent@gmail.com>.
 * Portions created by the Initial Developer are Copyright (C) 2007
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * 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 "nsISupports.idl"

interface nsIDOMNode;
interface nsIDOMDocumentFragment;
interface xeIMarkupOutput;

/* <markup:template/> */
[scriptable, uuid(354303fd-082f-4c39-9e40-22d0fb42df6a)]
interface xeIMarkupTemplate : nsISupports {
  /**
   * Rate the support this template has for a given DOM node.
   *
   *
   * @param aNode DOM node to compare against the template.
   *
   * @return 0 for no support, low numbers for acceptable support, or
   *         high numbers for preferred support.
   */
  PRUint32 rateSupport(in nsIDOMNode aNode);

  /**
   * Get the output container for this element.
   */
  xeIMarkupOutput getOutputContainer();

  /**
   * Process XPath inputs on user input sections.
   */
  void processXPathInputs();

  /**
   * Get a DOM document fragment for the template.
   *
   * @param aAttachOriginals True if <markup:children/> should be replaced
   *                         with original content.
   */
  nsIDOMDocumentFragment exportEditedFragment(in boolean aAttachOriginals);

  /**
   * Get the output node for a UI node.
   *
   * @param aNode The user-interface node to match.
   *
   * @return nsIDOMNode The output node matching the user-interface node.
   */
  nsIDOMNode getOutputNode(in nsIDOMNode aNode);
};

/* <markup:output/> */
[scriptable, uuid(997f28b5-77af-464c-bc8b-91e50f35abf2)]
interface xeIMarkupOutput: nsISupports {
  /**
   * Import a source fragment into this output.
   *
   * @param aRealRootNode DOM root node to import contents from.
   *
   * @return boolean True if import succeeded, false otherwise.
   */
  boolean importSourceNode(in nsIDOMNode aRealRootNode);
};

/* <markup:repeat/> */
[scriptable, uuid(ee2f5cfb-c140-457a-805c-32ff91684594)]
interface xeIMarkupRepeat: nsISupports {
  /**
   * Clear the repeating element's anonymous rows.
   */
  void clearRows();

  /**
   * Add an anonymous row representing a repetition set.
   *
   * @aParam aNode nsIDOMNode the repetition set is based on.
   */
  void addRow(in nsIDOMNode aNode);
};

/* <markup:children/> */
[scriptable, uuid(0e122b14-08e4-43d0-8d57-8a6ac7b8682b)]
interface xeIMarkupChildren: nsISupports {
  /**
   * Get the number of nodes matching this element.
   *
   * @param aCheckNode First candidate node to match this.
   */
  PRUint32 getMatchCount(in nsIDOMNode aCheckNode);
};
