1 /*

     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description: 

    15 *

    16 */

    17 #ifndef DOMEntityReference_HEADER_GUARD_

    18 #define DOMEntityReference_HEADER_GUARD_

    19 

    20 /*

    21  * Licensed to the Apache Software Foundation (ASF) under one or more

    22  * contributor license agreements.  See the NOTICE file distributed with

    23  * this work for additional information regarding copyright ownership.

    24  * The ASF licenses this file to You under the Apache License, Version 2.0

    25  * (the "License"); you may not use this file except in compliance with

    26  * the License.  You may obtain a copy of the License at

    27  * 

    28  *      http://www.apache.org/licenses/LICENSE-2.0

    29  * 

    30  * Unless required by applicable law or agreed to in writing, software

    31  * distributed under the License is distributed on an "AS IS" BASIS,

    32  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    33  * See the License for the specific language governing permissions and

    34  * limitations under the License.

    35  */

    36 

    37 /*

    38  * $Id: DOMEntityReference.hpp 568078 2007-08-21 11:43:25Z amassari $

    39  */

    40 

    41 

    42 #include <xercesc/util/XercesDefs.hpp>

    43 #include <xercesc/dom/DOMNode.hpp>

    44 

    45 XERCES_CPP_NAMESPACE_BEGIN

    46 

    47 

    48 /**

    49  * <code>DOMEntityReference</code> objects may be inserted into the structure

    50  * model when an entity reference is in the source document, or when the

    51  * user wishes to insert an entity reference. Note that character references

    52  * and references to predefined entities are considered to be expanded by

    53  * the HTML or XML processor so that characters are represented by their

    54  * Unicode equivalent rather than by an entity reference. Moreover, the XML

    55  * processor may completely expand references to entities while building the

    56  * structure model, instead of providing <code>DOMEntityReference</code>

    57  * objects. If it does provide such objects, then for a given

    58  * <code>DOMEntityReference</code> node, it may be that there is no

    59  * <code>DOMEntity</code> node representing the referenced entity. If such an

    60  * <code>DOMEntity</code> exists, then the subtree of the

    61  * <code>DOMEntityReference</code> node is in general a copy of the

    62  * <code>DOMEntity</code> node subtree. However, this may not be true when an

    63  * entity contains an unbound namespace prefix. In such a case, because the

    64  * namespace prefix resolution depends on where the entity reference is, the

    65  * descendants of the <code>DOMEntityReference</code> node may be bound to

    66  * different namespace URIs.

    67  * <p>As for <code>DOMEntity</code> nodes, <code>DOMEntityReference</code> nodes and

    68  * all their descendants are readonly.

    69  * <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>.

    70  *

    71  * @since DOM Level 1

    72  */

    73 

    74 class CDOM_EXPORT DOMEntityReference: public DOMNode {

    75 protected:

    76     // -----------------------------------------------------------------------

    77     //  Hidden constructors

    78     // -----------------------------------------------------------------------

    79     /** @name Hidden constructors */

    80     //@{    

    81     DOMEntityReference() {}

    82     DOMEntityReference(const DOMEntityReference &other) : DOMNode(other) {}

    83     //@}

    84 

    85 private:

    86     // -----------------------------------------------------------------------

    87     // Unimplemented constructors and operators

    88     // -----------------------------------------------------------------------

    89     /** @name Unimplemented operators */

    90     //@{

    91     DOMEntityReference & operator = (const DOMEntityReference &);

    92     //@}

    93 

    94 public:

    95     // -----------------------------------------------------------------------

    96     //  All constructors are hidden, just the destructor is available

    97     // -----------------------------------------------------------------------

    98     /** @name Destructor */

    99     //@{

   100     /**

   101      * Destructor

   102      *

   103      */

   104     virtual ~DOMEntityReference() {};

   105     //@}

   106 

   107 };

   108 

   109 XERCES_CPP_NAMESPACE_END

   110 

   111 #endif

   112 

   113