/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** 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 ETNA Relax NG validator.
 *
 * The Initial Developer of the Original Code is The Connexions Project.
 *
 * Portions created by the Initial Developer are Copyright (C) 2004-2006
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Laurent Jouanneau <laurent.jouanneau@disruptive-innovations.com>, Original author
 *
 * 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 "nsIArray.idl"
#include "domstubs.idl"

#include "diISchemaAttribute.idl"

/**
 * it is a container to store some schema properties about an element
 */
[scriptable, uuid(8B5C7C2A-2179-4312-8D39-17468F7AF579)]
interface diISchemaElement : nsISupports
{
    /**
     * the name of the element
     */
    readonly attribute AString localName;

    /**
    * the namespace
    */
    readonly attribute AString namespaceURI;

    /**
     * says if the name is undefined in the schema
     */
    //readonly attribute boolean anyName;

    readonly attribute AString label;

    readonly attribute AString description;

    readonly attribute AString semantics;

    AString getProperty(in AString aName);

    /**
     * says if the element can content a text node which is non empty and non-whitespace-only
     */
    readonly attribute boolean childTextNodeAllowed;

    /**
     * says if the element should content a text node with formated text (datatypes..)
     */
    //readonly attribute boolean formatOnChildTextNode;

    /**
     * this is the list of elements which can be the child of the element
     * array of diISchemaElement
     * XXX: no retval because of a bug in xpconnect ? (the list is always empty :-/)
     */
    void getExtendedChildList(out PRUint32 length, [array, size_is(length)] out diISchemaElement eltArray);

    /**
     * this is the list of attributes which can be added to the element
     * array of diISchemaAttribute
     * XXX: no retval because of a bug in xpconnect ? (the list is always empty :-/)
     */
    void getExtendedAttributeList(out PRUint32 length, [array, size_is(length)] out diISchemaAttribute attrArray);

    /**
     * this is the list of element which can be the parent of the element
     * array of diISchemaElement
     * XXX: no retval because of a bug in xpconnect ?(the list is always empty :-/)
     */
    void getPossibleParentElements(out PRUint32 length, [array, size_is(length)] out diISchemaElement eltArray);

    /**
     * @return an array of diISchemaBlankContentProperties objects
     */
    nsIArray getBlankElementList();

    nsIDOMElement getBlankElement( in AString aId);
};