| #ifndef DOMDocumentType_HEADER_GUARD_ |
| #define DOMDocumentType_HEADER_GUARD_ |
| |
| |
| /* |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2001-2002 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Xerces" and "Apache Software Foundation" must |
| * not be used to endorse or promote products derived from this |
| * software without prior written permission. For written |
| * permission, please contact apache\@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * nor may "Apache" appear in their name, without prior written |
| * permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation, and was |
| * originally based on software copyright (c) 2001, International |
| * Business Machines, Inc., http://www.ibm.com . For more information |
| * on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| /* |
| * $Id$ |
| */ |
| |
| #include <xercesc/util/XercesDefs.hpp> |
| #include "DOMNode.hpp" |
| |
| class DOMNamedNodeMap; |
| |
| /** |
| * Each <code>DOMDocument</code> has a <code>doctype</code> attribute whose value |
| * is either <code>null</code> or a <code>DOMDocumentType</code> object. The |
| * <code>DOMDocumentType</code> interface in the DOM Core provides an interface |
| * to the list of entities that are defined for the document, and little |
| * else because the effect of namespaces and the various XML schema efforts |
| * on DTD representation are not clearly understood as of this writing. |
| * <p>The DOM Level 2 doesn't support editing <code>DOMDocumentType</code> nodes. |
| * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113'>Document Object Model (DOM) Level 2 Core Specification</a>. |
| * |
| * @since DOM Level 1 |
| */ |
| class CDOM_EXPORT DOMDocumentType: public DOMNode { |
| protected: |
| // ----------------------------------------------------------------------- |
| // Hidden constructors |
| // ----------------------------------------------------------------------- |
| /** @name Hidden constructors */ |
| //@{ |
| DOMDocumentType() {}; |
| DOMDocumentType(const DOMDocumentType &) {}; |
| DOMDocumentType & operator = (const DOMDocumentType &) {return *this;}; |
| //@} |
| |
| public: |
| // ----------------------------------------------------------------------- |
| // All constructors are hidden, just the destructor is available |
| // ----------------------------------------------------------------------- |
| /** @name Destructor */ |
| //@{ |
| /** |
| * Destructor |
| * |
| */ |
| virtual ~DOMDocumentType() {}; |
| //@} |
| |
| // ----------------------------------------------------------------------- |
| // Virtual DOMDocumentType interface |
| // ----------------------------------------------------------------------- |
| /** @name Functions introduced in DOM Level 1 */ |
| //@{ |
| /** |
| * The name of DTD; i.e., the name immediately following the |
| * <code>DOCTYPE</code> keyword. |
| * |
| * @since DOM Level 1 |
| */ |
| virtual const XMLCh * getName() const = 0; |
| |
| /** |
| * A <code>DOMNamedNodeMap</code> containing the general entities, both |
| * external and internal, declared in the DTD. Parameter entities are |
| * not contained. Duplicates are discarded. For example in: |
| * <pre><!DOCTYPE |
| * ex SYSTEM "ex.dtd" [ <!ENTITY foo "foo"> <!ENTITY bar |
| * "bar"> <!ENTITY bar "bar2"> <!ENTITY % baz "baz"> |
| * ]> <ex/></pre> |
| * the interface provides access to <code>foo</code> |
| * and the first declaration of <code>bar</code> but not the second |
| * declaration of <code>bar</code> or <code>baz</code>. Every node in |
| * this map also implements the <code>DOMEntity</code> interface. |
| * <br>The DOM Level 2 does not support editing entities, therefore |
| * <code>entities</code> cannot be altered in any way. |
| * |
| * @since DOM Level 1 |
| */ |
| virtual DOMNamedNodeMap *getEntities() const = 0; |
| |
| |
| /** |
| * A <code>DOMNamedNodeMap</code> containing the notations declared in the |
| * DTD. Duplicates are discarded. Every node in this map also implements |
| * the <code>DOMNotation</code> interface. |
| * <br>The DOM Level 2 does not support editing notations, therefore |
| * <code>notations</code> cannot be altered in any way. |
| * |
| * @since DOM Level 1 |
| */ |
| virtual DOMNamedNodeMap *getNotations() const = 0; |
| //@} |
| |
| /** @name Functions introduced in DOM Level 2. */ |
| //@{ |
| /** |
| * Get the public identifier of the external subset. |
| * |
| * @return The public identifier of the external subset. |
| * @since DOM Level 2 |
| */ |
| virtual const XMLCh * getPublicId() const = 0; |
| |
| /** |
| * Get the system identifier of the external subset. |
| * |
| * @return The system identifier of the external subset. |
| * @since DOM Level 2 |
| */ |
| virtual const XMLCh * getSystemId() const = 0; |
| |
| /** |
| * The internal subset as a string, or <code>null</code> if there is none. |
| * This is does not contain the delimiting square brackets.The actual |
| * content returned depends on how much information is available to the |
| * implementation. This may vary depending on various parameters, |
| * including the XML processor used to build the document. |
| * |
| * @return The internal subset as a string. |
| * @since DOM Level 2 |
| */ |
| virtual const XMLCh * getInternalSubset() const = 0; |
| //@} |
| |
| }; |
| |
| #endif |
| |
| |
