/* ***** 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 XML editor.
 *
 * The Initial Developer of the Original Code is
 * Alexander J. Vincent <ajvincent@gmail.com>.
 * Portions created by the Initial Developer are Copyright (C) 2005
 * 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 "nsIDOMXULElement.idl"
#include "nsITransactionListener.idl"
#include "nsITransactionManager.idl"
#include "xeIVirtualFile.idl"

interface xeIBaseURIMap;
interface xeITransaction;
interface xeIDocumentPack;

[scriptable, uuid(2986bf32-fc17-4233-bfcd-70a564585496)]
interface xeIDocumentWrapper : xeIVirtualFile
{
  /* The language of the root element, if XML, or of the whole document, if not. */
  readonly attribute ACString     rootLanguageType;

  /* A map of base URI's corresponding to the public and local URI's of the
   * wrapped document.  Null if the document is stand-alone.
   *
   * Note: xeIVirtualFile covers for the wrapper in stand-alone situations.
   */
  readonly attribute xeIBaseURIMap         baseURIMap;

  /* A path added to the base URI map's distinct path, pointing
   * to where the file lives relative to the base URI.  Null if the document is
   * stand-alone.
   *
   * Note: xeIVirtualFile covers for the wrapper in stand-alone situations.
   */
  attribute ACString              pathToDocument;

  /* Nesting transaction listener applied for changes to the document.
   * The document in question may not care; this may be null.
   */
  readonly attribute nsITransactionListener txlistener;

  /* ID of the viewer the user wants to see by default. */
  readonly attribute ACString              defaultViewerID;

  /* This is a generic container for key descendant nodes
   * of the edited document.  A descendant index is an
   * array of child indexes for nodes; if k[n + 1] = 3, then
   * k[n + 1] refers to k[n]'s node.childNodes[3].
   *
   * Properties of this object include, but are not restricted to:
   * subtreeModifiedTarget
   * selectionStartContainer
   * selectionEndContainer
   *
   * Although scripts could generate these results manually, this information
   * is set by Verbosio's core application to save on calculation time.
   * Extensions should not change any of these values.
   */
  attribute nsISupports           descendantIndexes;

  /* The local id of the precondition for this wrapper interface. */
  readonly attribute ACString     preconditionLocalId;

  /* Use a <xul:precondition/> element to set properties of this. */
  void initializeByPrecondition(in nsIDOMXULElement aPrecondition);

  /**
   * Initialize the document wrapper by a file URI.
   *
   * @param aLocalPath The file URI to pass in.
   * @param aDocPack   The document pack requesting this document.
   */
  void initializeByFile(in ACString aLocalPath, in xeIDocumentPack aDocPack);

  /**
   * Save the document to a local file path.
   *
   * @param aLocalPath The path (if null, use original document path).
   */
  void save(in ACString aLocalPath);
};
