/* ***** 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 Utilities Service.
 *
 * 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"
#include "nsISupportsPrimitives.idl"
#include "nsIDOMXMLDocument.idl"
#include "xeIMarkupLanguage.idl"

interface xeIDocumentWrapper;
interface xeIXMLDocumentFile;

[scriptable, uuid(f2171694-151c-48a2-a99d-04b0eacb9c6a)]
interface xeIVerbosioUtilsService : nsISupports
{
  ACString getDTDFragment(in ACString source);

  /**
   * Copy a document wrapper's selection to the clipboard.
   */
  void copySelection(in xeIDocumentWrapper aWrapper);

  /**
   * Get the content-type for the object stored in the app clipboard.
   */
  readonly attribute ACString clipboardType;

  /**
   * Get the clipboard contents, including Verbosio's stored clipboard object.
   *
   * @param aFlavor The content-type of the object stored in the app clipboard.
   *
   * @return ACString the clipboard contents as a source string.
   * @return aStoredObject the clipboard contents as an object.
   */
  ACString getClipboardContents(in ACString aFlavor,
                                out nsISupports aStoredObject);

  /**
   * Get XML documents relating various metadata about Verbosio extensions.
   *
   * @param aCount Number of XML documents returned.
   *
   * @return aValues Array of xeIXMLDocumentFile objects holding the documents.
   */
  void getExtensionDataFiles(out unsigned long aCount,
                             [retval, array, size_is(aCount)]
                             out xeIXMLDocumentFile aValues);

  /**
   * Get markup templates which support a given node, in order of preference.
   *
   * @param aNode DOM node to find templates for.
   * @param aCount Number of templates returned.
   *
   * @return aValues Array of markup template nodes.
   */
  void getSupportingTemplates(in nsIDOMNode aNode,
                              out unsigned long aCount,
                              [retval, array, size_is(aCount)]
                              out xeIMarkupTemplate aValues);

  /**
   * Get a template document for a given namespace.
   *
   * @param aNamespaceURI The URI of the namespace to look up.
   *
   * @return nsIDOMXMLDocument with <markup:templates/> as the root element.
   */
  nsIDOMXMLDocument getTemplateDocument(in ACString aNamespaceURI);
};
